> ## Documentation Index
> Fetch the complete documentation index at: https://e328d4e-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://e328d4e-productmetrics.manicule.dev/docs/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://e328d4e-productmetrics.manicule.dev/docs/api/mcp.
> Every agent surface: https://e328d4e-productmetrics.manicule.dev/docs/.well-known/llms-manifest.json

# List orders (/docs/api/store-data/orders-list)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1451 · 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), [Get inventory state](/docs/api/store-data/inventory-get-state.md), [Check orders are available](/docs/api/store-data/orders-get-availability.md), [Get an order](/docs/api/store-data/orders-get.md)

> The orders of one connected store (storefront scope), newest first, with revenue, margin, payment and order status per order; pass next_cursor as cursor for the next page.

`GET https://prod-backend.productmetrics.io/api/public/v1/companies/{companyId}/orders`

**Scope** `read` · **Access** Read only · **Operation id** `orders.list`

## Try it

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



**productmetrics CLI:**

```bash
productmetrics orders list \
  --company-id $COMPANY_ID \
  --storefront-scope-id $STOREFRONT_SCOPE_ID \
  --json
```

**curl:**

```bash
curl "https://prod-backend.productmetrics.io/api/public/v1/companies/$COMPANY_ID/orders?storefront_scope_id=$STOREFRONT_SCOPE_ID" \
  -H "Authorization: Bearer $PM_TOKEN"
```

## Response



API response (200):

```json
{
  "data": {
    "orders": [
      {
        "orderId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
        "platformOrderId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
        "orderName": "#1042",
        "occurredAt": "2026-11-02T09:30:00.000Z",
        "firstObservedAt": "2026-11-02T09:30:00.000Z",
        "paymentStatus": "pending",
        "orderStatus": "open",
        "currencyCode": "EUR",
        "revenueMicros": "108000000",
        "revenueExTaxMicros": "89260000",
        "margin": {
          "status": "known",
          "completeness": "known",
          "costMicros": "40800000",
          "contributionMarginMicros": "48460000",
          "calculatedAt": "2026-11-02T09:30:00.000Z",
          "components": [
            {
              "name": "product_cost",
              "status": "actual",
              "amountMicros": "108000000"
            }
          ]
        },
        "classification": "NEW"
      }
    ],
    "nextCursor": "eyJvZmZzZXQiOjUwfQ",
    "seenThrough": 0,
    "adSpend": {
      "amountMicros": "108000000",
      "currencyCode": "EUR",
      "periodStartAt": "2026-11-02T09:30:00.000Z",
      "periodEndAt": "2026-11-02T09:30:00.000Z"
    }
  },
  "request_id": "req_01J49B42FVEK132XNFNRJMRV4A"
}
```

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

## Before you call

`storefront_scope_id` comes from [`tracking.get_configuration`](/docs/api/stores-and-tracking/tracking-get-configuration). Needs Pro: without it the call answers 402 subscription_required.

## Path parameters

| Name        | Type          | Description                                                                                                          |
| ----------- | ------------- | -------------------------------------------------------------------------------------------------------------------- |
| `companyId` | string (uuid) | Your workspace id, from `productmetrics whoami` or [`properties.list`](/docs/api/account/properties-list) (`company_id`). |

## Query parameters

| Name                  | Type          | Required | Description                                                                                                                                |
| --------------------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `storefront_scope_id` | string (uuid) | Yes      | The storefront: its scope `id` from [`tracking.get_commerce_configuration`](/docs/api/stores-and-tracking/tracking-get-commerce-configuration). |
| `cursor`              | string        | No       | The `nextCursor` of the previous page; leave it out for the first page. 1 to 2048 characters.                                              |
| `limit`               | integer       | No       | How many items to return. From 1 to 100.                                                                                                   |

## 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_01J5GTMGVYXBNBRFFRNTG1XTWB"
}
```

| 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)
