Rename a category
- Credentials
- OAuth access token
- Scopes
listings: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 listings:write; write-gated by the subscription.
merchantOAuth listings: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: listings:write
storeId*stringA store the person can reach. Any other id answers 404, never 403.
categoryId*stringIdempotency-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
name*string1 <= length <= 80OK
application/json- response
data*curl -X PATCH 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/categories/<categoryId>' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "name": "Plant care and feeding"}'{ "data": { "id": "5rA9Ku2n55T03FLF5sP1", "name": "Plant care and feeding", "slug": "plant-care-and-feeding", "parentId": null }}Put the categories in order PUT
`ids` lists categories in the order to show; any left out follow in their present order. Order is kept among siblings, so a whole level (or the lot) can be sent. Answers with every category. Access: OAuth scope `listings:write`; write-gated by the subscription.
Remove a category DELETE
Removes the category, takes every listing out of it and moves its sub-categories up to the top level, as the console does. It cannot be undone; to hide a category and keep it, archive it in the console. Access: OAuth scope `listings:write`; write-gated by the subscription.