Adjust

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 (+/-). Increments do not require a + sign and may be sent as a simple integer, but decrements must include the – sign. 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.

These requests are placed into a queue of jobs that are processed one at a time. Due to this, the best practice is to submit fewer requests with more items per call, rather than numerous requests with a small number of items each. However, unlike the Refresh API that accepts a maximum of 12000 items per call, this Adjust API only accepts up to 1000 items. If you exceed that limit, a Bad Request error will be returned.

Recommended: Consider using the Smart Adjust endpoint instead, which automatically routes requests to sync or async processing based on payload size.

POST /commerce/inventory/v5/inventory/adjust

Error

A valid request URL is required to generate request examples

200

{
  "jobID": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Body

application/json

Request to adjust inventory

Request needed for adjusting inventory

items · Adjust Item · object[]

List of items to adjust

Show child attributes

locationCode · string

Location Code

pageNum · integer

which page to show

pageSize · integer

how many results to show per page

sortBy · string

index to sort results by

userID · integer

user id

Response

200

application/json

Success

Job ID Response

jobID · integer

Job ID