List Inventory at Locations

GET

https://api.bigcommerce.com/stores/:store_hash/v3/inventory/items

GET

/stores/:store_hash/v3/inventory/items

curl https://api.bigcommerce.com/stores/store_hash/v3/inventory/items \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Retrieved

{
  "data": [
    {
      "identity": {
        "sku": "RE-130",
        "variant_id": 79,
        "product_id": 120,
        "sku_id": 1
      },
      "locations": [
        {
          "location_id": 1,
          "location_code": "BC-LOCATION-1",
          "location_name": "Default location",
          "available_to_sell": 10,
          "total_inventory_onhand": 11,
          "qty_backordered": 3,
          "location_enabled": true,
          "settings": {
            "safety_stock": 1,
            "is_in_stock": true,
            "warning_level": 1,
            "bin_picking_number": "1",
            "backorder_limit": 50,
            "backorder_message": {
              "id": 1,
              "name": "Standard Backorder",
              "message": "Ships in 2-3 weeks",
              "is_default": true,
              "created_at": "2024-01-15T09:30:00Z",
              "updated_at": "2024-01-15T09:30:00Z"
            }
          }
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 246,
      "count": 5,
      "per_page": 5,
      "current_page": 1,
      "total_pages": 50,
      "links": {
        "previous": "?limit=5&page=2",
        "current": "?limit=5&page=3",
        "next": "?limit=5&page=4"
      }
    }
  }
}

Return a list of inventory and inventory settings for all items in all locations.

Limits

Limit of 1000 items for payload length.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Store Inventory	read-only	`store_inventory_read_only`
Store Inventory	modify	`store_inventory`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see API Accounts and OAuth Scopes.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

sku:instringOptional

List of sku separated by comma.

variant_id:inintegerOptional

List of variant_id separated by comma.

product_id:inintegerOptional

List of product_id separated by comma.

location_id:inintegerOptional

Comma separated list of location_id.

location_code:instringOptional

Comma separated list of location_code.

pageintegerOptional

Specifies the page number in a limited (paginated) list.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list.

Response

Request has been successfully processed.

datalist of objectsOptional

metaobjectOptional