Sign in

v1

latestOpenAPI 3.1.02026-07-134488210.8 KB
Inventory Levels

List Inventory Levels

List inventory levels, representing the aggregate quantity of a product at a specific location. Sorted by most recently updated first. Requires the inventory_read scope.

get/stores/{storeId}/inventory-levels

Query parameters

location_idstring

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

product_idstring

Filter by product ID (e.g. prd_...)

skustring

Filter by product SKU

updated_at_minstring date-time

Minimum updated time, inclusive

updated_at_maxstring date-time

Maximum updated time, exclusive

Headers

X-Page-Continuestring

Page marker, from X-Page-Next header

X-Page-Sizeinteger

Page size, defaults to 20

Response

Success

Example response

{
  "inventory_levels": [
    {
      "id": "li_9b2c4d6e8f",
      "product": {
        "id": "prd_1a2b3c4d5e",
        "title": "Classic Cotton T-Shirt - Black / M",
        "sku": "TSH-BLK-M"
      },
      "location": {
        "id": "loc_4d8e1a2b3c",
        "name": "East Coast Warehouse"
      },
      "quantity": 1250,
      "available": 1100,
      "committed": 100,
      "reserved": 50,
      "total_available": 1100,
      "updated_at": "2026-03-31T18:45:00.000Z"
    }
  ]
}