Skip to content
Stores and tracking

Get store connections

The workspace's store connections across all its properties: each connected store (Shopify, WooCommerce, Shopware 6, Lightspeed, website), its status, the properties it feeds, and which platforms the person may connect now.

GET /companies/{companyId}/tracking/commerce

Scope read · Access Read only · Operation id tracking.get_commerce_configuration

Try it

productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $COMPANY_ID first.

productmetrics tracking get-commerce-configuration \
  --company-id $COMPANY_ID \
  --json

Response

API response (200), shortened:

{
  "data": {
    "companyId": "2a7d9b3c-1e4f-4a5b-8c6d-7e8f9a0b1c2d",
    "desiredRevision": 0,
    "activeRevision": 0,
    "canWrite": true
    // … 8 more fields
  },
  "request_id": "req_01JTJ960F5XRR3BNYMHY0VSHZP"
}

CLI output: productmetrics tracking get-commerce-configuration --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Call before stores.connect so a store is not connected twice, and after it to see the new connection.

Path parameters

NameTypeDescription
companyIdstring (uuid)Your workspace id, from productmetrics whoami or properties.list (company_id).

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_01JFGPJ0MZFVM4E862SQTVCE7J"
}
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.
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 Stores and tracking operations