Available API methods:

Resources

GET /api/v1.1/resources

Returns list of resources. This is used in recipe app. Make Example Call

Request

parametertypedescription
formatstringAvailable values: json or xml
api_keystringidentify API consumer, testing with: abcdefgh

Response

parametertypedescription
recipe_liststringLatest URL for recipe_list method
recipe_category_liststringLatest URL for recipe_category_list method
special_offer_liststringLatest URL for special_offer_list method
store_location_liststringLatest URL for store_location_list method
recipe_ratingstringLatest URL for recipe_rating method
cssstringLatest URL for CSS file used in recipe app web view.
iphone_download_urlstringLink to published app in Apple App Store
android_download_urlstringLink to published app on Google Play
landing_pagestringLatest URL for css file used in recipe app.
theme_versionintTheme for Recipe App
data_versionintHelps to utilise cache
background_imagesstringTheme for Recipe App
background_mainstringTheme for Recipe App
background_invisible_headerstringTheme for Recipe App
background_empty_shopping_liststringTheme for Recipe App
mail_template_imagesstringTheme for Recipe App.

Recipe list

GET /api/v1.1/recipe_list

Returns list of recipes. Make Example Call

Request

parametertypedescription
formatstringAvailable values: json or xml
api_keystringidentify API consumer, testing with: abcdefgh

Response

Array where each item is recipe_detail


Recipe detail

GET /api/v1.1/recipe_detail

Returns detail of single recipe. Make Example Call

Request

parametertypedescription
formatstringAvailable values: json or xml
api_keystringidentify API consumer, testing with: abcdefgh
recipe_idintrecipe ID, e.g. 1

Response

parametertypedescription
idintrecipe ID
titlestringrecipe title
descriptionstringrecipe description
instructionsstringhow to cook as rich text HTML
urlurlrecipe location on website
priorityintcan be used for sorting
createddatetimex
modifieddatetimex
ingredientsarray
parametertypedescription
quantityfloathow many units
unitsstringe.g. kg, tbsp, piece
titlestringingredient name
notesstringe.g. peeled, diced
product_idstringproduct unique identifier (e.g. stock keeping unit)
group_titlestringshould be grouped by this and used as a block title
categoriesarray
parametertypedescription
idintcategory id (category title can change, but category id will stay the same)
titlestringcategory title, e.g. Chrismas Recipe
priorityintcan be used for sorting
usage_countintnumber of all recipes in this category
imagesarrayURLs
videointVimeo video ID, e.g. 32329926 can create URL http://vimeo.com/32329926
commentsarray list
parametertypedescription
contentstringactuall comment
datedatetimetime at creation
authorstringauthor name
ratingarray
parametertypedescription
valuefloatrating value
votes_sumintsum of ratings
voters_sumintsum of voters (number of people voted)
serving_peopleinthow many people this recipe can serve with current ingrediants quantity/units
preparation_timeintpreparation time in minutes
cook_timeintcooking time in minutes
recommended_winesarray
parametertypedescription
idintx
titlestingx
descriptionstringx
wine_typestringe.g. Red
grape_varietystringe.g. Merlot
countrystringCountry of origin, e.g. Italy
image_urlstringURL of image location
price_rangestringe.g. €6-€8
product_idstringproduct unique identifier (e.g. stock keeping unit)
related_offersarray list
parametertypedescription
idintrelated offer id
meal_typesarray list Course
parametertypedescription
idintcategory id
titlestringcategory title

Recipe search

GET /api/v1.1/recipe_search

Search for recipes. We'll return list of recipe IDs. Make Example Call

Request

parametertypedescription
formatstringAvailable values: json or xml
api_keystringidentify API consumer, testing with: abcdefgh
meal_type_idintcourse, e.g. 903 for Desserts
category_idintcategory id, e.g. 2110 for Weekday Dinners
product_idstringwill return recipes with ingredients having product_id
keywordstringwill look into ingredients, recipe title and description
ready_timeintpreparation_time + cook_time in minutes

Response

