<- Inventory API

Inventory API

Batch change inventory

POST

 /v2/inventory/changes/batch-create

Applies adjustments and counts to the provided item quantities.

On success: returns the current calculated counts for all objects referenced in the request. On failure: returns a list of related errors.

Permissions:INVENTORY_WRITE
Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

Link to section

changes

The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order.

Link to section

ignore_unchanged_counts

boolean

Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: true.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

counts

The current counts for all objects referenced in the request.

Link to section

changes

Beta

Changes created for the request.