---
title: "List inventory summaries"
method: GET
path: "/inventories/v1/summaries"
tags: ["inventory_endpoints"]
---

# List inventory summaries

`GET /inventories/v1/summaries`

## Request

- Base URL: `https://partners.tryotter.com`
- URL: `https://partners.tryotter.com/inventories/v1/summaries`
- Auth: OAuth 2
  - Authorization code: `/v1/auth/oauth2/authorize`
  - Client credentials
  - Token URL: `/v1/auth/token` scopes: `catalog`
- TypeScript: <https://skmtc.dev/cloudkitchens/apis/otter-api/docs/inventories/v1/summaries/get.ts> (a function with typed inputs; its response is checked against the schema)

List inventory summaries by the requested parameters.
Rate limit: 32 requests per minute.

## Query parameters

- `limit` string: Max number of entities to retrieve
- `token` string: Opaque token used for paging. Query parameters must be URL encoded.

## Headers

- `X-Store-Id` string, required: The unique identifier of the store in your app. This ID, along with the `Application ID`, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to `onboarding:905bb725-b141-4a9b-832a-1f254f772c94` (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided `internalStoreId` (a.k.a. Sku-Sku ID).

## Response `200`

The inventory summaries were successfully retrieved

- InventorySummariesResponse
  - `inventorySummaries` InventorySummary[]: A list of the inventory summaries.
    - `id` string, required: A unique identifier for the product.
    - `gtin` string: A 14 digit Global Trade Item Number (GTIN). For GTIN values that are shorter than 14 digits, value will be padded with leading zeroes.
    - `name` string, required: The name of the product.
    - `slug` string: short, unique human-readable id for the product
    - `externalId` string: id of the product provided by the seller
    - `sellableQuantity` integer, required: The total quantity of the product ready to be sold. Does not include pending or in-progress shipments.
    - `unsellableQuantity` integer: The total quantity of the product that is in the facility but unable to be sold. This will include inventory that is damaged, expired or otherwise unsellable.
    - `inboundQuantity` integer: The total quantity of the product inbound to the facility or waiting at the facility to be processed.
  - `nextToken` string: Opaque token used to fetch the following page. If set, pass the value of nextToken to the next request. If not set, no more results are available.

## Other responses

- `400`: The request is malformed.
- `401`: Invalid authorization.
- `403`: Authorization not valid for the requested resource.
- `404`: Resource not found.
- `422`: The request body is not valid.

---

[API](https://skmtc.dev/cloudkitchens/apis/otter-api.md) - [All operations](https://skmtc.dev/cloudkitchens/apis/otter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudkitchens/apis/otter-api/revisions/4c868194a467?raw)