Set the shipping weight and box on several products
- 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.
The bulk "Set shipping" of the products list: one weight and/or one box for up to 200 physical products. A box that is no longer in the store's list is 422 validation_error and nothing is written. The answer is one { id, ok, error? } per product (BulkResult); an id that is not a physical product, is gone, or is in a kit the merchant has archived (kit_archived), is left alone.
A retry is safe: writing the same weight and box twice changes nothing, and the same Idempotency-Key replays the first answer.
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
At least one of weightKg and boxId is needed, else 400 bad_request. Each is written by path, so setting only the box leaves the weight alone and the other way round.
ids*array<string>The products (physical ones) to act on, at most 200 (the console's cap). Repeated ids are counted once.
1 <= items <= 200weightKg?numberOne weight in kilograms for all of them (stored as grams, rounded). Omit to leave each product's own weight alone.
0 < value <= 1000boxId?stringA box from getDelivery (settings.boxes). Its name and size are copied onto each product, as the product form does. Omit to leave each product's box alone.
OK
application/json- response
data*The answer to every bulk operation. One item failing never stops the rest, so the call is 200 even when some or all were left alone; read items.
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/products/shipping' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "ids": [ "65myAK8IFZKwZBG84Gmw", "0fdWqPRsINcCSXh5HrIA" ], "weightKg": 2}'{ "data": { "items": [ { "id": "65myAK8IFZKwZBG84Gmw", "ok": true }, { "id": "0fdWqPRsINcCSXh5HrIA", "ok": true } ], "done": 2 }}