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



Inventory Adjust

This API adjusts the inventory count for a product at a location. It is different from Inventory Refresh because rather than stating the total quantity of the product, this adjustment specifies the amount of change in the form of increments and decrements (+/-). For example, there would be a -2 quantity for an item if there were two fewer than in the previous count, a +2 quantity if there were two more, and a 0 quantity if there were no change.

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 adjust an inventory with the following properties:

  • Location named “Location 1”
  • Product 000-11111-22-A adjusted to a quantity of 0

Required Parameters

Adjusting an order requires:

locationNamestringStore Name for this request. The minimum length is 1.
itemsarrayList of items to adjust.

The items array is built as an object (/[object]) with the following parameters. The quantity and any one of the other parameters except binID 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.
binIDintegerThe bin location identifier. The minimum value is “1”.
quantityintegerThe quantity of the product. The minimum value is “0”.
inventoryLocatorNamestringAn identifier to indicate where a particular SKU exists within a location. For example, “Aisle 5” would indicate that the bin this item belongs to is located in Aisle 5. The maximum length is 50.

The Full Request

This is the entire body of the request that will adjust an inventory.

 "locationName":"Location 1",

The Full Response

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

 "jobID": 76543210