Raw schema
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "What the customer wants in their own words, for example \"strong breakfast tea\", \"Yorkshire Gold\" or \"something for bedtime\". Leave out to browse with filters only.",
"maxLength": 200
},
"kind": {
"type": "string",
"enum": [
"black",
"green",
"white",
"oolong",
"herbal",
"fruit",
"rooibos",
"chai",
"matcha",
"earl_grey",
"coffee",
"hot_chocolate"
],
"description": "Type of drink."
},
"caffeine": {
"type": "string",
"enum": [
"caffeinated",
"decaf",
"caffeine_free",
"low_or_none"
],
"description": "Caffeine: caffeinated, decaf (caffeine taken out), caffeine_free (none to begin with, such as rooibos and most herbal teas) or low_or_none (decaf or caffeine free)."
},
"with_milk": {
"type": "boolean",
"description": "Only products that suit milk."
},
"format": {
"type": "string",
"enum": [
"tea_bags",
"loose_leaf",
"instant",
"pods_or_capsules",
"sachets",
"ground",
"whole_beans",
"powder",
"coffee_bags",
"ready_to_drink"
],
"description": "How it comes: tea_bags, loose_leaf, instant, pods_or_capsules, sachets, ground or whole_beans (coffee), powder, coffee_bags or ready_to_drink."
},
"time_of_day": {
"type": "string",
"enum": [
"morning",
"afternoon",
"evening",
"bedtime"
],
"description": "When it suits best: morning, afternoon, evening or bedtime."
},
"strength": {
"type": "string",
"enum": [
"light",
"medium",
"strong"
],
"description": "How strong the cup is: light, medium or strong."
},
"organic": {
"type": "boolean",
"description": "Only organic products."
},
"fairtrade": {
"type": "boolean",
"description": "Only Fairtrade products."
},
"vegan": {
"type": "boolean",
"description": "Only products labelled vegan."
},
"iced": {
"type": "boolean",
"description": "Suits iced tea or cold brew."
},
"max_price": {
"type": "number",
"description": "Highest pack price in pounds."
},
"max_price_per_cup_pence": {
"type": "number",
"description": "Highest price per cup in pence."
},
"sort": {
"type": "string",
"enum": [
"best_match",
"cheapest_per_cup",
"price_low_to_high",
"price_high_to_low",
"strongest"
],
"description": "Order of results: best_match (the default), cheapest_per_cup, price_low_to_high, price_high_to_low or strongest."
},
"limit": {
"type": "integer",
"description": "How many products to return (default 6).",
"minimum": 1,
"maximum": 12
},
"include_out_of_stock": {
"type": "boolean",
"description": "Also include products that are out of stock (they are left out by default)."
}
},
"additionalProperties": false
}