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

Guide

Reconcile Inventory Quantities

Try in API Explorer

Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

A client-supplied, universally unique identifier (UUID) for the request.

See Idempotency in the API Development 101 section for more information.

Min Length

Max Length

128

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.

Max Length

100

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.

curl https://connect.squareup.com/v2/inventory/changes/batch-create \ -X POST \ -H 'Square-Version: 2024-11-20' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", "changes": [ { "type": "PHYSICAL_COUNT", "physical_count": { "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92", "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", "state": "IN_STOCK", "location_id": "C6W5YS5QM06F5", "quantity": "53", "team_member_id": "LRK57NSQ5X7PUD05", "occurred_at": "2016-11-16T22:25:24.878Z" } } ], "ignore_unchanged_counts": true }'

{ "errors": [], "counts": [ { "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", "catalog_object_type": "ITEM_VARIATION", "state": "IN_STOCK", "location_id": "C6W5YS5QM06F5", "quantity": "53", "calculated_at": "2016-11-16T22:28:01.223Z" } ] }