Sign Customiser

Navigation

Dark mode

Products

Retry a product's tube centre-line trace

Copy page

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.

POST/api/v3/products/{product_id}/tube-centre-line/retry
POSTRetry a product's tube centre-line trace
POST/api/v3/products/{product_id}/tube-centre-line/retry

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. 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

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Path

Product id returned by the list operation.

Retry a product's tube centre-line trace

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_idstringpathrequired

Product id returned by the list operation.

Example: 731

Retry a product's tube centre-line trace
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'
Response
{
  "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 a question and press Enter. Use the arrow keys to move between the results.