ShopEazydevelopers
API referenceMerchant API BetaProducts

Move stock by a delta or set a counted total

Beta
Credentials, one of
  • Station token
  • OAuth access token
Scopes
listings:write
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
POST
/v1/merchant/stores/{storeId}/products/{productId}/stock

Access: OAuth scope listings:write; write-gated by the subscription.

Authorization

headerAuthorizationBearer <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).

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

productId*string

An item id (any kind, not only physical products).

Header Parameters

Idempotency-Key*string

Required 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.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body

Exactly one of delta or counted.

variantId?string|null
delta?integer
counted?integer
Range0 <= value
reason?string
Default"correction"
Value in"count""received""damaged""sold""correction"
note?string

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/products/<productId>/stock' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "delta": 6,  "reason": "received",  "note": "Weekly delivery from the nursery"}'
Example Response
{  "data": {    "id": "65myAK8IFZKwZBG84Gmw",    "kitId": "cbzXdyoC08TecFtCKeTn",    "title": "Monstera deliciosa, 20 cm pot",    "slug": "monstera-deliciosa-20-cm-pot",    "kind": "physical",    "price": {      "amount": 32900,      "currency": "ZAR"    },    "imageUrl": "https://images.example.com/plants/monstera.jpg",    "active": true,    "stock": 30  }}

Delete an item DELETE

Access: OAuth scope `listings:write`; write-gated by the subscription.

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.