Skip to content
Stores and tracking

Get Shopware 6 status

Whether a Shopware 6 store's order ingestion works: setup_required until the person installed the Product Metrics plugin in Shopware and paired it with the setup token, then the adapter's sync status, pending and quarantined jobs, last success and last error.

GET /companies/{companyId}/tracking/installations/{installationId}/shopware6/status

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

Try it

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

productmetrics tracking get-shopware6-status \
  --company-id $COMPANY_ID \
  --installation-id $INSTALLATION_ID \
  --json

Response

API response (200):

{
  "data": {
    "schema_version": 1,
    "installation_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
    "sales_channel_id": "9f86d081884c7d659a2feaa0c55ad015",
    "status": "setup_required",
    "pending_jobs": 0,
    "quarantined_jobs": 0,
    "last_success_at": "2026-11-02T09:30:00.000Z",
    "last_error_code": "credential_invalid",
    "observed_orders": 14
  },
  "request_id": "req_01JDPCPYYVX064VCKC5308XN9T"
}

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

Before you call

Call after stores.connect for Shopware 6 to check the plugin step is done.

Path parameters

NameTypeDescription
companyIdstring (uuid)Your workspace id, from productmetrics whoami or properties.list (company_id).
installationIdstring (uuid)The tracking installation: installationId from tracking.get_commerce_configuration or tracking.get_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_01JSYZY2EBSVA65X4JNGC44EXV"
}
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