ShopEazydevelopers
API referenceMerchant API BetaProducts

Add categories by name (find-or-create)

Beta
Credentials
  • OAuth access token
Scopes
listings:write
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
POST
/v1/merchant/stores/{storeId}/categories

A name that already exists, in any case, is reused rather than duplicated.

Access: OAuth scope listings:write; write-gated by the subscription.

Authorization

merchantOAuth listings:write
headerAuthorizationBearer <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

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Header Parameters

Idempotency-Key*string

Required 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.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body
names*array<>
Items1 <= items <= 20

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/categories' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "names": [    "Indoor plants",    "Pots and planters",    "Plant care"  ]}'
Example Response
{  "data": {    "ids": [      "s9EOwLS0KUlAWoAEdqRT",      "znXqqfQrncRC855gzGfH",      "5rA9Ku2n55T03FLF5sP1"    ],    "categories": [      {        "id": "s9EOwLS0KUlAWoAEdqRT",        "name": "Indoor plants",        "slug": "indoor-plants",        "parentId": null      },      {        "id": "znXqqfQrncRC855gzGfH",        "name": "Pots and planters",        "slug": "pots-and-planters",        "parentId": null      },      {        "id": "5rA9Ku2n55T03FLF5sP1",        "name": "Plant care",        "slug": "plant-care",        "parentId": null      }    ]  }}

The listing categories shoppers browse by GET

Access: OAuth scope `listings:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 100, at most 200) and an opaque `cursor`.

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.