Inventory Levels

Get information about inventory levels for products in locations and location groups in your commerce inventory system.

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 where the inventory is requested.	Required if `locationgroups`is not used.	60.0
`locationgroups`	String[]	List of location groups where the inventory is requested.	Required if `locations` is not used.	60.0
`products`	String[]	List of products (ID or SKU).	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

Connect REST API Developer Guide

Inventory Levels