API reference Stock Stock counts

Stock counts

GET methodhttps://api.anyshop.io/v1/products/{id}/stock

How many keys the product has in each state, in the mode of your API key.

Scope stock:read

Path parameters

idstring required

Example

as_live_ or as_test_

curl \
  https://api.anyshop.io/v1/products/prod_01m3rr5kmbeb2s18x1kpntjxqb/stock \
  -H "Authorization: Bearer $ANYSHOP_API_KEY"

{
  "object": "stock_summary",
  "product": "prod_01m3rr5kmbeb2s18x1kpntjxqb",
  "livemode": false,
  "available": 118,
  "reserved": 2,
  "sold": 41,
  "revoked": 1,
  "total": 162,
  "low_stock_threshold": 20
}

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

Returns

The stock_summary object.

Errors

Status and error.type

400invalid_requestThe request is not valid; error.param names the field
401authenticationNo API key, or it is not valid
403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
404not_foundNot found in the key's store and mode
409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
429rate_limitedToo many requests; see Retry-After