Sign Customiser

Navigation

Dark mode

Integrations

get_customiser_diagnostics

read

Get customiser diagnostics

Copy page

Answer why shoppers could not add a customiser design to the cart or why its products did not reach the selling platform.

Overview

Reads what went wrong when shoppers checked out from one customiser of the connected Store in the last seven days: an outcome (errors_found, no_failed_activity or no_integration), up to five failed integration or webhook requests with a plain summary and classification each, the last storefront pages the customiser was used on, and the last cart handoffs with their state. A failed cart handoff after the platform accepted the product is not an integration failure. It requires the integrations:read scope and has no side effects.

Permission

Requires theintegrations:readpermission. A connection without it answersinsufficient_scopenaming the permission to approve.

Annotations

readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
openWorldHintfalse

Prerequisites

  • A customiser id from list_customisers.
  • A merchant has connected this store and approved the integrations:read scope.

Arguments

customiser_idintegerrequired

The customiser id, from list_customisers.

Result

The outcome, the failed requests, the recent storefront pages and the recent cart handoffs of the customiser, at most five of each.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
diagnosticsobjectalways present
diagnostics.customiser_idintegeralways present
diagnostics.outcomestringalways present

Expected to grow.

One of: errors_found, no_failed_activity, no_integration

diagnostics.incidentsarray of objectalways present

The failed requests, newest first, at most five.

diagnostics.incidents[].occurred_atstringalways present
diagnostics.incidents[].operationstringalways present

product_sync, product_webhook, order_webhook or external_request. Expected to grow.

diagnostics.incidents[].status_codeinteger or null
diagnostics.incidents[].classificationstringalways present

http_client_error, http_server_error, timeout, connection_error, transport_error or unknown_failure. Expected to grow.

diagnostics.incidents[].merchant_summarystringalways present
diagnostics.incidents[].trace_idstringalways present

The identifier of the failed request, to quote to support.

diagnostics.incidents[].storefront_pageobject or null

The storefront page the shopper was on when the request started, or null.

diagnostics.recent_storefront_pagesarray of objectalways present

The last storefront pages the customiser was used on, at most five: url, origin, source, availability and captured_at.

diagnostics.recent_cart_handoffsarray of objectalways present

The last cart handoffs, at most five: checkout_attempt_id, state (started, unacknowledged, succeeded or failed), summary, classification, classification_summary, started_at, reported_at and storefront_page.

Error cases

insufficient_scope

The connection was approved without integrations:read.

resource_not_found

No customiser with that id belongs to this store. Call list_customisers to find a valid id.

A customiser whose product sync failed

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_customiser_diagnostics",
    "arguments": {
      "customiser_id": 42
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "diagnostics": {
        "customiser_id": 42,
        "outcome": "errors_found",
        "incidents": [
          {
            "occurred_at": "2026-11-14T09:30:00Z",
            "operation": "product_sync",
            "status_code": 502,
            "classification": "http_server_error",
            "merchant_summary": "The connected platform had a server error while Sign Customiser sent the product.",
            "trace_id": "88123",
            "storefront_page": null
          }
        ],
        "recent_storefront_pages": [],
        "recent_cart_handoffs": []
      }
    }
  }
}

A customiser of another store (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_customiser_diagnostics",
    "arguments": {
      "customiser_id": 999
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "resource_not_found",
        "title": "Resource not found",
        "detail": "The requested resource does not exist or does not belong to the authenticated store.",
        "recovery": "The identifier does not exist in this store. Use the matching list tool to rediscover a valid id."
      }
    }
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.