List Inventory at Locations | BigCommerce Developer Center

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

Limits

Limit of 1000 items for payload length.

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.

### 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](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts). For more about BigCommerce OAuth scopes, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

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 objects

metaobject

1	{
2	"data": [
3	{
4	"identity": {
5	"sku": "RE-130",
6	"variant_id": 79,
7	"product_id": 120,
8	"sku_id": 1
9	},
10	"locations": [
11	{
12	"location_id": 1,
13	"location_code": "BC-LOCATION-1",
14	"location_name": "Default location",
15	"available_to_sell": 10,
16	"total_inventory_onhand": 11,
17	"location_enabled": true,
18	"settings": {
19	"safety_stock": 1,
20	"is_in_stock": true,
21	"warning_level": 1,
22	"bin_picking_number": "1"
23	}
24	}
25	]
26	}
27	],
28	"meta": {
29	"pagination": {
30	"total": 246,
31	"count": 5,
32	"per_page": 5,
33	"current_page": 1,
34	"total_pages": 50,
35	"links": {
36	"previous": "?limit=5&page=2",
37	"current": "?limit=5&page=3",
38	"next": "?limit=5&page=4"
39	}
40	}
41	}
42	}

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