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

# Get an order (/docs/api/store-data/orders-get)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1612 · 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), [List orders](/docs/api/store-data/orders-list.md)

> One order of a connected store with its lines, margin, shipping revenue, payment and order status, and customer classification.

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

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

## Try it

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



**productmetrics CLI:**

```bash
productmetrics orders get \
  --company-id $COMPANY_ID \
  --order-id $ORDER_ID \
  --storefront-scope-id $STOREFRONT_SCOPE_ID \
  --json
```

**curl:**

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

## Response



API response (200):

```json
{
  "data": {
    "orderId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
    "platformOrderId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
    "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",
    "revision": 1,
    "sourcePlatform": "lightspeed_c_series",
    "historyCoverage": "complete",
    "shippingRevenueExTaxMicros": "89260000",
    "lines": [
      {
        "lineId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
        "itemId": "SKU-1042",
        "quantity": 3,
        "currentQuantity": 3,
        "revenueMicros": "108000000",
        "revenueExTaxMicros": "89260000",
        "productCostMicros": "40800000",
        "allocatedCostMicros": "40800000",
        "contributionMarginMicros": "48460000",
        "allocatedCostComponents": [
          {
            "name": "product_cost",
            "status": "actual",
            "amountMicros": "108000000"
          }
        ],
        "catalogReference": {
          "productSpineStoreId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
          "platform": "lightspeed_c_series",
          "productId": "SKU-1042",
          "variantId": "SKU-1042"
        },
        "historicalCostEvidence": [
          {
            "source": "shopify",
            "provider": "shopify",
            "sourceReference": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
            "observedAt": "2026-11-02T09:30:00.000Z",
            "policyRevision": "3"
          }
        ]
      }
    ]
  },
  "request_id": "req_01JHMG4K5A3GQYWWM3SCWP5VW7"
}
```

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

## Before you call

`order_id` is the id [`orders.list`](/docs/api/store-data/orders-list) returns; `storefront_scope_id` is the store it belongs to. 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`). |
| `orderId`   | string        | The order: its id from [`orders.list`](/docs/api/store-data/orders-list). 1 to 255 characters.                            |

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

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

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