Put a Library photo on a product
- 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.
Added after the product's other photos (primary only when it has none), shown as a Studio photo, and the Library notes it as in use (usedIn). A photo already on the product is left alone (added: false), so a retry is safe. 422 validation_error for a Library file or a product that is gone. Any listing, hidden and draft ones included: a product with no photo at all is the one that needs it most.
Replacing one photo with another is updateProduct.
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.
productId*stringAn item id (any kind, not only physical products).
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
assetId*stringA Library file.
Created
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/products/<productId>/library-assets' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "assetId": "string"}'{ "data": { "productId": "string", "title": "string", "added": true }}Reorder settings and where a product sits PATCH
Low-stock level, reorder point and quantity, bin location and preferred supplier of one physical product, set from the inventory table. The answer is the settings as they now stand. Sending a value a product already has changes nothing, so a retry is safe. 404 `not_found` for a product that is gone. Access: OAuth scope `listings:write`; write-gated by the subscription.
Customisation groups (option groups offered with a product) GET
Groups like "Upgrades" or "Extras", set up once and attached to listings. Archived groups are included (`status`), in the merchant's order. `status=active|archived` narrows the list. Access: OAuth scope `listings:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 100, at most 200) and an opaque `cursor`.