Skip to content
Store data and insights

List orders

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

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

Response

API response (200), shortened:

{
  "data": {
    "orders": [
      {
        "orderId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
        "platformOrderId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
        "orderName": "#1042"
        // … 9 more fields
      }
    ],
    "nextCursor": "eyJvZmZzZXQiOjUwfQ",
    "seenThrough": 0
    // … 1 more field
  },
  "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. 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).

Query parameters

NameTypeRequiredDescription
storefront_scope_idstring (uuid)YesThe storefront: its scope id from tracking.get_commerce_configuration.
cursorstringNoThe nextCursor of the previous page; leave it out for the first page. 1 to 2048 characters.
limitintegerNoHow 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.

{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01J5GTMGVYXBNBRFFRNTG1XTWB"
}
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