Smart Refresh Inventory

Dynamically routes inventory refresh requests to synchronous or asynchronous processing based on payload size. Smaller payloads are generally processed synchronously and return immediate results. Larger payloads are processed asynchronously and return a job ID for tracking. The request schema is identical to the standard Refresh API. For more information, see the Smart Inventory APIs guide.

POST /commerce/inventory/v5/inventory/smart-refresh

Error

A valid request URL is required to generate request examples

200

{
  "jobID": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Body

application/json

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

Successful operation

Response from smart inventory endpoints indicating the processing method used

jobID · string | null

The job identifier for tracking asynchronous requests. This field is null for synchronous requests.

method · enum<string>

The processing method used: 'sync' for synchronous processing or 'async' for asynchronous processing. Kibo determines the routing based on payload size.

Available options: sync, async