• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

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

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

Deprecated
Effective November 20th, 2019

Adjusts the current available inventory of an item variation.

Permissions
ITEMS_WRITE

Deprecation date
2019-11-20
Retirement date
2020-11-18
Replaced by
BatchChangeInventory
Migration guide
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.

Name Description
quantity_delta
number

The number to adjust the variation's quantity by.

adjustment_type
string

The reason for the inventory adjustment.

memo
string

A note about the inventory adjustment.

Response Fields

Name Description
variation_id
string

The variation that the entry corresponds to.

quantity_on_hand
number

The current available quantity of the item variation.

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_id0/inventory/variation_id1 \
  -X POST \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Share Feedback

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