Mark a supplier order sent or cancelled
- 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.
Setting the state it is already in changes nothing.
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.
purchaseOrderId*stringA supplier order id, from GET /purchase-orders.
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
status*string"sent""cancelled"OK
application/json- response
data*curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/purchase-orders/<purchaseOrderId>/status' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "status": "sent"}'{ "data": { "id": "string", "number": "string", "supplierId": "string", "supplierName": "string", "status": "draft", "lines": [ { "id": "string", "materialId": "string", "itemId": "string", "variantId": "string", "name": "string", "quantity": 0, "received": 0, "unit": "each", "unitCost": null } ], "total": { "amount": 0, "currency": "ZAR" }, "expectedAt": 0, "sentAt": 0, "receivedAt": 0, "note": "string" }}Draft an order to a supplier POST
For materials (`materialId`) or stock the shop buys in (`listingId`). Scale. It starts as a draft: mark it sent with the status operation. Plan: Scale (403 `plan_limit` on a plan without it). Reading and changing what already exists stays open after a downgrade. Access: OAuth scope `listings:write`; write-gated by the subscription.
Book a delivery in POST
What arrived from the supplier goes into stock, each line through the stock ledger with the reason `receipt`. `received` maps line id to the quantity that arrived; leave it out for everything still due. A delivery can arrive short (the order stays open as part received) but never books more than was ordered. Access: OAuth scope `listings:write`; write-gated by the subscription.