Products
Retry a product's tube centre-line trace
Starts the tube centre-line trace of a neon product again, as the
merchant admin's Try again button on the product does. Only a trace that
ended with timeout or trace_failed, of an order whose cart is stored,
can run again: the response is 202 with status: pending, and the
tube_centre_line_dxf file can then arrive on the order line item.
Overview
While
a trace is pending, nothing new is queued and the response is 200 with
the state as it stands. When nothing can run again (the reason is final,
the cart is not stored, the file exists or no trace was requested), the
response is 409 tube_centre_line_not_retryable. The order line item
shows the state as tube_centre_line_status and the
tube_centre_line_dxf entry of production_files
(GET/api/v3/orders/{order_id}).
Requires products:write. The body must be empty or {}. An optional
Idempotency-Key replays the first response. Attempts are limited to
six per API key per minute, as in the merchant admin; a refused attempt
counts, and a replay does not.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: products:write
Path parameters
Product id returned by the list operation.
Example: 731
curl https://web.signcustomiser.com/api/v3/products/731/tube-centre-line/retry \
--request POST \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'{
"data": {
"object": "tube_centre_line",
"status": "pending",
"refusal_reason": null,
"can_retry": false
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/products/731/tube-centre-line/retry",
"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 products:write scope.",
"required_scopes": [
"products:write"
],
"granted_scopes": [
"products: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/tube_centre_line_not_retryable",
"title": "Tube centre line not retryable",
"status": 409,
"code": "tube_centre_line_not_retryable",
"detail": "This product has no tube centre-line trace that can run again.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/unknown_field",
"title": "Unknown request field",
"status": 422,
"code": "unknown_field",
"detail": "This operation accepts no request fields.",
"errors": [
{
"parameter": "format",
"code": "unknown_field",
"detail": "The request field format is not supported by this endpoint."
}
],
"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"
}