Skip to content
Stores and tracking

Choose the store platform

Saves which store platform the workspace sells on (the select_store setup step), as choosing it in the app does.

PUT /companies/{companyId}/store-platform

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

Try it

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

productmetrics stores select-platform \
  --company-id $COMPANY_ID \
  --platform shopify \
  --json

Response

API response (200):

{
  "data": {
    "status": "none",
    "platform": "shopify",
    "otherPlatformName": "PrestaShop"
  },
  "request_id": "req_01J16PG3DDGBEE35ZPN0JYBH9K"
}

CLI output: productmetrics stores select-platform --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

It connects nothing: call it before billing.create_checkout_link, which refuses until a platform is chosen, then connect the store with stores.connect. other needs other_platform_name. Needs editor or admin access.

Path parameters

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

Body

NameTypeRequiredDescription
platformenumYesThe store’s platform. custom is a website without a store platform. One of shopify, woocommerce, lightspeed_c_series, magento, shopware6, custom, other.
other_platform_namestring or nullNoThe platform’s name, only with other. Up to 120 characters.

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_01JDE4CWRJJ0PCF0FPHKPY52HW"
}
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