Products

Show a product

Copy page

Return one modern product owned by the authenticated Store, including dimensions and artwork URLs. Artwork URLs are public storage URLs for existing designs.

GET/api/v3/products/{product_id}

Show a product

Return one modern product owned by the authenticated Store, including dimensions and artwork URLs. Artwork URLs are public storage URLs for existing designs. For a private AI design, they are Sign Customiser download links (`/ai-design-files/{token}`). Each link is stable and revocable. Each request redirects to a new short-lived download. `title` and `description` are Store product metadata and may contain customer-entered sign content, so protect keys with `products:read`. ProductCache history, raw node data, provider payloads, underlying upload paths, upload/contact names, upload tokens, and emails are never exposed. The operation is read-only. Unknown and foreign ids return the same 404. Remove unknown query parameters after a 422. Retry 429 responses after `retry_after` seconds.

Show a product

Click Send to see the live response.

Overview

For a private AI design, they are Sign Customiser download links (/ai-design-files/{token}). Each link is stable and revocable. Each request redirects to a new short-lived download. title and description are Store product metadata and may contain customer-entered sign content, so protect keys with products:read. ProductCache history, raw node data, provider payloads, underlying upload paths, upload/contact names, upload tokens, and emails are never exposed. The operation is read-only. Unknown and foreign ids return the same 404. Remove unknown query parameters after a 422. Retry 429 responses after retry_after seconds.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: products:read

Path parameters

product_idstringpathrequired

Product id returned by the list operation.

Example: 731

Show a product

curl https://web.signcustomiser.com/api/v3/products/731 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

{
  "data": {
    "object": "product",
    "id": 731,
    "customiser_id": 42,
    "title": "Custom neon sign",
    "price_amount": 12900,
    "compare_at_amount": 14900,
    "currency": "AUD",
    "image_url": "https://cdn.example.com/products/731.png",
    "created_at": "2026-07-18T03:14:15Z",
    "updated_at": "2026-07-18T03:16:10Z",
    "description": "Made to order.",
    "width_cm": 80.5,
    "height_cm": 31.5,
    "length_cm": 2.5,
    "artwork": {
      "svg_url": "https://cdn.example.com/design.svg",
      "eps_url": "https://cdn.example.com/design.eps",
      "illustrator_pdf_url": "https://cdn.example.com/design.pdf"
    }
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/products/731",
    "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:read scope.",
  "required_scopes": [
    "products:read"
  ],
  "granted_scopes": [],
  "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"
}