Record a stock count
- Credentials, one of
- Station token
- 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.
What was counted for listings (listingId and variantId) or materials. Differences are worked out against what the books say and booked. With dryRun: true nothing is booked and the answer lists what would change, so a caller can ask the merchant first.
Access: OAuth scope listings:write; write-gated by the subscription.
AuthorizationBearer <token>It may call only the operations whose x-stations lists its kind, on its own store, and acts through the access of the owner or admin who paired it. Unpairing it, or that person leaving the business, ends it (401 station_revoked).
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
lines*array<>1 <= items <= 200note?stringlength <= 300dryRun?booleanWork out the differences without booking them.
OK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/stock-counts' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "lines": [ { "counted": 1 } ]}'{ "data": { "changed": 0, "booked": true, "differences": [ { "name": "string", "was": 0, "now": 0 } ], "failed": [ "string" ] }}Set or change a material's stock POST
Send `set` (a counted total) or `add` (a change; negative removes), never both. The move is written to the stock ledger with its reason; stock cannot go below zero. Access: OAuth scope `listings:write`; write-gated by the subscription.
Record a batch made POST
Adds the finished product to stock and takes its recipe's materials off, in one transaction. Scale. 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.