ProductPage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/clickwise-net/json-schema/clickwise-net-product-page-schema.json",
  "title": "ProductPage",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clickwise-net-publisher-openapi.yml#/components/schemas/ProductPage",
  "type": "object",
  "properties": {
    "products": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Product"
      }
    },
    "count": {
      "type": "integer",
      "description": "Products on this page."
    },
    "total": {
      "type": "integer",
      "description": "Search matches before per-product link checks, at most 1000."
    },
    "total_exact": {
      "type": "boolean",
      "description": "False when total reached the 1000 cap."
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "next_offset": {
      "type": [
        "integer",
        "null"
      ]
    },
    "freshness_hours": {
      "type": "integer"
    },
    "servable_programs": {
      "type": "integer",
      "description": "Only on an empty first page: your programs that may serve products with stock in the searched countries."
    },
    "empty_reason": {
      "type": "string",
      "enum": [
        "no_programs_in_country",
        "no_feed_permission",
        "no_match"
      ],
      "description": "Only on an empty first page: no approved program has stock in that country; some do but none may serve its product feed to you; or your programs may, and the query or filters matched nothing."
    }
  },
  "$defs": {
    "Product": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "gtin": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "price": {
          "type": "string",
          "description": "Decimal string in currency."
        },
        "currency": {
          "type": "string"
        },
        "image": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "Clickwise link tracked to the caller."
        },
        "merchant": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "name": {
              "type": "string"
            },
            "domain": {
              "type": [
                "string",
                "null"
              ],
              "description": "The merchant's public website domain (no link), e.g. tooled-up.com."
            }
          }
        },
        "availability": {
          "type": "string",
          "enum": [
            "in_stock",
            "out_of_stock",
            "preorder",
            "backorder"
          ]
        },
        "country": {
          "type": "string"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        },
        "brand": {
          "type": [
            "string",
            "null"
          ]
        },
        "category": {
          "type": [
            "string",
            "null"
          ]
        },
        "regular_price": {
          "type": [
            "string",
            "null"
          ],
          "description": "Merchant's list price as a decimal string, only when above price."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "Plain text, at most 500 characters."
        },
        "size": {
          "type": [
            "string",
            "null"
          ]
        },
        "color": {
          "type": [
            "string",
            "null"
          ]
        },
        "group_id": {
          "type": "string",
          "description": "Shared by the sizes of one model and colour: the feed item_group_id when present, else brand + title without the size + colour, normalised (a heuristic)."
        },
        "sizes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Only with group=1: the sizes in stock in this group."
        },
        "rules": {
          "type": "array",
          "description": "The program's rules that bind this offer (the brand's conditions, the channels it denies and its program flags), as a key and an English text: follow them when you promote it.",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "text": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}