These guides provide examples for many tasks that a developer will need to be familiar with during implementation.



Inventory Inquiry (Aggregate)

This API allows the user to request the aggregate inventory information of an item or items that belong to a particular manufacturer. This does not separate inventory by location, instead providing the total inventory count across all locations.

Note that unlike other OMS APIs, there are two endpoints that may be used. Each endpoint is associated with a different API key related to a package – either an “Inventory V5” or “Inventory Specific” package. The Inventory Specific package is the preferred endpoint to use, but some implementations may use Inventory V5 depending on their configuration.

Call – Inventory V5
Call – Inventory Specific
Supported FormatsJSON

An example use of the Inventory API follows below, or view the sample Postman Collection.


The example case will inquire about an inventory with the following properties:

  • Inventory of item 212121
  • At any location of manufacturer 00000

Required Parameters

These parameters are necessary for the Inventory API to return a successful response:

manufacturerIDintegerA unique identifier for a manufacturer. The minimum value is “100”.
itemsarrayList of items to search on. The minimum length is 1.

The items array is built as an object (/[object]) with the following parameters. The quantity and any one of the other parameters are required.

partNumberstringThe product part number. The minimum length is 1.
upcstringThe product’s Universal Product Code. The minimum length is 1.
skustringThe product’s Stock Keeping Unit code. The minimum length is 1.
quantityintegerThe quantity of the product. The minimum value is “0”.

Optional Parameters

Other possible parameters can be provided to specify other details about the product. These variables are:

fulfillerIDintegerA unique identifier for a fulfiller. The minimum value is “0”.
catalogIDintegerA unique identifier for the catalog. The minimum value is “0”.
ignoreSafetyStockbooleanWhether to ignore the safety stock buffer put in place. The default is “false”.
includeNegativeInventorybooleanWhether to allow items with negative inventory in the results. The default is “false”.
shippingLocationbooleanWhether to limit results to locations that are shipping enabled.
taxableLocationbooleanFilter results by locations that apply tax (true) or don’t (false).
restockEnabledbooleanFilter results by locations that are restock-enabled (true) or not (false).
pickupEnabledbooleanFilter results by locations that are pickup-enabled (true) or not (false).
finderbotEnabledbooleanFilter results by locations that have finderbot enabled (true) or don’t (false).
hasStorefrontbooleanFilter results by locations that have physical storefronts (true) or don’t (false).

The Full Request

This is the entire request that will inquire about an inventory.

 "manufacturerID": "00000",
 "items": [
  "sku": "testsku120",
  "quantity": 1

The Full Response

The response is aggregate total without location information.

 "manufacturerID": 00000,
 "onHand": 101,
 "available": 94,
 "partNumber": "testsku120",
 "sku": "testsku120"