Create an item in a kit
- 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.
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
parseNewItem(). Status defaults to draft. The kit decides the kind.
kitId*stringtitle*stringlength <= 140price*A price as the server parses it: amount is a whole, non-negative number of minor units (a numeric string is coerced). currency defaults to ZAR.
description?stringlength <= 8000compareAtPrice?A price as the server parses it: amount is a whole, non-negative number of minor units (a numeric string is coerced). currency defaults to ZAR.
costPrice?A price as the server parses it: amount is a whole, non-negative number of minor units (a numeric string is coerced). currency defaults to ZAR.
status?ItemStatus"draft""active""archived"tags?array<string>productType?stringlength <= 80vendor?stringlength <= 80categoryIds?array<string>This store's live category ids only; others are dropped silently.
items <= 20media?array<>seo?details?Same field names as the matching *Details read schema; sold on tiers is ignored and kept from the stored item.
shipping?Physical items only. An unknown box keeps just the weight.
Created
application/json- response
data*details is shaped by kind.
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/products' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "kitId": "cbzXdyoC08TecFtCKeTn", "title": "Monstera deliciosa, 20 cm pot", "description": "A healthy, glossy monstera in a 20 cm nursery pot. Bright, indirect light and a drink every week or so.", "price": { "amount": 34900, "currency": "ZAR" }, "compareAtPrice": { "amount": 39900, "currency": "ZAR" }, "status": "active", "tags": [ "indoor", "low light" ], "categoryIds": [ "s9EOwLS0KUlAWoAEdqRT" ], "media": [ { "url": "https://images.example.com/plants/monstera.jpg", "alt": "A monstera in a terracotta pot" } ], "details": { "sku": "MON-20", "trackInventory": true, "stock": 24, "lowStockThreshold": 5, "requiresShipping": true, "barcode": "6001000000017" }, "shipping": { "weightKg": 2.5 }}'{ "data": { "id": "65myAK8IFZKwZBG84Gmw", "kitId": "cbzXdyoC08TecFtCKeTn", "kind": "physical", "title": "Monstera deliciosa, 20 cm pot", "slug": "monstera-deliciosa-20-cm-pot", "description": "A healthy, glossy monstera in a 20 cm nursery pot. Bright, indirect light and a drink every week or so.", "price": { "amount": 34900, "currency": "ZAR" }, "compareAtPrice": { "amount": 39900, "currency": "ZAR" }, "status": "active", "tags": [ "indoor", "low light" ], "categoryIds": [ "s9EOwLS0KUlAWoAEdqRT" ], "media": [ { "id": "m0-mvnovvgd", "url": "https://images.example.com/plants/monstera.jpg", "alt": "A monstera in a terracotta pot" } ], "details": { "sku": "MON-20", "barcode": "6001000000017", "trackInventory": true, "stock": 24, "lowStockThreshold": 5, "requiresShipping": true, "options": [], "variants": [] }, "customisations": [], "managedInConsole": [], "updatedAt": 1792924382462 }}List or search the catalogue GET
Access: OAuth scope `listings:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 100, at most 200) and an opaque `cursor`.
Look an item up by barcode GET
No match is `{ data: null }` with 200, not a 404. Access: OAuth scope `listings:read`; not write-gated.