Sign in

v1

latestOpenAPI 3.1.02026-07-134488210.8 KB
Inventory Items

List Inventory Items

List in-stock inventory items. Only items with on-hand quantity greater than zero are returned. Sorted by most recently updated first. Requires the inventory_read scope.

get/stores/{storeId}/inventory-items

Query parameters

location_idstring

Filter by location ID (e.g. loc_...)

kind'PRODUCT' | 'RETURN' | 'UNDECLARED' | 'UNKNOWN'

Filter by inventory item kind

Headers

X-Page-Continuestring

Page marker, from X-Page-Next header

X-Page-Sizeinteger

Page size, defaults to 20

Response

Success

Example response

{
  "inventory_items": [
    {
      "id": "ii_5f8e1a2b3c",
      "sku": "TSH-BLK-M",
      "name": "Classic Cotton T-Shirt - Black / M",
      "kind": "PRODUCT",
      "quantity": 250,
      "locations": [
        {
          "location_id": "loc_4d8e1a2b3c",
          "location_name": "East Coast Warehouse",
          "quantity": 120
        }
      ],
      "created_at": "2025-11-01T10:00:00.000Z",
      "updated_at": "2026-03-31T18:45:00.000Z"
    }
  ]
}