---
title: "List inventory"
method: GET
path: "/1.0/commerce/inventory"
tags: ["Inventory"]
---

# List inventory

`GET /1.0/commerce/inventory`

## Request

- Base URL: `https://api.squarespace.com`
- URL: `https://api.squarespace.com/1.0/commerce/inventory`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/squarespace/apis/commerce-api/docs/1.0/commerce/inventory/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves real-time stock information for all product variants. Stock information is stored in an InventoryItem for each product variant. The response contains up to 50 InventoryItems and supports dynamic cursors for pagination.

## Query parameters

- `cursor` string

## Headers

- `Authorization` string, required
- `User-Agent` string, required

## Response `200`

OK

- PaginatedInventoryItemListResponse
  - `inventory` InventoryItem[]: Array of InventoryItem resources. If the merchant site doesn't have any physical or service product variants, this array is empty.
    - `descriptor` string: Generated description using the product's title and any available variant attributes including, but not limited to, color and size.
    - `isUnlimited` boolean: Indicates whether stock is currently tracked for the item.
    - `quantity` integer: Current amount in stock, or the last known stock amount prior to becoming unlimited. This value is modified by purchases and returns only when `isUnlimited` is `false`.
    - `sku` string: Stock keeping unit (SKU) code assigned by the Squarespace merchant for the variant; used to identify an exact variant of a product using a naming scheme preferred by the merchant.
    - `variantId` string: The product variant id, which also serves as a unique id for the InventoryItem.
  - `pagination` object
    - `hasNextPage` boolean
    - `nextPageCursor` string
    - `nextPageUrl` string

## Other responses

- `400`: Bad Request. Type: INVALID_REQUEST_ERROR. The cursor parameter contains an invalid value.
- `404`: Not found. The API version is not supported.

---

[API](https://skmtc.dev/squarespace/apis/commerce-api.md) - [All operations](https://skmtc.dev/squarespace/apis/commerce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/squarespace/apis/commerce-api/revisions/5dd4b1b7cd38?raw)