smartphonechecker.co.uk

{
  "type": "object",
  "properties": {
    "dealType": {
      "type": "string",
      "description": "Deal category: new contract, SIM-free purchase (no PAYG bundle), or existing-customer upgrade.",
      "enum": [
        "contract",
        "sim_free",
        "upgrade"
      ],
      "default": "contract"
    },
    "unlimitedData": {
      "type": "boolean",
      "description": "Require an unlimited data tariff. Do not combine with minDataGb greater than zero. Not supported for SIM-free purchases.",
      "default": false
    },
    "versionId": {
      "type": "integer",
      "description": "Exact device version identifier returned by search_devices.",
      "minimum": 1
    },
    "networkBrands": {
      "type": "array",
      "description": "Advertised tariff network brand names to include, matched case-insensitively to canonical names; these can differ from the underlying carrier network.",
      "items": {
        "type": "string",
        "description": "One canonical advertised network brand name.",
        "minLength": 1,
        "maxLength": 80
      },
      "maxItems": 10,
      "uniqueItems": true
    },
    "minDataGb": {
      "type": "number",
      "description": "Minimum monthly data allowance in decimal GB (1000 MB), to a maximum of three decimal places; unlimited tariffs also qualify. Use unlimitedData=true for unlimited-only queries.",
      "minimum": 0,
      "maximum": 1000,
      "multipleOf": 0.001
    },
    "minMinutes": {
      "type": "integer",
      "description": "Minimum included monthly call minutes.",
      "minimum": 0,
      "maximum": 1000000
    },
    "maxMonthlyGbp": {
      "type": "number",
      "description": "Maximum monthly charge in GBP, to a maximum of two decimal places.",
      "minimum": 0,
      "maximum": 100000,
      "multipleOf": 0.01
    },
    "maxUpfrontGbp": {
      "type": "number",
      "description": "Maximum upfront charge in GBP, to a maximum of two decimal places.",
      "minimum": 0,
      "maximum": 100000,
      "multipleOf": 0.01
    },
    "contractMonths": {
      "type": "array",
      "description": "Allowed airtime contract lengths in months from page-one availableFilters; 1 represents a 30-day rolling contract, not a fixed long-term commitment.",
      "items": {
        "type": "integer",
        "description": "One airtime contract length in months.",
        "minimum": 1,
        "maximum": 120
      },
      "maxItems": 10,
      "uniqueItems": true
    },
    "storageGb": {
      "type": "array",
      "description": "Allowed device storage capacities in GB.",
      "items": {
        "type": "integer",
        "description": "One device storage capacity in GB.",
        "minimum": 1,
        "maximum": 16384
      },
      "maxItems": 10,
      "uniqueItems": true
    },
    "colours": {
      "type": "array",
      "description": "Device colour names, hyphenated slugs or recorded groups, case-insensitive. Exact names/slugs take precedence; otherwise a group such as Blue matches all its available variants (for example Glacier). See page-one availableFilters.colours[].name and .group; appliedFilters.colours returns resolved manufacturer names. Unknown values return INVALID_ARGUMENT; empty lists impose no restriction.",
      "items": {
        "type": "string",
        "description": "One colour name, slug or group.",
        "minLength": 1,
        "maxLength": 80
      },
      "maxItems": 10,
      "uniqueItems": true
    },
    "retailerId": {
      "type": "integer",
      "description": "Retailer ID from page-one availableFilters.retailers for the same device/dealType or simType.",
      "minimum": 1
    },
    "condition": {
      "type": "string",
      "description": "Device condition: any condition, new devices only, or refurbished devices only.",
      "enum": [
        "any",
        "new",
        "refurbished"
      ],
      "default": "any"
    },
    "cashback": {
      "type": "string",
      "description": "Tariff/deal cashback filter: any; none; automatic cashback or none; or manual redemption cashback or none. Separate device promotional cashback may remain.",
      "enum": [
        "any",
        "none",
        "automatic_or_none",
        "manual_or_none"
      ],
      "default": "any"
    },
    "networkDirectOnly": {
      "type": "boolean",
      "description": "When true, include only deals sold directly by a network rather than third-party retailers.",
      "default": false
    },
    "requires5gTariff": {
      "type": "boolean",
      "description": "When true, include only tariffs explicitly marked as supporting 5G.",
      "default": false
    },
    "freeGiftOnly": {
      "type": "boolean",
      "description": "When true, include only deals with a free gift.",
      "default": false
    },
    "sort": {
      "type": "string",
      "description": "Result order: total recorded cost or average monthly cost. For SIM-free purchases total_cost orders by purchase cost.",
      "enum": [
        "total_cost",
        "average_monthly_cost"
      ],
      "default": "total_cost"
    },
    "page": {
      "type": "integer",
      "description": "One-based results page number.",
      "minimum": 1,
      "maximum": 100,
      "default": 1
    }
  },
  "required": [
    "versionId"
  ],
  "additionalProperties": false
}