You are viewing an old version of the API
Batch change inventory

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.

Required permissions INVENTORY_WRITE

Request Body

Name Description
changes
Inventory​Change [ ]

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 size is 100 changes.

idempotency_key
string

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

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

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.

Response Fields

Name Description
counts
Inventory​Count [ ]

The current counts for all objects referenced in the request.

errors
Error [ ]

Any errors that occurred during the request.

Examples

You are viewing an old version of the API
POST /v2/inventory/batch-change
cURL
  • cURL
  • Ruby
  • Python
curl https://connect.squareup.com/v2/inventory/batch-change \
  -X POST \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -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"
    }
  ]
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?