You are viewing an old version of the API
Adjust inventory
V1

Deprecated

Note We recommend using the Square API (V2) for all new development when possible.

Adjusts the current available inventory of an item variation



Required permissions ITEMS_WRITE

Path Parameters

Name Description
location_id
string

Required

The ID of the item's associated location.

variation_id
string

Required

The ID of the variation to adjust inventory information for.

Request Body

Name Description
adjustment_type
string

The reason for the inventory adjustment.

memo
string

A note about the inventory adjustment.

quantity_delta
number

The number to adjust the variation's quantity by.

Response Fields

Name Description
quantity_on_hand
number

The current available quantity of the item variation.

variation_id
string

The variation that the entry corresponds to.

Examples

You are viewing an old version of the API
POST /v1/{location_id}/inventory/{variation_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/{location_id}/inventory/{variation_id} \
  -X POST \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

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