API reference Stock List stock keys

List stock keys

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

The product's keys in your API key's mode, newest first, each masked. The full key only comes from a reveal.

Scope stock:read

Path parameters

idstring required

Query parameters

limitinteger How many to return: 1 to 100, default 201 to 100
starting_afterstring The last ID of the previous page; the next page starts after itUp to 64 characters
stateenum Only keys in this stateavailablereservedsoldrevoked

Example

as_live_ or as_test_

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

{
  "object": "list",
  "data": [
    {
      "object": "stock_item",
      "id": "stk_01m3rr7t2q9w4e6r8t0y2u4i6o",
      "product": "prod_01m3rr5kmbeb2s18x1kpntjxqb",
      "livemode": false,
      "state": "available",
      "key_masked": "7XPD-••••-••••-NA5R",
      "created_at": "2026-10-02T14:21:07.000Z",
      "sold_at": "2026-10-02T14:21:07.000Z",
      "revoked_at": "2026-10-02T14:21:07.000Z"
    }
  ],
  "has_more": false
}

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

A list of stock_item objects, newest first: { "object": "list", "data", "has_more" }.

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