Inventory Levels

There are limits to how many product IDs, SKUs, and locations requests can be made at a time. Refer to the parameter descriptions for limits. Previously retrieved product inventory values are cached. Cached products aren't included in subsequent requests to external inventory systems, like Omnichannel Inventory. Consequently, the number of products counted towards request limits may be lower, depending on how many products have been cached when the request is made.

Resource

1/commerce/inventory/levels

Available version

60.0

HTTP methods

GET

JSON example

1{
2  "errors": [],
3  "locationGroups": [
4    {
5      "inventoryProducts": [
6        {
7          "availableToFulfill": 0,
8          "availableToOrder": 0,
9          "onHand": 0,
10          "product2Id": "01tSB000001AUkDYAW"
11        }
12      ],
13      "locationGroupId": "0ghSB0000000LvhYAE"
14    }
15  ],
16  "locations": [],
17  "success": true,
18  "totalInventory": [
19    {
20      "availableToFulfill": 0,
21      "availableToOrder": 0,
22      "onHand": 0,
23      "product2Id": "01tSB000001AUkDYAW"
24    }
25  ]
26}

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
locations	String[]	List of locations that contain inventory. A maximum of 100 product and location combinations are allowed per request.	Required if locationgroups isn't used.	60.0
locationgroups	String[]	List of location groups where the inventory is requested.	Required if locations isn't used.	60.0
products	String[]	List of products (ID or SKU). A maximum of 100 product ID and location combinations are allowed per request. A maximum of 20 SKU and location combinations are allowed per request.	Required	60.0
scope	String	Webstore ID. Example: /commerce/inventory/levels?​scope=webStoreId Eq '0ZExx000000123FGAQ'	Required	60.0

Response body for GET

OCI Inventory Levels Output