Skip to content
Stores and tracking

New WooCommerce setup token

Creates a new one-time setup token for a WooCommerce store whose connection is pending or active, e.g. when the token from stores.connect expired or the plugin was reinstalled.

POST /tracking/installations/{installationId}/woocommerce/setup-claims

Scope setup · Access Changes data · Operation id stores.create_woocommerce_setup_claim

Try it

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

productmetrics stores create-woocommerce-setup-claim \
  --installation-id $INSTALLATION_ID \
  --json

Response

API response (200):

{
  "data": {
    "setupToken": "q8Xr2LmZ4vT_nW7cJ1hK9pB-dF3sY6gA0eU5iO2tR8x",
    "expiresAt": "2026-11-02T09:30:00.000Z",
    "verifiedHostname": "example-store.com"
  },
  "request_id": "req_01JHPPJCHEE7WPG09VHD0B903B"
}

CLI output: productmetrics stores create-woocommerce-setup-claim --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Needs editor or admin access. The person pastes setupToken into the Product Metrics plugin in their WordPress admin before expiresAt; it is a secret, show it to the person only. Then call tracking.get_commerce_configuration to see the store become active.

Secret: setupToken holds a secret. Show it to the person only; never log or store it. The CLI hides secrets unless you pass --show-secrets.

Path parameters

NameTypeDescription
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 setup scope; connect again and allow it.",
    "details": {
      "required_scope": "setup"
    }
  },
  "request_id": "req_01J88PYXHZT705S8G19AHE81B8"
}
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 setup 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