Check Inventory
Discover how to retrieve stock details for products at specific locations with the 'Check Inventory' subcategory.
Get the stock details of the product on the specific locations. To get the stock details, you will need to call the /checkInventory
endpoint with the POST method.
Request
End Point
https://<host>/api/checkInventory
Example: https://demo-oms.hotwax.io/api/checkInventory
Header
Content-Type: application/json
Body
In case of checking a product's inventory at multiple facility.
In case of checking multiple product's inventory at single facility.
Sample
Parameter Name | Description | Required (Y/N) |
---|---|---|
| The SKU of the product | N |
| The operator to be used for the sku field | N |
| HotWax Commerce internal product Id | N |
| The HotWax Commerce facility Id where product inventory is located | N |
| The operator to be used for the facility Id | N |
| The operator to be used for the sku field | N |
Note: It is required to pass either |
Response
Status Code
HTTP/1.1 200 OK
Headers
Content-Type: application/json
Body
Parameter Name | Description |
---|---|
| Results count |
| The array of results found |
| The Id of the facility in HotWax |
| The available to promise inventory of the product |
Last updated