Parameter | Type | Description |
recipe_list | string | Latest URL for recipe_list method |
recipe_category_list | string | Latest URL for recipe_category_list method |
special_offer_list | string | Latest URL for special_offer_list method |
store_location_list | string | Latest URL for store_location_list method |
recipe_rating | string | Latest URL for recipe_rating method |
css | string | Latest URL for CSS file used in recipe app web view. |
iphone_download_url | string | Link to published app in Apple App Store |
android_download_url | string | Link to published app on Google Play |
landing_page | string | Latest URL for css file used in recipe app. |
theme_version | int | Theme for Recipe App |
data_version | int | Helps to utilise cache |
background_images | string | Theme for Recipe App |
background_main | string | Theme for Recipe App |
background_invisible_header | string | Theme for Recipe App |
background_empty_shopping_list | string | Theme for Recipe App |
mail_template_images | string | Theme for Recipe App. |
Parameter | Type | Description |
id | int | recipe ID |
title | string | recipe title |
description | string | recipe description |
instructions | string | how to cook as rich text HTML |
url | url | recipe location on website |
priority | int | can be used for sorting |
created | datetime | x |
modified | datetime | x |
ingredients | array |
Parameter | Type | Description |
quantity | float | how many units |
units | string | e.g. kg, tbsp, piece |
title | string | ingredient name |
notes | string | e.g. peeled, diced |
product_id | string | product unique identifier (e.g. stock keeping unit) |
group_title | string | should be grouped by this and used as a block title |
|
categories | array |
Parameter | Type | Description |
id | int | category id (category title can change, but category id will stay the same) |
parent | int | parent category ID |
priority | int | can be used for sorting |
publish | int | is visible to public? |
title | string | category title, e.g. Chrismas Recipe |
description | string | large description |
|
images | array | URLs |
thumbnails | array | URLs (may include placeholder, see thumbnail_size input paremeter) |
video | string | video URL e.g. http://vimeo.com/32329926 |
comments | array list |
Parameter | Type | Description |
content | string | actuall comment |
date | datetime | time at creation |
author | string | author name |
|
rating | array |
Parameter | Type | Description |
value | float | rating value |
votes_sum | int | sum of ratings |
voters_sum | int | sum of voters (number of people voted) |
|
serving_people | int | how many people this recipe can serve with current ingrediants quantity/units |
preparation_time | int | preparation time in minutes |
cook_time | int | cooking time in minutes |
recommended_wines | array |
Parameter | Type | Description |
id | int | x |
title | sting | x |
description | string | x |
wine_type | string | e.g. Red |
grape_variety | string | e.g. Merlot |
country | string | Country of origin, e.g. Italy |
image_url | string | URL of image location |
price_range | string | e.g. €6-€8 |
product_id | string | product unique identifier (e.g. stock keeping unit) |
|
related_offers | array list |
Parameter | Type | Description |
id | int | related offer id |
|
meal_types DEPRECATED | array list |
Course
Parameter | Type | Description |
id | int | category id |
title | string | category title |
|
Parameter | Type | Description |
format | string | Available values: json or xml |
api_key | string | identify API consumer, testing with: abcdefgh |
meal_type_id | int | DEPRECATED, course, e.g. 903 for Desserts |
category_id | int | category id, e.g. 2110 for Weekday Dinners |
product_id | string | will return recipes with ingredients having product_id |
keyword | string | will look into ingredients, recipe title and description |
ready_time | int | preparation_time + cook_time in minutes |
thumbnail_size | int | requested thumbnail size in pixels, has to be a multiple of 5, e.g. 645, not 639. (if not specified, returned URLs will include [THUMBNAIL_SIZE] placeholder instead of a value) |
Parameter | Type | Description |
id | int | recipe ID |
title | string | recipe title |
description | string | recipe description (excerpt) |
image_thumbnail DEPRECATED | string | thumbnail URL |
images | array | URLs |
thumbnails | array | URLs (may include placeholder, see thumbnail_size input paremeter) |
video | string | video URL e.g. http://vimeo.com/32329926 |
ready_time | int | preparation_time + cook_time in minutes |
meal_types DEPRECATED | array |
Course
Parameter | Type | Description |
id | int | category id |
title | string | category title |
|
categories | array |
Parameter | Type | Description |
id | int | category id (category title can change, but category id will stay the same) |
title | string | category title, e.g. Chrismas Recipe |
priority | string | can be used for sorting |
usage_count | int | number of all recipes in this category |
|
url | url | recipe location on website |
Parameter | Type | Description |
id | int | x |
title | string | offer name |
content | string | offer description |
url | string | link to offer details on website |
priority | int | can be used for sorting |
created | datetime | x |
modified | datetime | x |
images | array | list of URLs |
thumbnails | array | URLs (may include placeholder, see thumbnail_size input paremeter) |
rondel | string | e.g. e10, can be empty |
rondel_image_url | string | URL of rondel image, can be empty |
price | string | e.g. Now "€3.14" or "Details Instore" |
expiry_date | datetime | Exact time when the offer expires |
taxonomy | array |
Parameter | Type | Description |
term_id | int | x |
name | string | category name |
slug | string | for constructing URLs |
term_group | int | x |
term_order | int | x |
usage_count | int | how many other offers are in the same group |
description | string | description of the category |
|
product_id | string | product unique identifier (e.g. stock keeping unit) |
group_id | int | offers should be grouped by this. Returns NULL if the offer is not groupped. |
group_title | string | title for the group |