Draft a whole listing from a photo, barcode or prompt
- Credentials
- OAuth access token
- Scopes
ai:spend- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Daily limit
- AI generations, 300 a day per store. Over the limit is
429 rate_limited. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
Spends credits. Creates nothing: the client sends the draft back through POST .../products.
Access: OAuth scope ai:spend; write-gated by the subscription.
merchantOAuth ai:spendAuthorizationBearer <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: ai:spend
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
At least one of the three.
prompt?stringlength <= 1000imageUrl?stringbarcode?stringOK
application/json- response
data*draftBody(). Rand fields (*Zar) are major units; variant money is minor units.
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/ai/product-draft' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "title": "string", "description": "string", "suggestedPriceZar": 0, "suggestedCostZar": 0, "sku": "string", "suggestedStock": 0, "tags": [ "string" ], "seoTitle": "string", "seoDescription": "string", "seoKeywords": [ "string" ], "barcode": "string", "imageUrl": "string", "compareAtZar": 0, "vendor": "string", "productType": "string", "categoryIds": [ "string" ], "lowStockThreshold": 0, "weightKg": 0, "boxId": "string", "customSizeCm": { "lengthCm": 0, "widthCm": 0, "heightCm": 0 }, "options": [ { "id": "string", "name": "string", "values": [ { "id": "string", "name": "string" } ] } ], "variants": [ { "id": "string", "title": "string", "sku": "string", "barcode": "string", "price": { "amount": 0, "currency": "ZAR" }, "compareAtPrice": { "amount": 0, "currency": "ZAR" }, "costPrice": { "amount": 0, "currency": "ZAR" }, "stock": 0, "optionValues": { "property1": "string", "property2": "string" }, "imageId": "string", "weightGrams": 0 } ], "creditsRemaining": 0 }}