Skip to content
Merchant Center

Get Merchant Center auto-setup status

Whether the property's Merchant Center supplemental sources are in place and how their latest file fetch went (items, errors, warnings).

GET /properties/{propertyId}/merchant-center/auto-setup/status

Scope read · Access Read only · Operation id merchant_center.get_auto_setup_status

Try it

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

productmetrics merchant-center get-auto-setup-status \
  --property-id $PROPERTY_ID \
  --json

Response

API response (200), shortened:

{
  "data": {
    "state": "verified",
    "unknownReason": "consent_required",
    "itemsApplied": 0,
    "itemsTotal": 42
    // … 1 more field
  },
  "request_id": "req_01JMBW4GGYFAHRF524DCSZ4N8A"
}

CLI output: productmetrics merchant-center get-auto-setup-status --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Call it after merchant_center.apply_auto_setup to confirm the sources work; a new source can take a while to fetch its first file.

Path parameters

NameTypeDescription
propertyIdstringThe property id, from productmetrics whoami or properties.list (property_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_01J874MY6PDB5G8MGRNGV2MA8D"
}
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 Merchant Center operations