Inventory Check Availability

Get information about inventory availability for products in locations or location groups in your commerce inventory system. Provides available to fulfill, available to order, and on hand quantity information.

Resource

1/commerce/inventory/check-availability

Available version

60.0

HTTP methods

POST

Request body for POST

OCI Inventory Check Availability Input

Root XML tag

<InventoryCheckAvailabilityInput>

JSON example - Locations

1{
2  "locations": [
3    {
4      "locationId": "131xx0000004FwPAAU",
5      "includeInventoryLevel": false,
6      "products": [
7        {
8          "product2Id": "01txx0000006i65AAA",
9          "quantity": 10
10        },
11        {
12          "product2Id": "01txx0000006i66AAA",
13          "quantity": 11
14        }
15      ]
16    },
17    {
18      "locationId": "131xx1234567FwSAAU",
19      "includeInventoryLevel": false,
20      "products": [
21        {
22          "product2Id": "01txx0000006i67AAA",
23          "quantity": 100
24        },
25        {
26          "product2Id": "01txx0000006i68AAA",
27          "quantity": 400
28        }
29      ]
30    }
31  ],
32  "inventoryDimension": "AvailableToOrder"
33}

JSON example - Location Groups

1{
2  "locationGroups": [
3    {
4      "locationGroupId": "0ghxx000000001eAAA",
5      "includeInventoryLevel": false,
6      "products": [
7        {
8          "product2Id": "01txx0000006i65AAA",
9          "quantity": 10
10        },
11        {
12          "product2Id": "01txx0000006i66AAA",
13          "quantity": 11
14        }
15      ]
16    },
17    {
18      "locationGroupId": "0ghxx000000001dAAA",
19      "includeInventoryLevel": false,
20      "products": [
21        {
22          "product2Id": "01txx0000006i67AAA",
23          "quantity": 100
24        },
25        {
26          "product2Id": "01txx0000006i68AAA",
27          "quantity": 400
28        }
29      ]
30    }
31  ],
32  "inventoryDimension": "AvailableToOrder"
33}

Properties

Name	Type	Description	Required or Optional	Available Version
`inventoryDimension`	String	Fulfillment option you want to check. On Hand: Inventory available, not counting Future Inventory or Quantity Reserved. Available to Fulfill (ATF): Inventory that can be fulfilled now. Available to Order (ATO): Inventory that can be ordered. Default option if no dimension is selected.	Optional	60.0
`locationGroups`	OCI Location Group Check Availability Input[]	A list of inventory availability data for location groups.	Required if `locations` isn’t requested.	60.0
`locations`	OCI Location Check Availability Input[]	A list of inventory availability data for individual locations.	Required if `locationsGroups` isn’t requested.	60.0

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`scope`	String	Expression specifying the webstore ID. Example:`/commerce/inventory/check-availability?scope=webStoreId%20Eq%20%270ZExx000000123FGAQ%27`	Required	60.0

Response body for POST: OCI Inventory Check Availability Output

Connect REST API Developer Guide

Inventory Check Availability