Search Inventory
Legacy Documentation
You are viewing legacy documentation. These APIs are maintained for partners with existing implementations. New projects should use v2.
View the current GraphQL API Reference → | View the current REST API Reference →
POST/inventory/search
This endpoint allows searching for product inventory cumulative quantities, separated by inventory type.
Available search fields
| Name | Description | Required |
|---|---|---|
productIds (array [integer]) | Array of product ids. | yes |
warehouseId (integer) | Warehouse id. | no |
location (string) | Location. | no |
Mandatory field in search payload is productIds array. If warehouseId or location are not sent in the payload, inventories will not be filtered by warehouse and/or location.
Request
Responses
- 200
- 400
Search Inventory - 200 / Search Inventory - 200 (expands inventoryBalance)
Response Headers
Connection
Content-Length
Date
Keep-Alive
Return-Format
Search Inventory - 400 (empty productIds array)
Response Headers
Connection
Content-Length
Date
Return-Format