Retrieve inventory count

GET

/v2/inventory/{catalog_object_id}

Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations.

Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint.

Permissions:INVENTORY_READ

Guide

Retrieve IN_STOCK Quantities

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

catalog_object_id

string

Required

ID of the CatalogObject to retrieve.

Link to section

Query parameters

Link to section

location_ids

string

The Location IDs to look up as a comma-separated list. An empty list queries all locations.

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.

See the Pagination guide for more information.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes

Link to section

counts

The current calculated inventory counts for the requested object and locations.

Show attributes

Link to section

cursor

string

The pagination cursor to be used in a subsequent request. If unset, this is the final response.

See the Pagination guide for more information.

Link to section

Examples

GET /v2/inventory/{catalog_object_id}

curl https://connect.squareup.com/v2/inventory/catalog_object_id0?location_ids=C6W5YS5QM06F5 \
  -H 'Square-Version: 2023-03-15' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "errors": [],
  "counts": [
    {
      "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
      "catalog_object_type": "ITEM_VARIATION",
      "state": "IN_STOCK",
      "location_id": "C6W5YS5QM06F5",
      "quantity": "22",
      "calculated_at": "2016-11-16T22:28:01.223Z"
    }
  ]
}