FAQ / Edge Cases
Is this a different API from the Delivery API? It is the same GraphQL endpoint, schema and token. The CRM & Loyalty pages cover the customer and loyalty part.
How do I find a customer by phone number? Use customers.customer(phone: ...). See Customer Identification.
The search returned more than one customer. What now? Check totalCount. Add the first name, the last name or the code to narrow the result.
Where is the points balance? In loyalty.points.balance of the customer. See Customer Details.
Are points whole numbers? No. Points and amounts are decimal numbers, for example 5.61.
How do I see the points of a receipt? Read receipts.loyalty.points.credit (earned) and debit (used) with order.orders. See Points Balance & Transactions.
Why is my orders request rejected? orders needs order keys or a period of at most 1 year.
How do I get the full history of a customer? Query one period of at most 1 year at a time and page through each one.
Why is segmentationCategory null? The customer has no segmentation assigned.
Can a voucher have no end date? No. beginDate and endDate are always set. maximumUsageCount null or 0 means unlimited uses.
Can I read or redeem a gift card with this API? No. You can create a gift card. It is used at the POS when the customer buys something.
How do I update only one field of a customer? Send the publicKey and that field. All the other fields are optional.
I deleted a customer. Is it gone? The delete is soft. The customer becomes inactive and doesn't appear in the default lists.
Can I get notified when points change? Not in this API. Query the data when you need it. The Delivery API has webhooks, for its own events.
How do I get a token? See Authentication. The same token works for the Delivery API.