Skip to content
Store data and insights

Get an order

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

GET /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). Set $COMPANY_ID, $ORDER_ID, $STOREFRONT_SCOPE_ID first.

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

Response

API response (200), shortened:

{
  "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"
    // … 10 more fields
  },
  "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 returns; storefront_scope_id is the store it belongs to. Needs Pro: without it the call answers 402 subscription_required.

Path parameters

NameTypeDescription
companyIdstring (uuid)Your workspace id, from productmetrics whoami or properties.list (company_id).
orderIdstringThe order: its id from orders.list. 1 to 255 characters.

Query parameters

NameTypeRequiredDescription
storefront_scope_idstring (uuid)YesThe storefront: its scope id from 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.

{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JBW548D0JG7R3PV5D4QBYQ81"
}
StatusCodeWhen
400invalid_requestA path, query or body value does not match this page. details.issues lists each location, path and message.
401invalid_tokenThe token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why.
402subscription_requiredNeeds Pro: without it the call answers 402 subscription_required.
403insufficient_scopeThe token lacks the read scope (details.required_scope): sign in again and allow it.
404not_foundAn id in the path does not exist, or the signed-in person cannot open it.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Store data and insights operations