{
  "openapi": "3.0.4",
  "info": {
    "title": "Reshift Product Catalog API",
    "description": "Read-only access to the Reshift (Kieskeurig) product catalog: products, specifications, current prices with clickout links, price history, shops and categories.\n\nNew here? Start with the [quickstart](/guides/quickstart/). Every request needs an API key in the `Authorization` header, sent as the bare key without a `Bearer` prefix. See [Authentication](/guides/authentication/).\n\nConventions: JSON with camelCase properties, UTF-8, dates in ISO 8601 UTC, amounts in euros, enum values in UPPER_SNAKE_CASE. List endpoints are paged with `Skip` and `Limit` and return the total in the `X-Total-Count` header.",
    "version": "1.0"
  },
  "paths": {
    "/v1/Categories": {
      "get": {
        "tags": [
          "Categories"
        ],
        "summary": "Gets a list of all categories",
        "parameters": [
          {
            "name": "Skip",
            "in": "query",
            "description": "Skips X amount of categories",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Limit",
            "in": "query",
            "description": "Limits request to X amount of categories (max 100)",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Category"
                  }
                }
              }
            },
            "headers": {
              "X-Total-Count": {
                "schema": {
                  "type": "integer"
                },
                "description": "Total number of results for this query."
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "Legacy flat list of categories. Prefer `GET /v1/CategoryTreeNodes`.\n\n**Required role:** `Category`"
      }
    },
    "/v1/CategoryTreeNodes": {
      "get": {
        "tags": [
          "CategoryTreeNodes"
        ],
        "summary": "Gets the full category tree recursively from all roots, including ranking.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CategoryTreeNode"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "The full category tree. Use a node `slug` as `CategoryTreeNodeSlug` on `GET /v1/Products`. Names are in Dutch.\n\n**Required role:** `Category`"
      }
    },
    "/v1/Products": {
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Gets a list of products",
        "parameters": [
          {
            "name": "Query",
            "in": "query",
            "description": "Search for products",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Brands",
            "in": "query",
            "description": "Match on brand names (max 10)",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "ProductCodes",
            "in": "query",
            "description": "Match on product codes (max 10)",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "Ean",
            "in": "query",
            "description": "Matches on possible EAN aliases of product",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "KieskeurigId",
            "in": "query",
            "description": "Matches on Kieskeurig ID's (max 50)",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "Shops",
            "in": "query",
            "description": "Match on shop ids: products that have a price at one of these shops (max 10)",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "CategoryTreeNodeSlug",
            "in": "query",
            "description": "Filters products belonging to a category tree node. Accepts the full slug path\n(as returned in a product's categoryTreeNodeSlug, e.g. \"elektronica/tv-en-beeld/televisie\")\nor its trailing segment (e.g. \"televisie\").",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "OrderBy",
            "in": "query",
            "description": "Order by",
            "schema": {
              "$ref": "#/components/schemas/ProductSortType"
            }
          },
          {
            "name": "MinPrice",
            "in": "query",
            "description": "Minimal price of the lowest price of a product",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "MaxPrice",
            "in": "query",
            "description": "Maximal price of the lowest price of a product",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "SortDirection",
            "in": "query",
            "description": "Direction to order in",
            "schema": {
              "$ref": "#/components/schemas/SortDirection"
            }
          },
          {
            "name": "AffiliateId",
            "in": "query",
            "description": "Affiliate ID to be encoded in click out url. If no Affiliate ID is specified the first registered Affiliate ID is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Skip",
            "in": "query",
            "description": "Skips X amount of products",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Limit",
            "in": "query",
            "description": "Limits request to X amount of products (max 100)",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ProductListing"
                  }
                }
              }
            },
            "headers": {
              "X-Total-Count": {
                "schema": {
                  "type": "integer"
                },
                "description": "Total number of results for this query."
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "Search and filter products. Results are paged: use `Skip` and `Limit` (max 100) and read the total from `X-Total-Count`.\n\n`minPrice` and `priceAmount` in the results are calculated over all shops in your market, including shops excluded for your key. See [Prices and shops](/guides/prices-and-shops/#excluded-shops).\n\n**Required role:** `Product`"
      }
    },
    "/v1/Products/{id}": {
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Gets a single detailed product",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID, Kieskeurig ID or UID of a product",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "AffiliateId",
            "in": "query",
            "description": "Affiliate ID to be encoded in click out url. If no Affiliate ID is specified the first registered Affiliate ID is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Refurbished",
            "in": "query",
            "description": "Parameter to include refurbished prices in the response. (default: true)",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Product"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "Product details. `id` accepts the product `id` (GUID), the `kieskeurigId` or the `uid`.\n\nWith the `Specifications` role the response also contains `specifications`.\n\n**Required role:** `Product`"
      }
    },
    "/v1/Products/{id}/Specifications": {
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Gets detailed specifications for a single product",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID, Kieskeurig ID or UID of a product",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SpecificationDto"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "All specifications of a product as a flat list with group, key, value and unit.\n\n**Required role:** `Specifications`"
      }
    },
    "/v1/Products/{id}/History": {
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Gets all price history for a single product",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID, Kieskeurig ID or UID of a product",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "SortDirection",
            "in": "query",
            "description": "Changes the sort direction of the result",
            "schema": {
              "$ref": "#/components/schemas/SortDirection"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/HistoryPrice"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "Historic price points for a product in your market.\n\n**Required role:** `History`"
      }
    },
    "/v1/Products/{id}/Prices": {
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Gets ordered prices for a single product",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID, Kieskeurig ID or UID of a product",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "AffiliateId",
            "in": "query",
            "description": "Affiliate ID to be encoded in click out url. If no Affiliate ID is specified the first registered Affiliate ID is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Refurbished",
            "in": "query",
            "description": "Parameter to include refurbished prices in the response. (default: true)",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Price"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "Current offers for a product, ordered as on Kieskeurig, each with a clickout `link`.\n\nReturns **404** when the product has no current offers in your market. That is a normal state, not an error: products go in and out of stock. Responses are cached for up to 5 minutes, so polling one product more often than that returns the same data.\n\n**Required role:** `Price`"
      }
    },
    "/v1/Shops": {
      "get": {
        "tags": [
          "Shops"
        ],
        "summary": "Gets a list of available shops",
        "parameters": [
          {
            "name": "Skip",
            "in": "query",
            "description": "Skips X amount of product",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Limit",
            "in": "query",
            "description": "Limits request to X amount of products",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ShopDto"
                  }
                }
              }
            },
            "headers": {
              "X-Total-Count": {
                "schema": {
                  "type": "integer"
                },
                "description": "Total number of results for this query."
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "Shops in the catalog, with review score and quality marks. Paged with `Skip` and `Limit`.\n\n**Required role:** none (any valid key)"
      }
    },
    "/v1/Shops/{shopId}/merchant": {
      "get": {
        "tags": [
          "Shops"
        ],
        "summary": "Gets a Google Merchant Center compatible price feed for a shop",
        "parameters": [
          {
            "name": "shopId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "All current offers of one shop as a Google Merchant Center compatible XML feed.\n\n**Required role:** `MerchantFeed`"
      }
    },
    "/v1/Shops/{shopId}/Offers": {
      "get": {
        "tags": [
          "Shops"
        ],
        "summary": "Gets the current offers of a shop, ordered by EAN",
        "parameters": [
          {
            "name": "shopId",
            "in": "path",
            "description": "ID of the shop",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Skip",
            "in": "query",
            "description": "Skips X amount of offers",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Limit",
            "in": "query",
            "description": "Limits request to X amount of offers (max 1000)",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "AffiliateId",
            "in": "query",
            "description": "Affiliate ID to be encoded in click out url. If no Affiliate ID is specified the first registered Affiliate ID is used.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ShopOffer"
                  }
                }
              }
            },
            "headers": {
              "X-Total-Count": {
                "schema": {
                  "type": "integer"
                },
                "description": "Total number of results for this query."
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "description": "All current offers of one shop, ordered by EAN, each with a clickout URL. Paged with `Skip` and `Limit` (max 1000). Returns 404 for a shop that is excluded for your key.\n\n**Required role:** `Price`"
      }
    }
  },
  "components": {
    "schemas": {
      "Category": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "productCode": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CategoryTreeNode": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "nullable": true,
            "description": "Slug of the node. Use the full path or the last segment as `CategoryTreeNodeSlug`."
          },
          "name": {
            "type": "string",
            "nullable": true,
            "description": "Display name (Dutch)."
          },
          "children": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CategoryTreeNode"
            },
            "nullable": true,
            "description": "Child nodes."
          }
        },
        "additionalProperties": false
      },
      "Certificate": {
        "type": "object",
        "properties": {
          "certificateType": {
            "$ref": "#/components/schemas/CertificateType"
          },
          "grantedOn": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "score": {
            "type": "number",
            "format": "double",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CertificateType": {
        "enum": [
          "TEST_PANEL",
          "BEST_REVIEWED",
          "CONSUMENTEN_BOND_TEST",
          "CONSUMENTEN_BOND_BUY",
          "DUURTEST",
          "BEST_REVIEWED_YEARLY"
        ],
        "type": "string"
      },
      "DeliveryCode": {
        "enum": [
          "ONE_DAY",
          "TWO_DAYS",
          "THREE_DAYS",
          "FOUR_DAYS",
          "FIVE_DAYS",
          "MORE_DAYS",
          "PRE_ORDER"
        ],
        "type": "string"
      },
      "Family": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "key": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "HistoryPrice": {
        "type": "object",
        "properties": {
          "ean": {
            "type": "string",
            "nullable": true,
            "description": "EAN the price was recorded for."
          },
          "amount": {
            "type": "number",
            "format": "double",
            "description": "Price in euros."
          },
          "date": {
            "type": "string",
            "format": "date-time",
            "description": "Date of the price point (UTC)."
          }
        },
        "additionalProperties": false
      },
      "Price": {
        "type": "object",
        "properties": {
          "shop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Shop"
              }
            ],
            "description": "The shop making the offer."
          },
          "amount": {
            "type": "number",
            "format": "double",
            "description": "Total price in euros including delivery cost."
          },
          "amountBare": {
            "type": "number",
            "format": "double",
            "description": "Price in euros excluding delivery cost."
          },
          "deliveryCost": {
            "type": "number",
            "format": "double",
            "description": "Delivery cost in euros."
          },
          "link": {
            "type": "string",
            "nullable": true,
            "description": "Clickout URL. Send real user clicks through this URL unchanged: it carries your affiliate id and is how clicks and sales are attributed to you."
          },
          "secondaryCtaLink": {
            "type": "string",
            "nullable": true,
            "description": "Optional second clickout URL to a specific page at the shop, such as a form to request a discount. Null for most offers. Like `link`, it carries your affiliate id; use it unchanged."
          },
          "textAd": {
            "type": "string",
            "nullable": true,
            "description": "Short promotional text supplied by the shop, such as delivery or return terms. Parts can be separated by ` | `. In Dutch."
          },
          "label": {
            "type": "string",
            "nullable": true,
            "description": "Price label from the shop’s feed, when provided."
          },
          "reseller": {
            "type": "string",
            "nullable": true,
            "description": "Name of the actual seller for marketplace offers, when known."
          },
          "productDescription": {
            "type": "string",
            "nullable": true,
            "description": "Description from the shop’s feed. Truncated to 255 characters and may contain HTML, possibly with unclosed tags. Strip HTML before display."
          },
          "deliveryText": {
            "type": "string",
            "nullable": true,
            "description": "Delivery time as given by the shop, as free text."
          },
          "deliveryCode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeliveryCode"
              }
            ],
            "description": "Normalized delivery time. Null when unknown."
          }
        },
        "additionalProperties": false
      },
      "Product": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Stable product id (GUID). Use this as your primary key."
          },
          "kieskeurigId": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Numeric product id as used on kieskeurig.nl. Not every product has one."
          },
          "uid": {
            "type": "string",
            "nullable": true,
            "description": "Legacy product id. Accepted as `id` in the product endpoints."
          },
          "title": {
            "type": "string",
            "nullable": true,
            "description": "Display title."
          },
          "type": {
            "type": "string",
            "nullable": true,
            "description": "Model or type designation."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "Long description. Can contain HTML; formatting differs per source, so sanitize before rendering."
          },
          "summary": {
            "type": "string",
            "nullable": true,
            "description": "Short summary."
          },
          "brand": {
            "type": "string",
            "nullable": true,
            "description": "Brand name."
          },
          "productCode": {
            "type": "string",
            "nullable": true,
            "description": "Manufacturer product code (MPN)."
          },
          "link": {
            "type": "string",
            "nullable": true,
            "description": "URL of the product page on kieskeurig.nl."
          },
          "aliases": {
            "uniqueItems": true,
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true,
            "description": "Alternative identifiers of the product, such as EANs."
          },
          "media": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true,
            "description": "Image URLs on media.reshift.nl. Add `?w=` and/or `?h=` for resized copies."
          },
          "specifications": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              },
              "nullable": true
            },
            "nullable": true,
            "description": "Specifications as group → name → value, with the unit included in the value and multiple values joined by `, `. Only present with the `Specifications` role."
          },
          "certificates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Certificate"
            },
            "nullable": true,
            "description": "Awards and test results, such as Consumentenbond test results."
          },
          "family": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Family"
              }
            ],
            "description": "Product family that groups variants of the same model."
          },
          "series": {
            "nullable": true,
            "description": "Always null. Kept for backwards compatibility."
          },
          "categoryTreeNodeSlug": {
            "type": "string",
            "nullable": true,
            "description": "Slug path of the category the product belongs to."
          }
        },
        "additionalProperties": false
      },
      "ProductListing": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Stable product id (GUID). Use this as your primary key."
          },
          "kieskeurigId": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Numeric product id as used on kieskeurig.nl. Not every product has one."
          },
          "uid": {
            "type": "string",
            "nullable": true,
            "description": "Legacy product id. Accepted as `id` in the product endpoints."
          },
          "title": {
            "type": "string",
            "nullable": true,
            "description": "Display title."
          },
          "brand": {
            "type": "string",
            "nullable": true,
            "description": "Brand name."
          },
          "type": {
            "type": "string",
            "nullable": true,
            "description": "Model or type designation."
          },
          "thumbnail": {
            "type": "string",
            "nullable": true,
            "description": "Product image URL on media.reshift.nl. Add `?w=` and/or `?h=` to get a resized copy. See [Images and content](/guides/images-and-content/)."
          },
          "priceAmount": {
            "type": "integer",
            "format": "int32",
            "description": "Number of offers for this product in your market, including shops excluded for your key."
          },
          "minPrice": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Lowest current price in euros in your market, including shops excluded for your key. Null when there are no offers."
          },
          "aliases": {
            "uniqueItems": true,
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true,
            "description": "Alternative identifiers of the product, such as EANs."
          },
          "certificates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Certificate"
            },
            "nullable": true,
            "description": "Awards and test results, such as Consumentenbond test results."
          },
          "family": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Family"
              }
            ],
            "description": "Product family that groups variants of the same model."
          },
          "series": {
            "nullable": true,
            "description": "Always null. Kept for backwards compatibility."
          },
          "categoryTreeNodeSlug": {
            "type": "string",
            "nullable": true,
            "description": "Slug path of the category the product belongs to."
          }
        },
        "additionalProperties": false
      },
      "ProductSortType": {
        "enum": [
          "MOST_VIEWED",
          "REVIEW_SCORE",
          "PRICE",
          "DISCOUNT",
          "EXPORT_IMPORTANCE",
          "RANKING",
          "RANKING_SALES",
          "BEST_SCORE"
        ],
        "type": "string"
      },
      "Shop": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Shop id. Shop ids are specific to your market: the same retailer can have a different id for another key."
          },
          "billingCode": {
            "type": "string",
            "nullable": true,
            "description": "Legacy internal code. Often empty; do not use it to identify shops."
          },
          "name": {
            "type": "string",
            "nullable": true,
            "description": "Shop name."
          },
          "logo": {
            "type": "string",
            "nullable": true,
            "description": "Logo URL."
          },
          "website": {
            "type": "string",
            "nullable": true,
            "description": "Absolute URL of the shop’s website, for example `https://www.example.nl/`. Null when unknown."
          },
          "marketplace": {
            "type": "boolean",
            "description": "True when the shop is a marketplace (sellers other than the shop itself)."
          },
          "officialDealer": {
            "type": "boolean",
            "description": "True when the shop is an official dealer for the brand."
          }
        },
        "additionalProperties": false
      },
      "ShopDto": {
        "type": "object",
        "properties": {
          "shopId": {
            "type": "integer",
            "format": "int32",
            "description": "Shop id, as used in `Shops` filters and in `shop.id` of a price."
          },
          "name": {
            "type": "string",
            "nullable": true,
            "description": "Shop name."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ShopType"
              }
            ],
            "description": "Kind of shop."
          },
          "billingCode": {
            "type": "string",
            "nullable": true,
            "description": "Legacy internal code. Often empty; do not use it to identify shops."
          },
          "website": {
            "type": "string",
            "nullable": true,
            "description": "Absolute URL of the shop’s website, for example `https://www.example.nl/`. Null when unknown."
          },
          "reviewScore": {
            "type": "number",
            "format": "double",
            "description": "Average customer review score."
          },
          "reviewAmount": {
            "type": "integer",
            "format": "int32",
            "description": "Number of customer reviews."
          },
          "beCommerce": {
            "type": "boolean",
            "nullable": true,
            "description": "Shop carries the BeCommerce quality mark."
          },
          "thuiswinkel": {
            "type": "boolean",
            "nullable": true,
            "description": "Shop carries the Thuiswinkel Waarborg quality mark."
          },
          "kieskeurigQualityMark": {
            "type": "boolean",
            "nullable": true,
            "description": "Shop carries the Kieskeurig quality mark."
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Internal record id. Use `shopId` instead."
          }
        },
        "additionalProperties": false
      },
      "ShopOffer": {
        "type": "object",
        "properties": {
          "ean": {
            "type": "string",
            "nullable": true,
            "description": "EAN of the offered product."
          },
          "kieskeurigId": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Kieskeurig product id when the offer is matched to a catalog product; otherwise null."
          },
          "title": {
            "type": "string",
            "nullable": true,
            "description": "Product name from the shop’s feed."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "Description from the shop’s feed. May be truncated and may contain HTML."
          },
          "brand": {
            "type": "string",
            "nullable": true,
            "description": "Brand from the shop’s feed."
          },
          "imageLink": {
            "type": "string",
            "nullable": true,
            "description": "Image URL from the shop’s feed."
          },
          "amount": {
            "type": "number",
            "format": "double",
            "description": "Total price in euros including delivery cost."
          },
          "amountBare": {
            "type": "number",
            "format": "double",
            "description": "Price in euros excluding delivery cost."
          },
          "deliveryCost": {
            "type": "number",
            "format": "double",
            "description": "Delivery cost in euros."
          },
          "deliveryText": {
            "type": "string",
            "nullable": true,
            "description": "Delivery time as given by the shop, as free text."
          },
          "deliveryCode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeliveryCode"
              }
            ],
            "description": "Normalized delivery time."
          },
          "clickoutUrl": {
            "type": "string",
            "nullable": true,
            "description": "Clickout URL carrying your affiliate id. Send real user clicks through it unchanged."
          }
        },
        "additionalProperties": false
      },
      "ShopType": {
        "enum": [
          "TRADITIONAL",
          "MARKETPLACE",
          "REFURBISHED",
          "MISCELLANEOUS"
        ],
        "type": "string"
      },
      "SortDirection": {
        "enum": [
          "ASCENDING",
          "DESCENDING"
        ],
        "type": "string"
      },
      "SpecificationDto": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "nullable": true,
            "description": "Specification name."
          },
          "value": {
            "type": "string",
            "nullable": true,
            "description": "Specification value."
          },
          "group": {
            "type": "string",
            "nullable": true,
            "description": "Specification group, for display."
          },
          "suffix": {
            "type": "string",
            "nullable": true,
            "description": "Unit, such as `cm` or `W`."
          },
          "specificationId": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Id of the specification definition. Null for unmapped specifications."
          },
          "deprecatedUniqueName": {
            "type": "string",
            "nullable": true,
            "description": "Deprecated. Do not use."
          }
        },
        "additionalProperties": false
      },
      "Error": {
        "type": "object",
        "properties": {
          "refId": {
            "type": "string",
            "description": "Reference id of this error. Include it when you contact us."
          },
          "errorCode": {
            "type": "string",
            "description": "Error code, such as `4000` (validation) or `4040` (not found)."
          },
          "errorMessage": {
            "type": "string",
            "description": "Human-readable message."
          },
          "errorDetails": {
            "type": "object",
            "description": "Validation errors per parameter: parameter name → error code → message.",
            "additionalProperties": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            }
          }
        },
        "example": {
          "refId": "3f1c0d9a8b7e4c2d9f6a5b4c3d2e1f00",
          "errorCode": "4000",
          "errorMessage": "Validation error(s)",
          "errorDetails": {
            "Limit": {
              "4004": "Limit must be smaller than or equal to 100"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Your API key, sent as the bare value of the `Authorization` header. Do not add a `Bearer` prefix."
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Invalid parameters. `errorDetails` lists the problem per parameter.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Missing or unknown API key."
      },
      "Forbidden": {
        "description": "Your key does not have the role this endpoint requires."
      },
      "NotFound": {
        "description": "Not found, or not available for your key.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "Rate limit reached. Wait and retry; honour `Retry-After` when present.",
        "headers": {
          "Retry-After": {
            "schema": {
              "type": "integer"
            },
            "description": "Seconds to wait before retrying."
          }
        }
      },
      "ServerError": {
        "description": "Unexpected server error. Retry with backoff; contact us with the `refId` if it persists.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "ApiKey": []
    }
  ],
  "servers": [
    {
      "url": "https://productapiext.reshift.nl",
      "description": "Production"
    }
  ],
  "tags": [
    {
      "name": "Products",
      "description": "Search the catalog, fetch product details, specifications, current prices and price history."
    },
    {
      "name": "Shops",
      "description": "The shops available to your key, their current offers and a Google Merchant Center compatible feed per shop."
    },
    {
      "name": "CategoryTreeNodes",
      "description": "The category tree used to browse and filter products."
    },
    {
      "name": "Categories",
      "description": "Legacy flat category list."
    }
  ]
}
