API reference
A valid request URL is required to generate request examples[
{
"available": 123,
"floor": 123,
"messages": [
"<string>"
],
"numResults": 123,
"onHand": 123,
"partNumber": "<string>",
"sku": "<string>",
"success": true,
"tags": {},
"tenantID": 123,
"upc": "<string>"
}
]Aggregate
Aggregates inventory.
A valid request URL is required to generate request examples[
{
"available": 123,
"floor": 123,
"messages": [
"<string>"
],
"numResults": 123,
"onHand": 123,
"partNumber": "<string>",
"sku": "<string>",
"success": true,
"tags": {},
"tenantID": 123,
"upc": "<string>"
}
]Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
Site ID
Body
Request to aggregate inventory
Request for aggregating inventory
Whether to limit results to locations that are shipping enabled
Whether to force populate default tags onto the request if they are unspecified for any tag category
Future end Date at which the inventory should be allocated against.
Future start Date at which the inventory should be allocated against.
Whether to ignore the safety stock buffer put in place
Enum for including future inventory: [futureOnly, futureAndCurrent]
futureOnly, futureAndCurrent Whether to allow items with negative future inventory in the results
Whether to allow items with negative inventory in the results
List of Items to search on
Show child attributes
Show child attributes
Location Code
which page to show
how many results to show per page
Filter results by pickup enabled (true) or not (false)
index to sort results by
Associative Map of <String, String> for tagCategoryName => tagName
Show child attributes
Show child attributes
Filter results by locations that have transfer enabled (true) or don't (false)
user id
Response
Success
The quantity the location has that are available for purchase
Absolute minimum quantity of this item that should be in stock at any time
List of messages
Number of results
The quantity the location has in its possession
Part/Product Number
Stock Keeping Unit
Flag for success
Associative Map of <String, String> for tagCategoryName => tagName
Show child attributes
Show child attributes
Manufacturer Identifier
Universal Product Code