Refresh

Sets the inventory count for products at a particular location. 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. Unlike the Adjust API that only accepts a maximum of 1000 items per call, this Refresh API can accept up to 12000 items. However, Kibo recommends batches of 3000 items.

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

POST /commerce/inventory/v5/inventory/refresh

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 refresh inventory

Request needed for refreshing inventory

items · Refresh Item · object[]

List of items to refresh

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