Integrations
Get customiser diagnostics
Returns what went wrong when shoppers checked out from one customiser of
the authenticated Store in the last seven days. Requires
integrations:read.
Overview
A customiser of another Store answers the same 404
as one that never existed.
outcome is errors_found when an integration or webhook request about
the customiser failed, and incidents lists those failures, newest
first. It is no_failed_activity when none failed, and no_integration
when the Store has no integration or webhook subscription to make one.
Product creation and the cart handoff are two stages. A product that the
platform accepted, followed by a cart handoff that failed, shows as no
incident and a failed entry in recent_cart_handoffs. That is not an
integration failure.
This endpoint accepts no query parameters.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: integrations:read
Path parameters
The customiser id.
Example: 1
curl https://web.signcustomiser.com/api/v3/customisers/1/diagnostics \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'{
"data": {
"object": "customiser_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": {
"url": "https://example.com/products/neon-sign",
"origin": "https://example.com",
"source": "window",
"availability": "available",
"captured_at": "2026-11-14T09:29:58Z"
}
}
],
"recent_storefront_pages": [
{
"url": "https://example.com/products/neon-sign",
"origin": "https://example.com",
"source": "window",
"availability": "available",
"captured_at": "2026-11-14T09:29:58Z"
}
],
"recent_cart_handoffs": [
{
"checkout_attempt_id": "0f9c2b1e-6a4d-4c3b-9e8f-7a6b5c4d3e2f",
"state": "failed",
"summary": "The storefront did not add the product to the cart.",
"classification": "platform_rejected",
"classification_summary": "The platform refused the cart request.",
"started_at": "2026-11-14T09:29:58Z",
"reported_at": "2026-11-14T09:30:02Z",
"storefront_page": {
"url": "https://example.com/products/neon-sign",
"origin": "https://example.com",
"source": "window",
"availability": "available",
"captured_at": "2026-11-14T09:29:58Z"
}
}
]
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/customisers/42/diagnostics",
"documentation": "https://www.signcustomiser.com/help/api/"
},
"meta": {
"api_version": "v3",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
}{
"type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
"title": "Missing API key",
"status": 401,
"code": "missing_api_key",
"detail": "Provide a store API key as a bearer token.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
"title": "Insufficient scope",
"status": 403,
"code": "insufficient_scope",
"detail": "This operation requires the integrations:read scope.",
"required_scopes": [
"integrations:read"
],
"granted_scopes": [
"customisers:read"
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/resource_not_found",
"title": "Resource not found",
"status": 404,
"code": "resource_not_found",
"detail": "The requested resource does not exist or does not belong to the authenticated store.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/unknown_parameter",
"title": "Unknown query parameter",
"status": 422,
"code": "unknown_parameter",
"detail": "This endpoint accepts no query parameters.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
"title": "Too many requests",
"status": 429,
"code": "rate_limited",
"detail": "You have exceeded the request limit for this API key.",
"retry_after": 60,
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}