Archive or restore several customers at once
- Credentials
- 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.
Up to 200 ids. Each customer is re-read and set to status; the answer is one { id, ok, error? } per id (BulkResult). A customer already in that status is ok: true and untouched. One failing never stops the rest.
A retry is safe: setting a status twice changes nothing, and the same Idempotency-Key replays the first answer.
Access: OAuth scope customers:write; write-gated by the subscription.
merchantOAuth customers:writeAuthorizationBearer <token>OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.
Scope: customers:write
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
ids*array<string>The customers to act on, at most 200 (the console's cap). Repeated ids are counted once.
1 <= items <= 200status*stringactive restores, archived archives (the same as archiveCustomer, many at once).
"active""archived"OK
application/json- response
data*The answer to every bulk operation. One item failing never stops the rest, so the call is 200 even when some or all were left alone; read items.
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/customers/bulk-status' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "ids": [ "hqq5kNvq3gO6U79EGMmX" ], "status": "archived"}'{ "data": { "items": [ { "id": "hqq5kNvq3gO6U79EGMmX", "ok": true } ], "done": 1 }}Restore an archived customer POST
Puts an archived customer (`archiveCustomer`) back on the customer list as active, with their history. Restoring a customer who is already active is a no-op that answers the same way, so a retry is always safe. Access: OAuth scope `customers:write`; write-gated by the subscription.
Every tag in use on listings and customers, A to Z GET
Tags are not stored on their own: they come from the listings (outside archived kits) and customers that carry them. Access: OAuth scope `customers:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 100, at most 500) and an opaque `cursor`.