Inventory API

You are viewing an old version of the API

2020-12-16

Version 2020-12-16

• All Versions

Inventory 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.

Path Parameters

Example code

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
quantity_delta number	The number to adjust the variation's quantity by.
adjustment_type string	The reason for the inventory adjustment. Show Values
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.

curl https://connect.squareup.com/v1/location_id0/inventory/variation_id1 \
  -X POST \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'