Products

List products

Copy page

List the authenticated Store's modern products in descending creation order. Legacy ProductCache rows are excluded because they have a separate, potentially colliding identity.

GET/api/v3/products

List products

List the authenticated Store's modern products in descending creation order. Legacy ProductCache rows are excluded because they have a separate, potentially colliding identity. Each item contains integer minor-unit prices, the Store currency when valid, and ISO 8601 UTC timestamps. This read-only operation requires `products:read` and is safe to retry. A product `title` may contain customer-entered sign content, so protect API keys with this scope accordingly. Follow `links.next` while `pagination.has_more` is true. Cursors are opaque and must be returned unchanged. No filters are supported. A 401 means the API key is missing or invalid, 403 means it lacks the scope, 422 means a parameter or cursor is invalid, and 429 should be retried after the response's `retry_after` seconds.

List products

Click Send to see the live response.

Overview

Each item contains integer minor-unit prices, the Store currency when valid, and ISO 8601 UTC timestamps. This read-only operation requires products:read and is safe to retry. A product title may contain customer-entered sign content, so protect API keys with this scope accordingly. Follow links.next while pagination.has_more is true. Cursors are opaque and must be returned unchanged. No filters are supported. A 401 means the API key is missing or invalid, 403 means it lacks the scope, 422 means a parameter or cursor is invalid, and 429 should be retried after the response's retry_after seconds.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: products:read

Query parameters

limitstringquery

Products per page, from 1 to 100. Defaults to 20.

Example: 2

List products

curl https://web.signcustomiser.com/api/v3/products?limit=2&cursor= \
  --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"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/products",
    "documentation": "https://www.signcustomiser.com/help/api/",
    "next": null
  },
  "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/invalid_parameter",
  "title": "Invalid query parameter",
  "status": 422,
  "code": "invalid_parameter",
  "detail": "The limit parameter must be an integer between 1 and 100.",
  "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"
}