{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/bol-com/json-schema/bol-com-retailer-information-response-schema.json",
  "title": "RetailerInformationResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bol-com-retailers-api-openapi.yml#/components/schemas/RetailerInformationResponse",
  "required": [
    "companyName",
    "displayName",
    "kvkNumber",
    "registrationDate",
    "retailerId",
    "vatNumber"
  ],
  "type": "object",
  "properties": {
    "retailerId": {
      "type": "string",
      "description": "The Id of the retailer which information belongs to."
    },
    "displayName": {
      "type": "string",
      "description": "The name of the retailer visible on bol.com"
    },
    "companyName": {
      "type": "string",
      "description": "The company name of the retailer."
    },
    "vatNumber": {
      "type": "string",
      "description": "The VAT number of the retailer."
    },
    "kvkNumber": {
      "type": [
        "string",
        "null"
      ],
      "description": "The KVK number of the retailer."
    },
    "registrationDate": {
      "type": "string",
      "description": "A date representing the registration date for the retailer within bol.com"
    },
    "topRetailer": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Indication of retailer's being the top seller."
    },
    "ratingMethod": {
      "type": [
        "string",
        "null"
      ],
      "description": "An identifier that identifies if the rating is calculated over the past three months or on all reviews for the retailer.",
      "enum": [
        "ALL_REVIEWS",
        "THREE_MONTHS",
        null
      ]
    },
    "retailerRating": {
      "allOf": [
        {
          "$ref": "#/$defs/RetailerRating"
        }
      ]
    },
    "retailerReview": {
      "allOf": [
        {
          "$ref": "#/$defs/RetailerReview"
        }
      ]
    }
  },
  "$defs": {
    "RetailerRating": {
      "required": [
        "retailerRating"
      ],
      "type": "object",
      "properties": {
        "retailerRating": {
          "maximum": 10,
          "minimum": 1,
          "type": "number",
          "description": "General rating of the retailer.",
          "format": "double"
        },
        "productInformationRating": {
          "maximum": 10,
          "minimum": 1,
          "type": [
            "number",
            "null"
          ],
          "description": "Product rating of the retailer.",
          "format": "double"
        },
        "deliveryTimeRating": {
          "maximum": 10,
          "minimum": 1,
          "type": [
            "number",
            "null"
          ],
          "description": "Delivery rating of the retailer.",
          "format": "double"
        },
        "shippingRating": {
          "maximum": 10,
          "minimum": 1,
          "type": [
            "number",
            "null"
          ],
          "description": "Shipping rating of the retailer.",
          "format": "double"
        },
        "serviceRating": {
          "maximum": 10,
          "minimum": 1,
          "type": [
            "number",
            "null"
          ],
          "description": "Service rating of the retailer.",
          "format": "double"
        }
      },
      "description": "Rating on different aspects all being one decimal precision."
    },
    "RetailerReview": {
      "required": [
        "negativeReviewCount",
        "neutralReviewCount",
        "positiveReviewCount",
        "totalReviewCount"
      ],
      "type": "object",
      "properties": {
        "totalReviewCount": {
          "minimum": 0,
          "type": "integer",
          "description": "The total amount of customer review during that rating method period.",
          "format": "int32"
        },
        "approvalPercentage": {
          "maximum": 10,
          "minimum": 0,
          "type": [
            "integer",
            "null"
          ],
          "description": "The percentage of the amount of customer that rated the retailer either neutral or positive during the rating method period.",
          "format": "int32"
        },
        "positiveReviewCount": {
          "minimum": 0,
          "type": "integer",
          "description": "The amount of positive customer reviews during that rating method period.",
          "format": "int32"
        },
        "neutralReviewCount": {
          "minimum": 0,
          "type": "integer",
          "description": "The amount of neutral customer reviews during that rating method period.",
          "format": "int32"
        },
        "negativeReviewCount": {
          "minimum": 0,
          "type": "integer",
          "description": "The amount of negative customer reviews during that rating method period.",
          "format": "int32"
        }
      }
    }
  }
}