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

You are viewing an old version of the API
List 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

Provides inventory information for all inventory-enabled item variations.

Permissions
ITEMS_READ

Deprecation date
2019-11-20
Retirement date
2020-11-18
Replaced by
BatchRetrieveInventoryCounts
Migration guide
Name Description
location_id
string

Required

The ID of the item's associated location.

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
InventoryEntry [ ]

Examples

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

Share Feedback

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