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

Deprecated

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

Provides inventory information for all inventory-enabled item variations



Required permissions ITEMS_READ

Path Parameters

Name Description
location_id
string

Required

The ID of the item's associated location.

Query Parameters

Name Description
limit
integer

The maximum number of inventory entries to return in a single response. This value cannot exceed 1000.

batch_token
string

A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Response Fields

Name Description
{items}
V1​Inventory​Entry [ ]

Root array of on V1InventoryEntry objects on the response

Examples

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

Share Feedback

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