Batch change inventory
POST
/v2/inventory/batch-change
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
| Name | Description |
|---|---|
idempotency_key
|
A client-supplied, universally unique identifier (UUID) for the request. See Idempotency in the API Development 101 section for more information. |
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. |
ignore_unchanged_counts
|
Indicates whether the current physical count should be ignored if
the quantity is unchanged since the last physical count. Default: |
Response Fields
| Name | Description |
|---|---|
errors
|
Any errors that occurred during the request. |
counts
|
The current counts for all objects referenced in the request. |
Examples
POST
/v2/inventory/batch-change
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
curl https://connect.squareup.com/v2/inventory/batch-change \
-X POST \
-H 'Square-Version: 2020-08-26' \
-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",
"employee_id": "LRK57NSQ5X7PUD05",
"occurred_at": "2016-11-16T22:25:24.878Z"
}
}
],
"ignore_unchanged_counts": true
}'
Response JSON
{
"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"
}
]
}