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.
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 adjust an inventory with the following properties:
- Location named STORE
- Product 000-11111-22-A adjusted to a quantity of 0
Adjusting an order requires:
|locationName||string||Store Name for this request. The minimum length is 1.|
|items||array||List 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.
|partNumber||string||The product part number. The minimum length is 1.|
|upc||string||The product’s Universal Product Code. The minimum length is 1.|
|sku||string||The product’s Stock Keeping Unit code. The minimum length is 1.|
|binID||integer||The bin location identifier. The minimum value is "1".|
|quantity||integer||The quantity of the product. The minimum value is "0".|
The Full Request
This is the entire request that will adjust an inventory.
The Full Response
The response will only return a jobID in the form of an integer.