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