parametertypedescription
idintrecipe ID
titlestringrecipe title
descriptionstringrecipe description (excerpt)
image_thumbnailstringthumbnail URL
ready_timeintpreparation_time + cook_time in minutes
meal_typesarray Course
parametertypedescription
idintcategory id
titlestringcategory title
categoriesarray
parametertypedescription
idintcategory id (category title can change, but category id will stay the same)
titlestringcategory title, e.g. Chrismas Recipe
prioritystringcan be used for sorting
usage_countintnumber of all recipes in this category
urlurlrecipe location on website

Recipe meal type list

GET /api/v1.1/recipe_meal_type_list

Returns list of meal types. Make Example Call

Request

parametertypedescription
formatstringAvailable values: json or xml
api_keystringidentify API consumer, testing with: abcdefgh

Response

parametertypedescription
idintx
titlestringcourse name
descriptionstringcategory description excerpt
image_thumbnailstringcategory thumbnail URL
priorityintcan be used for sorting
usage_countinthow many recipes are in meal type

Recipe category list

GET /api/v1.1/recipe_category_list

Returns list of recipe categories. Make Example Call

Request

parametertypedescription
formatstringAvailable values: json or xml
api_keystringidentify API consumer, testing with: abcdefgh

Response

parametertypedescription
idintx
titlestringcategory name
descriptionstringcategory description excerpt
image_thumbnailstringcategory thumbnail URL
priorityintcan be used for sorting
usage_countinthow many recipes are in category

Special offer list

GET /api/v1.1/special_offer_list

Returns list of latest special offers. Make Example Call

Request

parametertypedescription
formatstringAvailable values: json or xml
api_keystringidentify API consumer, testing with: abcdefgh
filter_group_idintoptional parameter, show only offers from this group_id (e.g. filter_group_id=1491 will show "This week offers")

Response

parametertypedescription
idintx
titlestringoffer name
contentstringoffer description
urlstringlink to offer details on website
priorityintcan be used for sorting
createddatetimex
modifieddatetimex
imagesarraylist of URLs
rondelstringe.g. e10, can be empty
rondel_image_urlstringURL of rondel image, can be empty
pricestringe.g. Now "€3.14" or "Details Instore"
expiry_datedatetimeThis is exact time when the offer is taken down from the website.
taxonomyarray
parametertypedescription
term_idintx
namestringcategory name
slugstringfor constructing URLs
term_groupintx
term_orderintx
usage_countinthow many other offers are in the same group
descriptionstringdescription of the category
product_idstringproduct unique identifier (e.g. stock keeping unit)
group_idintoffers should be grouped by this, ID will not change and can be used for finding e.g. "This week's specials". Returns NULL if the offer is not groupped.
group_titlestringtitle for the group

Store location list

GET /api/v1.1/store_location_list

Returns list of stores address. Make Example Call

Request

parametertypedescription
formatstringAvailable values: json or xml
api_keystringidentify API consumer, testing with: abcdefgh

Response

parametertypedescription
idintinternal store ID
titlestringstore name
addressstringstore address
citystringstore city
countystringstore conty
countrystringcountry
latitudefloate.g. 52.3872369
longitudefloate.g. -9.2994745
openning_hoursstringpreformated text
phonestringcontact telephone number
faxstringcontact fax number
managerstringMr FirstName LastName
modifieddatetimelast update

recipe_rating

GET /api/v1.1/recipe_rating

Allow to pass rating to recipe. Make Example Call

Request

parametertypedescription
formatstringAvailable values: json or xml
api_keystringidentify API consumer, testing with: abcdefgh
recipe_idintValide recipe_id from recipe_list
ratingintrating value, valid values are: 1, 2, 3, 4 or 5

Response

parametertypedescription
rating_submittedintOnly on success, otherwise now included.
rating_submittedarray Only on success, otherwise now included.
parametertypedescription
valueintnew rating value
votes_sumintdeprecated
voters_sumintcount of number of entries
messagestringDetail about result
statusint200 for success, 400 for error