KIBO OMS DOCUMENTATION

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.

Version2.0
Callhttps://integration.shopatron.com/api/v5/inventory/adjust
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v5/inventory/adjust.json

The .json address above can be used to access the schema within Postman. An example use of the Inventory API follows here — or go directly to the sample Postman Collection.

Example

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

Required Parameters

Adjusting an order requires:

ParameterTypeDescription
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.

ParameterTypeDescription
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".

The Full Request

This is the entire request that will adjust an inventory.

{
 "locationName":"1",
 "items":[
 {
 "partNumber":"testsku120",
 "sku":"testsku120",
 "quantity":0
 }]
}

The Full Response

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

{
 "jobID": 76543210
}

Megan MayfieldOMS Dev: Inventory Adjust