Inventory Refresh

This API sets the inventory count for a product at a particular location.

Supported FormatsJSON

The .json address above can be used to access the schema within Postman. An example use of the Inventory API follows below, or view the sample Postman Collection.


The example case will refresh an inventory with the following properties:

  • Location 11 of Manufacturer 00000
  • Item 101010 refreshed with a quantity of 101

Required Parameters

Refreshing an order requires:

locationNamestringName of the location to refresh items at. The minimum length is 1.

Optional Parameters

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

itemsarrayList of items to refresh. The maximum length is 1000.

The items array is built as an object (/[object]) with the following parameters. The quantity and either partNumber, UPC, or SKU 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.
binIDintegerBin Location Identifier. The minimum value is "1".
quantityintegerThe quantity of the product. The minimum value is "0".
ltdnumberCustom field used for store prioritization.
floorintegerAbsolute minimum quantity of this item that should be in stock at any time.
safetyStockintegerQuantity of this item the location wants to keep in stock to ensure stock isn’t completely depleted.
currencyIDintegerThe currency identifier for the retailPrice.
retailPricenumberThe price of the item.

Inventory Attributes

Some OMS configurations make use of inventory attributes, such as those that use inventory replenishment relationships. In this case, the Refresh Inventory API has been extended to take in attributes at the item level.  If the attributes indicated in the request do not exist in the current inventory map for the item, then they are added. If they do exist, then they are updated.

An item can have a maximum of 63 attributes. They must be provided in an array of strings, as per the example below.

"attributes": ["TEST1", "TEST2", "TEST3", "TEST6", "TEST7"]

The Full Request

This is the entire request that will refresh an inventory (without attributes).

 "manufacturerID": 00000,
 "locationName": "1",
 "items": [
  "partNumber": "101010",
  "sku": "101010",
  "quantity": "101"

The Full Response

The response will only return a jobID in the form of an integer.

 "jobID": 01234567

ProductOMS Dev: Inventory Refresh