API reference
A valid request URL is required to generate request examples[
{
"allocated": 123,
"attributes": [
"<string>"
],
"available": 123,
"blockAssignment": true,
"countryCode": "<string>",
"directShip": true,
"distance": 123,
"externalID": "<string>",
"floor": 123,
"futureInventory": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123,
"type": "<string>"
}
],
"inventoryLocatorName": "<string>",
"locationCode": "<string>",
"locationName": "<string>",
"ltd": 123,
"messages": [
"<string>"
],
"numResults": 123,
"onHand": 123,
"partNumber": "<string>",
"pending": 123,
"pickup": true,
"safetyStock": 123,
"sku": "<string>",
"success": true,
"taggedInventory": [
{
"allocated": 123,
"available": 123,
"futureInventory": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123,
"type": "<string>"
}
],
"onHand": 123,
"pending": 123,
"tags": {}
}
],
"tenantID": 123,
"transferEnabled": true,
"upc": "<string>"
}
]Get Inventory (POST)
Queries for specified inventory at given location. To call the version of this API with RIS (real-time inventory service) data, use the /commerce/realtime-inventory/v5/inventory endpoint instead.
A valid request URL is required to generate request examples[
{
"allocated": 123,
"attributes": [
"<string>"
],
"available": 123,
"blockAssignment": true,
"countryCode": "<string>",
"directShip": true,
"distance": 123,
"externalID": "<string>",
"floor": 123,
"futureInventory": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123,
"type": "<string>"
}
],
"inventoryLocatorName": "<string>",
"locationCode": "<string>",
"locationName": "<string>",
"ltd": 123,
"messages": [
"<string>"
],
"numResults": 123,
"onHand": 123,
"partNumber": "<string>",
"pending": 123,
"pickup": true,
"safetyStock": 123,
"sku": "<string>",
"success": true,
"taggedInventory": [
{
"allocated": 123,
"available": 123,
"futureInventory": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123,
"type": "<string>"
}
],
"onHand": 123,
"pending": 123,
"tags": {}
}
],
"tenantID": 123,
"transferEnabled": true,
"upc": "<string>"
}
]Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
Site ID
Body
Request to get inventory
Request for getting Inventory
DateTime to filter for only future inventory with a delivery date after or equal to the given date
DateTime to filter for only future inventory with a delivery date before or equal to the given date
Whether to limit results to locations that are shipping enabled
Filter out results that are blocked from assignment (at the product/location level)
Whether to force populate default tags onto the request if they are unspecified for any tag category
Whether to ignore the safety stock buffer put in place
Flag to include attributes or not
If set to true, include future inventory in response (records that were set with a deliveryDate).
Filter results by locations that have aggregate export enabled (true) or don't (false)
Filter results by locations that have physical storefronts (true) or don't (false)
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
The maximum number of results to return, defaults to 100 for most
List of location codes that are NOT allowed to be included in results
Location Code
List of location codes that should be returned before all others, preventing them from being excluded by limit
List of location codes that are allowed to be included in results
which page to show
how many results to show per page
Filter results by locations that have finderbot enabled (true) or don't (false)
Request Location
Show child attributes
Show child attributes
index to sort results by
What to sort the inventory results by. Only used for GetInventoryByLocation calls (locationCode must be set)
ON_HAND, AVAILABLE, ALLOCATED, PART_NUMBER, PRODUCT_ID Whether to sort by descending order or not. Must be used in conjunction with the sortByEnum value
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)
Inventory Request Type Enum
ALL, PARTIAL, ANY, ALL_STORES user id
Response
Success
The quantity the location has that are already allocated.
List of Inventory Attributes
The quantity the location has that are available for purchase
Whether or not the product is blocked for assignment
The country code of this location
Whether this location can ship to a consumer
The distance in miles from this location to the item's destination
External ID of the item
Absolute minimum quantity of this item that should be in stock at any time
Show child attributes
Show child attributes
The inventory locator name of the individual item
Location Code
Location Name
Custom field used for store prioritization
List of messages
Number of results
The quantity the location has in its possession
Part/Product Number
The quantity the location has that are pending.
Whether a consumer can pick up product at this location (store)
Quantity of this item the location wants to keep in stock to ensure stock isn't completely depleted
Stock Keeping Unit
Flag for success
Show child attributes
Show child attributes
Tenant Identifier
Whether the location can ship to another location (store), thus restocking that location.
Universal Product Code