Customers

Customers (members), with their loyalty points.

📄️ List customers

Live customers of the merchant, ordered by name. `search` matches part of the name, phone or card number. The list has no balances, member tier or origin outlet; read one customer for those. Pages are offset-based: customers added or removed while you page can shift rows between pages.

📄️ Create a customer

Creates a customer as the acting user. Points and member tier are not part of the body: a field that is not listed below, such as `points_balance`, is ignored. Set points with `PUT /customers/{id}/points`. Errors: `403 CUSTOMER_SEAT_LIMIT` when the plan's customer cap is reached, `409 DUPLICATE_PHONE` or `409 DUPLICATE_CARD_NUMBER` when another live customer uses the value.

📄️ Get a customer

One live customer with points balance and member tier. `store_credit` is present only when the merchant's plan includes member balance. An id of another merchant answers `404 NOT_FOUND`.

📄️ Update a customer

Partial update as the acting user: a field that is absent keeps its value; `null` clears it.

📄️ Set a customer's points balance

Sets the customer's loyalty points balance to `points_balance`, recorded as an adjustment by the acting user. The user's role needs both customer edit and loyalty manage permissions.