List or search customers
- Credentials, one of
- Station token
- OAuth access token
- Scopes
customers:read
Access: OAuth scope customers:read; not write-gated.
Paged: { items, nextCursor }, limit (default 50, at most 200) and an opaque cursor.
AuthorizationBearer <token>It may call only the operations whose x-stations lists its kind, on its own store, and acts through the access of the owner or admin who paired it. Unpairing it, or that person leaving the business, ends it (401 station_revoked).
storeId*stringA store the person can reach. Any other id answers 404, never 403.
search?stringA search is not paginated.
cursor?stringThe nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.
limit?integerPage size: default 50, at most 200 (more is 200; a missing or unusable value is 50).
1 <= value <= 20050OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/customers' \ -H 'Authorization: Bearer <access_token>'{ "data": { "items": [ { "id": "hqq5kNvq3gO6U79EGMmX", "name": "Lerato Dlamini", "email": "lerato.dlamini@example.com", "phone": null, "orderCount": 0, "totalSpent": { "amount": 0, "currency": "ZAR" }, "lastOrderAt": null }, { "id": "dX3fN9Vqb9YKrX8GsA1H", "name": "Thandi Mokoena", "email": "thandi.mokoena@example.com", "phone": "+27 82 000 0000", "orderCount": 0, "totalSpent": { "amount": 0, "currency": "ZAR" }, "lastOrderAt": null } ], "nextCursor": null }}Improve a photo or draw a new image POST
Spends credits. Plan: `adset` and `week` are Marketing Plus tools (included with Growth and Scale), like "Advert copy" and "Plan my week" in the console's Marketing tools: without it they are refused with 403 `plan_limit` before anything is charged. Every other make is open to every plan. Storage: refused with 403 `plan_limit` when it would take the Library over the plan's storage. What is already stored stays. Access: OAuth scope `ai:spend`; write-gated by the subscription.
Add a customer POST
Access: OAuth scope `customers:write`; write-gated by the subscription.