> ## Documentation Index
> Fetch the complete documentation index at: https://dc9c767-productmetrics.manicule.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://dc9c767-productmetrics.manicule.dev/docs/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://dc9c767-productmetrics.manicule.dev/docs/api/mcp.
> Every agent surface: https://dc9c767-productmetrics.manicule.dev/docs/.well-known/llms-manifest.json

# Get inventory state (/docs/api/store-data/inventory-get-state)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1604 · updated: 2026-11-16 -->
Related: [Get analytics status](/docs/api/store-data/analytics-get-status.md), [Query the lake](/docs/api/store-data/data-query.md), [Get an insight card](/docs/api/store-data/insights-get.md), [Check orders are available](/docs/api/store-data/orders-get-availability.md), [Get an order](/docs/api/store-data/orders-get.md), [List orders](/docs/api/store-data/orders-list.md)

> Stock of the property's shops per variant: units on hand, weekly sales, weeks of cover, expected stockout and reorder dates, suggested reorder quantity and stock value.

`GET https://prod-backend.productmetrics.io/api/public/v1/properties/{propertyId}/inventory`

**Scope** `read` · **Access** Read only · **Operation id** `inventory.get_state`

## Try it

`productmetrics` runs after `productmetrics login`; curl needs `PM_TOKEN` (see [Authentication](/docs/api/overview#authentication)). Set `$PROPERTY_ID` first.



**productmetrics CLI:**

```bash
productmetrics inventory get-state --property-id $PROPERTY_ID --json
```

**curl:**

```bash
curl "https://prod-backend.productmetrics.io/api/public/v1/properties/$PROPERTY_ID/inventory" \
  -H "Authorization: Bearer $PM_TOKEN"
```

## Response



API response (200):

```json
{
  "data": {
    "items": [
      {
        "variantId": "SKU-1042",
        "productId": "SKU-1042",
        "sku": "SKU-1042",
        "onHand": 12.5,
        "availability": "in_stock",
        "outOfStock": true,
        "weeklyVelocity": 0,
        "coverWeeks": 0,
        "stockoutDate": "2026-11-02",
        "reorderDate": "2026-11-02",
        "suggestedQty": 0,
        "leadTimeDays": 30,
        "leadTimeSource": "default",
        "safetyBufferDays": 30,
        "safetyBufferSource": "default",
        "stockValue": {
          "atCostMicros": 40800000,
          "atPriceMicros": 108000000,
          "currency": "EUR"
        },
        "slowMover": {
          "excessCoverWeeks": 0,
          "reason": "needs_exposure"
        },
        "expectedLeftAtSeasonEnd": 1,
        "seasonal": true,
        "peakWeek": "2026-11-02",
        "demandSeries24w": [
          0
        ],
        "computedAt": "2026-11-02T09:30:00.000Z",
        "observedAt": "2026-11-02T09:30:00.000Z"
      }
    ],
    "dataAsOf": "2026-11-02T09:30:00.000Z",
    "derivedVersion": "7f3a9c2e",
    "moneyObservedAt": {
      "SKU-1042": "2026-11-02T09:30:00.000Z"
    },
    "nextCursor": "eyJvZmZzZXQiOjUwfQ"
  },
  "request_id": "req_01JTRQJ2G6QR6SJQMH5ED3VFS7"
}
```

**CLI output:** `productmetrics inventory get-state --json` prints `{ "ok": true, "data": …, "request_id": "…" }` with the same `data`.

## Before you call

Either one page of `filter` (all, reorder_due, slow_movers; pass `next_cursor` as `cursor`) or up to 500 comma-separated `variant_ids`, not both. Needs Pro: without it the call answers 402 subscription_required.

## Path parameters

| Name         | Type          | Description                                                                                                         |
| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------- |
| `propertyId` | string (uuid) | The property id, from `productmetrics whoami` or [`properties.list`](/docs/api/account/properties-list) (`property_id`). |

## Query parameters

| Name          | Type    | Required | Description                                                                                                                                                                                   |
| ------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `feed_scope`  | string  | No       | Which feed of the property: a feed id, or `all` for the property-wide settings.                                                                                                               |
| `filter`      | enum    | No       | Either one page of `filter` (all, reorder_due, slow_movers; pass `next_cursor` as `cursor`) or up to 500 comma-separated `variant_ids`, not both. One of `all`, `reorder_due`, `slow_movers`. |
| `limit`       | integer | No       | How many items to return. From 1 to 500.                                                                                                                                                      |
| `cursor`      | string  | No       | The `nextCursor` of the previous page; leave it out for the first page. 1 to 2048 characters.                                                                                                 |
| `variant_ids` | string  | No       | Either one page of `filter` (all, reorder_due, slow_movers; pass `next_cursor` as `cursor`) or up to 500 comma-separated `variant_ids`, not both. 1 to 64000 characters.                      |

## Errors

A failure answers with its HTTP status and `{ error: { code, message, details? }, request_id }`. Branch on `code` (stable, lower_snake); show `message` to the person. The CLI prints the same `error` with `"ok": false`.

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JCWRT4DNY5T6XM4C53BR80XA"
}
```

| Status | Code                    | When                                                                                                                      |
| ------ | ----------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| 400    | `invalid_request`       | A path, query or body value does not match this page. `details.issues` lists each `location`, `path` and `message`.       |
| 401    | `invalid_token`         | The token is missing, expired or revoked: sign in again (`productmetrics login`). The `WWW-Authenticate` header says why. |
| 402    | `subscription_required` | Needs Pro: without it the call answers 402 subscription_required.                                                         |
| 403    | `insufficient_scope`    | The token lacks the `read` scope (`details.required_scope`): sign in again and allow it.                                  |
| 404    | `not_found`             | An id in the path does not exist, or the signed-in person cannot open it.                                                 |
| 429    | `rate_limited`          | More than 600 requests a minute for this person: wait the `Retry-After` seconds (60) and retry.                           |

[All Store data and insights operations](/docs/api/store-data)
