Checking inventory levels
Learn how to retrieve the available quantity and time of inventory items.
Last updated
Learn how to retrieve the available quantity and time of inventory items.
Last updated
In , you can call the to access product availability information at individual warehouses. After you , each contained in the response is associated with one and one location.
You can to and provide product availability information to customers.
When you submit a request, you must provide an array of as a query parameter.
You can filter the results by when inventory levels were last updated, whether the product is available, and which warehouse locations can ship the product to a specific country.
If you don't apply any filters, each inventory item identifier you specify in the request returns one or more . However, the application of search filters, such as available
or shipToCountry
, may result in your query returning no results. For example, when you use the shipToCountry
filter (which must be formatted as an ), you'll only get inventory-level information if the product can be shipped to that country.
After you successfully submit a request, a 200 OK
response contains a data
array. Each element of this array represents an inventory level.
You get one when a product is located at a single warehouse. However, when a product is warehoused at multiple locations, we provide the inventory level at each location.
An inventory level provides the item's , , and .
The locationId
represents the identifier of the fulfiller's warehouse, which contains the inventory item.
If the product is available
, then the availableQuantity
of the inventory level is greater than zero. In these cases, availableTime
is null and not returned.
If available
is false
, then availableTime
provides an estimated time for the product to restock (assuming the fulfiller has provided this information). When the fulfiller doesn’t provide an estimated restocking time, then availableTime
is null and not returned.
In this case, Digital River determines that a machine that can be shipped to Sweden is only available at one location, so the response returns just a single inventory-level object.
You can use an to provide product availability information to customers. During the , it can help you determine when to display or conceal a product on your storefront, notify customers when an item is almost out of stock or when it will be available again, display the remaining number of products in stock, and determine if an item is available for shipping to a specific country.
For example, let's say you want to determine the availability of a coffee maker and whether it can be shipped to Sweden. To do this, submit a GET/inventory-levels
that specifies the , the shipToCountry
as SE
, and sets available
to true
.
Your integration can also use an inventory level to determine whether to or .