Add a customer
- Credentials, one of
- Station token
- OAuth access token
- Scopes
customers:write- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
Access: OAuth scope customers:write; write-gated by the subscription.
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.
Idempotency-Key*stringRequired on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.
^[A-Za-z0-9_-]{8,128}$application/json- body
On create name is required. On PATCH only the keys present change; a key sent as null or empty clears it. orderCount and totalSpent are never writable.
name?stringlength <= 120email?|length <= 254phone?|length <= 40address?|The platform Address. Old app versions may still send line1 / line2 / suburb; the server maps them, and addressLine / localArea win when both are sent.
notes?|length <= 2000tags?array<>items <= 20marketingOptIn?booleanCreated
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/customers' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "name": "Thandi Mokoena", "email": "thandi.mokoena@example.com", "phone": "+27 82 000 0000", "address": { "addressLine": "5 Example Avenue", "localArea": "Parkhurst", "city": "Johannesburg", "province": "Gauteng", "postalCode": "2193", "country": "ZA" }, "notes": "Likes low-light plants. Prefers WhatsApp.", "tags": [ "plant club" ], "marketingOptIn": false}'{ "data": { "id": "dX3fN9Vqb9YKrX8GsA1H", "name": "Thandi Mokoena", "email": "thandi.mokoena@example.com", "phone": "+27 82 000 0000", "orderCount": 0, "totalSpent": { "amount": 0, "currency": "ZAR" }, "lastOrderAt": null, "address": { "addressLine": "5 Example Avenue", "localArea": "Parkhurst", "city": "Johannesburg", "province": "Gauteng", "postalCode": "2193", "country": "ZA", "line1": "5 Example Avenue", "suburb": "Parkhurst" }, "notes": "Likes low-light plants. Prefers WhatsApp.", "tags": [ "plant club" ], "marketingOptIn": false, "status": "active", "hasAccount": false, "createdAt": 1792924390822 }}