You are viewing an old version of the API

All Versions

Batch retrieve inventory counts

Returns current counts for the provided CatalogObjects at the requested Locations.

Results are paginated and sorted in descending order according to their calculated_at timestamp (newest first).

When updated_after is specified, only counts that have changed since that time (based on the server timestamp for the most recent change) are returned. This allows clients to perform a "sync" operation, for example in response to receiving a Webhook notification.

Required permissions: INVENTORY_READ

Open in API Explorer

Request Body

Name	Description
`catalog_object_ids string [ ]`	Filters results by `CatalogObject` ID. Only applied when set. Default: unset.
`location_ids string [ ]`	Filters results by `Location` ID. Only applied when set. Default: unset.
`updated_after string`	Provided as an RFC 3339 timestamp. Returns results whose `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). Examples for January 25th, 2020 6:27.34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
`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.

Response Fields

Name	Description
`errors Error [ ]`	Any errors that occurred during the request.
`counts InventoryCount [ ]`	The current calculated inventory counts for the requested objects and locations.
`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.

Examples

All Versions

curl https://connect.squareup.com/v2/inventory/batch-retrieve-counts \
  -X POST \
  -H 'Square-Version: 2020-06-25' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "catalog_object_ids": [
      "W62UWFY35CWMYGVWK6TWJDNI"
    ],
    "location_ids": [
      "59TNP9SA8VGDA"
    ],
    "updated_after": "2016-11-16T00:00:00.000Z"
  }'

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

Inventory API You are viewing an old version of the API 2020-06-25 Version 2020-06-25 All Versions Inventory API Batch retrieve inventory counts

Request Body

Response Fields

Examples

Share Feedback

You are viewing an old version of the API

All Versions

Batch retrieve inventory counts