ShopEazydevelopers
API referenceMerchant API BetaSettings

Start or stop selling a kind of listing

Beta
Credentials
  • OAuth access token
Scopes
settings:write
Role
Owners and admins only. Staff get 403 forbidden.
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.
PUT
/v1/merchant/stores/{storeId}/kits

Stopping archives the kind: its listings and orders are kept, and starting again brings them back. At least one kind stays on (422 validation_error).

Access: OAuth scope settings:write; owner/admin only; write-gated by the subscription.

Authorization

merchantOAuth settings: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: settings: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
sell?array<>
Itemsitems <= 4
stopSelling?array<>
Itemsitems <= 4

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/kits' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "sell": [    "physical",    "service"  ]}'
Example Response
{  "data": {    "sells": [      {        "kind": "physical",        "label": "Physical products"      },      {        "kind": "service",        "label": "Services"      },      {        "kind": "ticketing",        "label": "Events"      }    ]  }}

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.

Set the shop's Google Business link PUT

The Google Business Profile link shown on the shop. An empty `url` removes it. Access: OAuth scope `settings:write`; owner/admin only; write-gated by the subscription.