Recipe API (v0)

Download OpenAPI specification:Download

E-mail: support@smartwithfood.com URL: https://smartwithfood.atlassian.net/servicedesk/customer/portal/6 License: Proprietary License

Introduction

Welcome to the Developer Portal for the SmartWithFood Recipe API v0 (live since October 3, 2024). This API is designed to provide developers with access to a vast collection of recipes, allowing you to integrate culinary delights into your applications, websites, and services. Whether you are building a meal planning app, a cooking blog, or a nutrition tracker, our API has you covered.

Getting started

Follow the following steps to easily get started with our Recipe API.

Express your interest in using our API: Contact us via support@smartwithfood.com and we will provide you with all of the information you need to get started with our API.
Explore Documentation: Dive into our detailed API documentation, where you will find information on endpoints, request parameters, response formats, and usage examples.
Integrate and Innovate: Use the API to access recipes and leverage the productize endpoint to enhance your application's shopping list capabilities

Support

Should you have any questions or need further assistance, please do not hesitate to contact our support team at support@smartwithfood.com or at https://smartwithfood.atlassian.net/servicedesk/customer/portal/6..

Non-Functional Requirements

We are committed to providing you with a seamless and reliable experience when integrating our API into your applications. Below you can find the non-functional requirements you can expect from our API.

Performance

For all endpoints:

99% of requests are expected to have a response time of less than 2 seconds.
95% of requests are expected to have a response time of less than 1 second.

Availability

Our API aims for an availability of 99.9%. This translates to approximately 8.5 hours of planned downtime per year.

Throughput

Normal Circumstances

Up to 2 requests per second.
Up to 40 concurrent requests per minute.
Up to 60,000 requests per day.

Peak Circumstances

Up to 30 requests per second.
Up to 700 concurrent requests per minute.
Up to 140,000 requests per day.
Up to 33,500 requests per hour.

API Reference

With this Recipe API you can:

retrieve details of a specific recipe by providing its unique identifier by using the GET /recipes/{id};
retrieve all recipes by using the GET /recipes;
perform a quick search to find recipes that match specific criteria, returning limited information (for performance reasons) by using the POST /quick_search;
perform a search to find recipes that match specific criteria by using the POST /search;
get related recipes by using the POST /suggestions;
get the aggregations for all recipes (ingredients, tags, allergens, lifestyles, preferences, …) by using the POST /aggregation.

Recipe by Id

Retrieve details of a specific recipe by providing its unique identifier.

SecurityoAuth2-clientCredentials

Request

path Parameters

required

string

Unique id of the recipe.

query Parameters

languages

string

If no language is specified in the request, all languages will be returned.

If a language is specified in the request, only this language will be returned. A fall back mechanism is in place if the requested language is not available. The standard fall back order is nl - fr - fr-FR - en.

Responses

200

Succesful operation.

400

The request could not be understood by the server due to malformed syntax.

401

The caller is not authorized to execute the endpoint.

404

Resource not found.

500

The server could not process the request.

get/recipes/{id}

Request samples

curl
Node.js
JavaScript
PHP
Python

Response samples

application/json

{"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"source": "Name of the source.",
"sourceId": 6543,
"createdAt": 1619254606873,
"publishedAt": "2019-08-24",
"publishingEntries": [{"publishingSpace": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": "nl",
"name": "Name of the publishing space"
}
]
},
"publishingPeriod": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"recurrent": true
}
}
],
"publishingState": {"state": "published"
},
"modifiedAt": 1619254606873,
"name": [{"lang": "nl",
"name": "Turks brood met omelet van champignon en feta"
}
],
"description": [{"lang": "nl",
"name": "Heerlijk vegetarisch gerecht."
}
],
"cookingDifficulty": 1,
"cookTime": 900,
"cookUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"prepTime": 700,
"prepUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"totalTime": 1600,
"totalUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"servingsUnit": "portions",
"numberOfServings": 4,
"manualNutriscore": "A",
"calculatedNutriscore": "A",
"nutriscore": "A",
"recipeAllergens": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "gluten",
"value": "present"
}
],
"recipeLifestyles": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "alcohol-free",
"value": "true"
}
],
"recipePreferences": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "chocolate",
"value": "present"
}
],
"recipeHasLines": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"order": 5,
"amount": 600,
"rawText": "600 g kalkoenhaasjes (beenhouwerij)",
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "g",
"name": [{"lang": "nl",
"name": "gram"
}
]
},
"recipeHasLineHasRecipeGlossaries": [{"recipeGlossary": {"ingredientId": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"ingredientText": "kalkoenhaasjes (beenhouwerij)",
"unitText": "g",
"lineText": "g kalkoenhaasjes (beenhouwerij)",
"plural": true
}
}
],
"recipeLine": {"ingredientName": "5DEE4188-F10C-11E9-B59B-7C11DF2C3EB1components_main#E445CC2E-0A64-11EA-A599-2FCA67A40119extras",
"recipeLineHasRecipeGlossaries": [{"recipeGlossary": {"ingredientId": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"ingredientText": "zout",
"unitText": "kl",
"lineText": "kl zout",
"plural": true
}
}
]
}
}
],
"recipeUtensil": [{"quantity": 4,
"utensil": {"name": [{"lang": "nl",
"name": "Cakevorm"
}
]
}
}
],
"recipeInstruction": [{"order": 5,
"recipeHasInstructionHasRecipeHasLines": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"amount": 2,
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "g",
"name": [{"lang": null,
"name": null
}
]
},
"createdAt": 1619254606873,
"modifiedAt": 1619254606873,
"modifiedBy": "string"
}
],
"instruction": {"title": [{"lang": "nl",
"name": "Deeg"
}
],
"description": [{"lang": "nl",
"name": "Zeef de bloem met het bakpoeder en zout. Doe in de kom van de keukenrobot en meng met de koude boter met de K-klopper. Voeg de eidooier en zure room lepel per lepel toe. Laat het deeg kort en snel kneden. Rol het deeg tot een bol en leg minstens 1 u in de koelkast."
}
],
"instructionHasTips": [{"tip": {"name": [{ }
],
"description": [{ }
],
"tipType": {"id": null,
"name": [ ]
}
}
}
],
"instructionHasImages": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{ }
],
"description": [{ }
]
}
}
],
"instructionHasVideos": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{ }
],
"description": [{ }
]
}
}
]
}
}
],
"recipeTip": [{"order": 4,
"tip": {"name": [{"lang": "nl",
"name": "Tip over bijhorende dranken"
}
],
"description": [{"lang": "nl",
"name": "Een Cabernet Sauvignon past goed bij dit gerecht."
}
],
"tipType": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": "nl",
"name": "Bijhorende dranken."
}
]
}
}
}
],
"recipeTag": [{"tag": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": "nl",
"name": "BBQ"
}
],
"tagType": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": "nl",
"name": "Moment"
}
]
}
}
}
],
"recipeNutritional": [{"calculated": true,
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "µg",
"name": [{"lang": "nl",
"name": "microgram"
}
]
},
"value": 507173.3796296296,
"nutritional": {"shortName": "NACL",
"name": [{"lang": "nl",
"name": "Zout"
}
],
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "µg",
"name": [{"lang": "nl",
"name": "microgram"
}
]
},
"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6"
}
}
],
"referenceRecipe": [{"toRecipe": {"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"name": [{"lang": "nl",
"name": "Aspergepasta met spinaziepesto en zalmsticks"
}
],
"cookTime": 900,
"cookUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"prepTime": 700,
"prepUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"totalTime": 1600,
"totalUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"servingsUnit": "portions",
"numberOfServings": 4,
"recipeHasImages": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{ }
],
"description": [{ }
]
}
}
],
"recipeHasVideos": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{ }
],
"description": [{ }
]
}
}
],
"recipeTag": [{"tag": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{ }
],
"tagType": {"id": null,
"name": [ ]
}
}
}
],
"manualNutriscore": "A",
"calculatedNutriscore": "A",
"nutriscore": "A"
}
}
],
"recipeHasImages": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{"lang": "nl",
"name": "Halloween buffet"
}
],
"description": [{"lang": "nl",
"name": "In deze video wordt het organiseren van een halloween buffet gedemonstreerd."
}
]
}
}
],
"recipeHasVideos": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{"lang": "nl",
"name": "Halloween buffet"
}
],
"description": [{"lang": "nl",
"name": "In deze video wordt het organiseren van een halloween buffet gedemonstreerd."
}
]
}
}
],
"recipeHasWarehouses": [{"warehouse": {"name": [{"lang": "nl",
"name": "Name warehouse"
}
],
"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6"
}
}
]
}

Recipes

Retrieve all recipes.

SecurityoAuth2-clientCredentials

Request

query Parameters

page	integer The requested page.
limit	integer Default: 10 The number of items that should be returned per page.

Responses

200

Succesful operation.

400

The request could not be understood by the server due to malformed syntax.

401

The caller is not authorized to execute the endpoint.

404

Resource not found.

500

The server could not process the request.

get/recipes

Request samples

curl
Node.js
JavaScript
PHP
Python

Response samples

application/json

[{"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"source": "Name of the source.",
"sourceId": 6543,
"createdAt": 1619254606873,
"publishedAt": "2019-08-24",
"publishingEntries": [{"publishingSpace": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": "nl",
"name": "Name of the publishing space"
}
]
},
"publishingPeriod": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"recurrent": true
}
}
],
"publishingState": {"state": "published"
},
"modifiedAt": 1619254606873,
"name": [{"lang": "nl",
"name": "Turks brood met omelet van champignon en feta"
}
],
"description": [{"lang": "nl",
"name": "Heerlijk vegetarisch gerecht."
}
],
"cookingDifficulty": 1,
"cookTime": 900,
"cookUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"prepTime": 700,
"prepUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"totalTime": 1600,
"totalUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"servingsUnit": "portions",
"numberOfServings": 4,
"manualNutriscore": "A",
"calculatedNutriscore": "A",
"nutriscore": "A",
"recipeAllergens": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "gluten",
"value": "present"
}
],
"recipeLifestyles": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "alcohol-free",
"value": "true"
}
],
"recipePreferences": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "chocolate",
"value": "present"
}
],
"recipeHasLines": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"order": 5,
"amount": 600,
"rawText": "600 g kalkoenhaasjes (beenhouwerij)",
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "g",
"name": [{"lang": "nl",
"name": "gram"
}
]
},
"recipeHasLineHasRecipeGlossaries": [{"recipeGlossary": {"ingredientId": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"ingredientText": "kalkoenhaasjes (beenhouwerij)",
"unitText": "g",
"lineText": "g kalkoenhaasjes (beenhouwerij)",
"plural": true
}
}
],
"recipeLine": {"ingredientName": "5DEE4188-F10C-11E9-B59B-7C11DF2C3EB1components_main#E445CC2E-0A64-11EA-A599-2FCA67A40119extras",
"recipeLineHasRecipeGlossaries": [{"recipeGlossary": {"ingredientId": null,
"ingredientText": null,
"unitText": null,
"lineText": null,
"plural": null
}
}
]
}
}
],
"recipeUtensil": [{"quantity": 4,
"utensil": {"name": [{"lang": "nl",
"name": "Cakevorm"
}
]
}
}
],
"recipeInstruction": [{"order": 5,
"recipeHasInstructionHasRecipeHasLines": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"amount": 2,
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "g",
"name": [{ }
]
},
"createdAt": 1619254606873,
"modifiedAt": 1619254606873,
"modifiedBy": "string"
}
],
"instruction": {"title": [{"lang": "nl",
"name": "Deeg"
}
],
"description": [{"lang": "nl",
"name": "Zeef de bloem met het bakpoeder en zout. Doe in de kom van de keukenrobot en meng met de koude boter met de K-klopper. Voeg de eidooier en zure room lepel per lepel toe. Laat het deeg kort en snel kneden. Rol het deeg tot een bol en leg minstens 1 u in de koelkast."
}
],
"instructionHasTips": [{"tip": {"name": [ ],
"description": [ ],
"tipType": { }
}
}
],
"instructionHasImages": [{"order": 5,
"media": {"type": null,
"url": null,
"externalUrl": null,
"title": [ ],
"description": [ ]
}
}
],
"instructionHasVideos": [{"order": 5,
"media": {"type": null,
"url": null,
"externalUrl": null,
"title": [ ],
"description": [ ]
}
}
]
}
}
],
"recipeTip": [{"order": 4,
"tip": {"name": [{"lang": "nl",
"name": "Tip over bijhorende dranken"
}
],
"description": [{"lang": "nl",
"name": "Een Cabernet Sauvignon past goed bij dit gerecht."
}
],
"tipType": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": null,
"name": null
}
]
}
}
}
],
"recipeTag": [{"tag": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": "nl",
"name": "BBQ"
}
],
"tagType": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": null,
"name": null
}
]
}
}
}
],
"recipeNutritional": [{"calculated": true,
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "µg",
"name": [{"lang": "nl",
"name": "microgram"
}
]
},
"value": 507173.3796296296,
"nutritional": {"shortName": "NACL",
"name": [{"lang": "nl",
"name": "Zout"
}
],
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "µg",
"name": [{"lang": null,
"name": null
}
]
},
"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6"
}
}
],
"referenceRecipe": [{"toRecipe": {"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"name": [{"lang": "nl",
"name": "Aspergepasta met spinaziepesto en zalmsticks"
}
],
"cookTime": 900,
"cookUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": null,
"name": null
}
]
},
"prepTime": 700,
"prepUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": null,
"name": null
}
]
},
"totalTime": 1600,
"totalUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": null,
"name": null
}
]
},
"servingsUnit": "portions",
"numberOfServings": 4,
"recipeHasImages": [{"order": 5,
"media": {"type": null,
"url": null,
"externalUrl": null,
"title": [ ],
"description": [ ]
}
}
],
"recipeHasVideos": [{"order": 5,
"media": {"type": null,
"url": null,
"externalUrl": null,
"title": [ ],
"description": [ ]
}
}
],
"recipeTag": [{"tag": {"id": null,
"name": [ ],
"tagType": { }
}
}
],
"manualNutriscore": "A",
"calculatedNutriscore": "A",
"nutriscore": "A"
}
}
],
"recipeHasImages": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{"lang": "nl",
"name": "Halloween buffet"
}
],
"description": [{"lang": "nl",
"name": "In deze video wordt het organiseren van een halloween buffet gedemonstreerd."
}
]
}
}
],
"recipeHasVideos": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{"lang": "nl",
"name": "Halloween buffet"
}
],
"description": [{"lang": "nl",
"name": "In deze video wordt het organiseren van een halloween buffet gedemonstreerd."
}
]
}
}
],
"recipeHasWarehouses": [{"warehouse": {"name": [{"lang": "nl",
"name": "Name warehouse"
}
],
"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6"
}
}
]
}
]

Quick Search

Perform a quick search to find recipes that match specific criteria, returning limited information (for performance reasons).

SecurityoAuth2-clientCredentials

Request

Request Body schema: application/json

limit	integer The amount of recipes returned per page.
page	integer The requested page number.
skip	integer The number of recipes that will be skipped.
search	string User input of the search bar.
	object Brands the returned recipes should (not) be part of.
	object Ingredient the returned recipes should (not) contain.
	object Ingredient attribute values the returned recipes should (not) contain.
	object Allergens the returned recipes should (not) contain.
	object Lifestyles the returned recipes should (not) contain.
	object Preferences the returned recipes should (not) contain.
	Array of objects List of tags to filter on.
name	string Search on recipe name.
description	string Search on recipe description.
	object Only return recipes within a specific cook time range.
	object Nutriscore the returned recipes should (not) have.
	Array of objects Order the recipes will be returned in.
publishingSpaceIds	Array of strings Only return recipes with the specified publishingSpaceIds.
publishingDate	string Only return recipes with the specified publishingDate.
	object Publishing states the returned recipes should (not) have.
languages	Array of strings List of languages in which the recipes should be returned. If no language is specified, all languages will be returned.
recipeIds	Array of strings <UUID> Recipe ids to search on.

Responses

200

Succesful operation.

400

The request could not be understood by the server due to malformed syntax.

401

The caller is not authorized to execute the endpoint.

404

Resource not found.

500

The server could not process the request.

post/recipes/quick_search

Request samples

application/json

{"limit": 10,
"page": 1,
"skip": 2,
"search": "bloemkool",
"warehouses": {"must": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
],
"mustNot": ["21F674D0-5A43-11EA-8740-59C528ECF237"
]
},
"ingredientIds": {"must": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
],
"mustNot": ["21F674D0-5A43-11EA-8740-59C528ECF237"
]
},
"ingredientAttributeValueIds": {"must": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
],
"mustNot": ["21F674D0-5A43-11EA-8740-59C528ECF237"
]
},
"allergens": {"must": ["38ba2e76-abad-42ff-a648-d5ef8db434b1"
],
"mustNot": ["8eb692d6-5e13-42bc-9cfa-61d6cd8a66d0"
]
},
"lifestyles": {"must": ["38ba2e76-abad-42ff-a648-d5ef8db434b1"
],
"mustNot": ["8eb692d6-5e13-42bc-9cfa-61d6cd8a66d0"
]
},
"preferences": {"must": ["38ba2e76-abad-42ff-a648-d5ef8db434b1"
],
"mustNot": ["8eb692d6-5e13-42bc-9cfa-61d6cd8a66d0"
]
},
"tags": [{"must": ["38ba2e76-abad-42ff-a648-d5ef8db434b1"
],
"mustNot": ["8eb692d6-5e13-42bc-9cfa-61d6cd8a66d0"
],
"tagTypeId": "8FA89084-A62A-5923-92A6-0BC314B7890A"
}
],
"name": "Gebakken scampi’s met venkel en pastis",
"description": "Heerlijke vegetarische maaltijd.",
"cookTime": {"min": 1800,
"max": 3600
},
"nutriscore": {"must": ["A"
],
"mustNot": ["A"
]
},
"orderBy": [{"field": "cookTime",
"order": "asc"
}
],
"publishingSpaceIds": ["string"
],
"publishingDate": "2022-11-09",
"publishingStates": {"must": ["published"
],
"mustNot": ["draft"
]
},
"languages": ["nl"
],
"recipeIds": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
]
}

Response samples

application/json

{"totalQuantityOfRecipes": 12,
"recipes": [{"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"name": [{"lang": "nl",
"name": "Turks brood met omelet van champignon en feta"
}
],
"publishingState": {"state": "published"
},
"recipeHasImages": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{"lang": null,
"name": null
}
],
"description": [{"lang": null,
"name": null
}
]
}
}
]
}
],
"quantityOfRecipesReturned": 5
}

Search

Perform a search to find recipes that match specific criteria.

SecurityoAuth2-clientCredentials

Request

Request Body schema: application/json

ids	Array of strings <UUID> Search on recipe ids.
limit	integer The amount of recipes returned per page.
page	integer The requested page number.
skip	integer The number of recipes that will be skipped.
search	string User input of the search bar.
	object Brands the returned recipes should (not) be part of.
	object Ingredient the returned recipes should (not) contain.
	object Ingredient attribute values the returned recipes should (not) contain.
	object Allergens the returned recipes should (not) contain.
	object Lifestyles the returned recipes should (not) contain.
	object Preferences the returned recipes should (not) contain.
	Array of objects List of tags to filter on.
	object Budget the returned recipes should (not) have.
description	string Search on recipe description.
	object Only return recipes within a specific cook time range.
	object Nutriscore the returned recipes should (not) have.
	Array of objects Order the recipes will be returned in.
	Array of objects Aggregation bucket filter. Specifies which buckets of the aggregation will be returned.
publishingSpaceIds	Array of strings Only return recipes with the specified publishingSpaceIds.
publishingDate	string Only return recipes with the specified publishingDate.
	object Publishing states the returned recipes should (not) have.
languages	Array of strings List of languages in which the recipes should be returned. If no language is specified, all languages will be returned.
	Array of objects Aggregation filter. Specifies which aggregations will be returned.
	object Only return recipes within a specific prep time range.
	object Only return recipes within a specific total time range.
hasVideos	boolean If true, only return recipes that contain videos.

Responses

200

Succesful operation.

400

The request could not be understood by the server due to malformed syntax.

401

The caller is not authorized to execute the endpoint.

404

Resource not found.

500

The server could not process the request.

post/recipes/search

Request samples

application/json

{"ids": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
],
"limit": 10,
"page": 1,
"skip": 2,
"search": "bloemkool",
"warehouses": {"must": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
],
"mustNot": ["21F674D0-5A43-11EA-8740-59C528ECF237"
]
},
"ingredientIds": {"must": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
],
"mustNot": ["21F674D0-5A43-11EA-8740-59C528ECF237"
]
},
"ingredientAttributeValueIds": {"must": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
],
"mustNot": ["21F674D0-5A43-11EA-8740-59C528ECF237"
]
},
"allergens": {"must": ["38ba2e76-abad-42ff-a648-d5ef8db434b1"
],
"mustNot": ["8eb692d6-5e13-42bc-9cfa-61d6cd8a66d0"
]
},
"lifestyles": {"must": ["38ba2e76-abad-42ff-a648-d5ef8db434b1"
],
"mustNot": ["8eb692d6-5e13-42bc-9cfa-61d6cd8a66d0"
]
},
"preferences": {"must": ["38ba2e76-abad-42ff-a648-d5ef8db434b1"
],
"mustNot": ["8eb692d6-5e13-42bc-9cfa-61d6cd8a66d0"
]
},
"tags": [{"must": ["38ba2e76-abad-42ff-a648-d5ef8db434b1"
],
"mustNot": ["8eb692d6-5e13-42bc-9cfa-61d6cd8a66d0"
],
"tagTypeId": "8FA89084-A62A-5923-92A6-0BC314B7890A"
}
],
"budget": {"must": [1
],
"mustNot": [3
]
},
"description": "Heerlijke vegetarische maaltijd.",
"cookTime": {"min": 1800,
"max": 3600
},
"nutriscore": {"must": ["A"
],
"mustNot": ["A"
]
},
"orderBy": [{"field": "cookTime",
"order": "asc"
}
],
"bucketFilter": [{"filterName": "tags",
"id": "8FA89084-A62A-5923-92A6-0BC314B7890A",
"keys": ["4F2299E9-5E76-5ACE-8581-BFAF6C1D448A"
]
}
],
"publishingSpaceIds": ["string"
],
"publishingDate": "2022-11-09",
"publishingStates": {"must": ["published"
],
"mustNot": ["draft"
]
},
"languages": ["nl"
],
"bucketSelections": [{"filterName": "tags",
"id": "8FA89084-A62A-5923-92A6-0BC314B7890A"
}
],
"prepTime": {"min": 1800,
"max": 3600
},
"totalTime": {"min": 1800,
"max": 3600
},
"hasVideos": true
}

Response samples

application/json

{"totalQuantityOfRecipes": 12,
"recipes": [{"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"source": "Name of the source.",
"sourceId": 6543,
"createdAt": 1619254606873,
"publishedAt": "2019-08-24",
"publishingEntries": [{"publishingSpace": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": null,
"name": null
}
]
},
"publishingPeriod": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"recurrent": true
}
}
],
"publishingState": {"state": "published"
},
"modifiedAt": 1619254606873,
"name": [{"lang": "nl",
"name": "Turks brood met omelet van champignon en feta"
}
],
"description": [{"lang": "nl",
"name": "Heerlijk vegetarisch gerecht."
}
],
"cookingDifficulty": 1,
"cookTime": 900,
"cookUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"prepTime": 700,
"prepUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"totalTime": 1600,
"totalUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"servingsUnit": "portions",
"numberOfServings": 4,
"manualNutriscore": "A",
"calculatedNutriscore": "A",
"nutriscore": "A",
"recipeAllergens": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "gluten",
"value": "present"
}
],
"recipeLifestyles": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "alcohol-free",
"value": "true"
}
],
"recipePreferences": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "chocolate",
"value": "present"
}
],
"recipeHasLines": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"order": 5,
"amount": 600,
"rawText": "600 g kalkoenhaasjes (beenhouwerij)",
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "g",
"name": [{"lang": null,
"name": null
}
]
},
"recipeHasLineHasRecipeGlossaries": [{"recipeGlossary": {"ingredientId": null,
"ingredientText": null,
"unitText": null,
"lineText": null,
"plural": null
}
}
],
"recipeLine": {"ingredientName": "5DEE4188-F10C-11E9-B59B-7C11DF2C3EB1components_main#E445CC2E-0A64-11EA-A599-2FCA67A40119extras",
"recipeLineHasRecipeGlossaries": [{"recipeGlossary": { }
}
]
}
}
],
"recipeUtensil": [{"quantity": 4,
"utensil": {"name": [{"lang": null,
"name": null
}
]
}
}
],
"recipeInstruction": [{"order": 5,
"recipeHasInstructionHasRecipeHasLines": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"amount": 2,
"unit": {"id": null,
"shortName": null,
"name": [ ]
},
"createdAt": 1619254606873,
"modifiedAt": 1619254606873,
"modifiedBy": "string"
}
],
"instruction": {"title": [{"lang": null,
"name": null
}
],
"description": [{"lang": null,
"name": null
}
],
"instructionHasTips": [{"tip": { }
}
],
"instructionHasImages": [{"order": null,
"media": null
}
],
"instructionHasVideos": [{"order": null,
"media": null
}
]
}
}
],
"recipeTip": [{"order": 4,
"tip": {"name": [{"lang": null,
"name": null
}
],
"description": [{"lang": null,
"name": null
}
],
"tipType": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{ }
]
}
}
}
],
"recipeTag": [{"tag": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": null,
"name": null
}
],
"tagType": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{ }
]
}
}
}
],
"recipeNutritional": [{"calculated": true,
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "µg",
"name": [{"lang": null,
"name": null
}
]
},
"value": 507173.3796296296,
"nutritional": {"shortName": "NACL",
"name": [{"lang": null,
"name": null
}
],
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "µg",
"name": [{ }
]
},
"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6"
}
}
],
"referenceRecipe": [{"toRecipe": {"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"name": [{"lang": null,
"name": null
}
],
"cookTime": 900,
"cookUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{ }
]
},
"prepTime": 700,
"prepUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{ }
]
},
"totalTime": 1600,
"totalUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{ }
]
},
"servingsUnit": "portions",
"numberOfServings": 4,
"recipeHasImages": [{"order": null,
"media": null
}
],
"recipeHasVideos": [{"order": null,
"media": null
}
],
"recipeTag": [{"tag": { }
}
],
"manualNutriscore": "A",
"calculatedNutriscore": "A",
"nutriscore": "A"
}
}
],
"recipeHasImages": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{"lang": null,
"name": null
}
],
"description": [{"lang": null,
"name": null
}
]
}
}
],
"recipeHasVideos": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{"lang": null,
"name": null
}
],
"description": [{"lang": null,
"name": null
}
]
}
}
],
"recipeHasWarehouses": [{"warehouse": {"name": [{"lang": null,
"name": null
}
],
"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6"
}
}
]
}
],
"aggregations": [{"id": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"filterName": "tags",
"filterField": "tagTypeId",
"type": "select",
"text": [{"lang": "nl",
"name": "Soort recept"
}
],
"buckets": [{"key": "4F2299E9-5E76-5ACE-8581-BFAF6C1D448A",
"count": 5433
}
]
}
],
"quantityOfRecipesReturned": 5
}

Suggestions

Get related recipes.

SecurityoAuth2-clientCredentials

Request

Request Body schema: application/json

recipeId required	string <UUID> Unique id of the recipe.
	object Brands the returned recipes should (not) be part of.
limit	integer The amount of recipes returned per page.
useName	boolean Indicates if suggested recipes will be based on the title of the recipe in the request.
useTags	boolean Indicates if suggested recipes will be based on the tags of the recipe in the request.
useNutriscore	boolean Indicates if suggested recipes will be based on the nutriscore of the recipe in the request.
useIngredients	boolean Indicates if suggested recipes will be based on the ingredients of the recipe in the request.
useAttributeValue	boolean Indicates if suggested recipes will be based on the attribute values of the recipe in the request.

Responses

200

Succesful operation.

400

The request could not be understood by the server due to malformed syntax.

401

The caller is not authorized to execute the endpoint.

404

Resource not found.

500

The server could not process the request.

post/recipes/suggestions

Request samples

application/json

{"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"warehouses": {"must": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
],
"mustNot": ["21F674D0-5A43-11EA-8740-59C528ECF237"
]
},
"limit": 10,
"useName": true,
"useTags": true,
"useNutriscore": true,
"useIngredients": true,
"useAttributeValue": true
}

Response samples

application/json

{"data": [{"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"source": "Name of the source.",
"sourceId": 6543,
"createdAt": 1619254606873,
"publishedAt": "2019-08-24",
"publishingEntries": [{"publishingSpace": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": null,
"name": null
}
]
},
"publishingPeriod": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"recurrent": true
}
}
],
"publishingState": {"state": "published"
},
"modifiedAt": 1619254606873,
"name": [{"lang": "nl",
"name": "Turks brood met omelet van champignon en feta"
}
],
"description": [{"lang": "nl",
"name": "Heerlijk vegetarisch gerecht."
}
],
"cookingDifficulty": 1,
"cookTime": 900,
"cookUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"prepTime": 700,
"prepUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"totalTime": 1600,
"totalUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{"lang": "nl",
"name": "seconde"
}
]
},
"servingsUnit": "portions",
"numberOfServings": 4,
"manualNutriscore": "A",
"calculatedNutriscore": "A",
"nutriscore": "A",
"recipeAllergens": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "gluten",
"value": "present"
}
],
"recipeLifestyles": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "alcohol-free",
"value": "true"
}
],
"recipePreferences": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": "chocolate",
"value": "present"
}
],
"recipeHasLines": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"order": 5,
"amount": 600,
"rawText": "600 g kalkoenhaasjes (beenhouwerij)",
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "g",
"name": [{"lang": null,
"name": null
}
]
},
"recipeHasLineHasRecipeGlossaries": [{"recipeGlossary": {"ingredientId": null,
"ingredientText": null,
"unitText": null,
"lineText": null,
"plural": null
}
}
],
"recipeLine": {"ingredientName": "5DEE4188-F10C-11E9-B59B-7C11DF2C3EB1components_main#E445CC2E-0A64-11EA-A599-2FCA67A40119extras",
"recipeLineHasRecipeGlossaries": [{"recipeGlossary": { }
}
]
}
}
],
"recipeUtensil": [{"quantity": 4,
"utensil": {"name": [{"lang": null,
"name": null
}
]
}
}
],
"recipeInstruction": [{"order": 5,
"recipeHasInstructionHasRecipeHasLines": [{"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"amount": 2,
"unit": {"id": null,
"shortName": null,
"name": [ ]
},
"createdAt": 1619254606873,
"modifiedAt": 1619254606873,
"modifiedBy": "string"
}
],
"instruction": {"title": [{"lang": null,
"name": null
}
],
"description": [{"lang": null,
"name": null
}
],
"instructionHasTips": [{"tip": { }
}
],
"instructionHasImages": [{"order": null,
"media": null
}
],
"instructionHasVideos": [{"order": null,
"media": null
}
]
}
}
],
"recipeTip": [{"order": 4,
"tip": {"name": [{"lang": null,
"name": null
}
],
"description": [{"lang": null,
"name": null
}
],
"tipType": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{ }
]
}
}
}
],
"recipeTag": [{"tag": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{"lang": null,
"name": null
}
],
"tagType": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"name": [{ }
]
}
}
}
],
"recipeNutritional": [{"calculated": true,
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "µg",
"name": [{"lang": null,
"name": null
}
]
},
"value": 507173.3796296296,
"nutritional": {"shortName": "NACL",
"name": [{"lang": null,
"name": null
}
],
"unit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "µg",
"name": [{ }
]
},
"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6"
}
}
],
"referenceRecipe": [{"toRecipe": {"recipeId": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"name": [{"lang": null,
"name": null
}
],
"cookTime": 900,
"cookUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{ }
]
},
"prepTime": 700,
"prepUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{ }
]
},
"totalTime": 1600,
"totalUnit": {"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
"shortName": "s",
"name": [{ }
]
},
"servingsUnit": "portions",
"numberOfServings": 4,
"recipeHasImages": [{"order": null,
"media": null
}
],
"recipeHasVideos": [{"order": null,
"media": null
}
],
"recipeTag": [{"tag": { }
}
],
"manualNutriscore": "A",
"calculatedNutriscore": "A",
"nutriscore": "A"
}
}
],
"recipeHasImages": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{"lang": null,
"name": null
}
],
"description": [{"lang": null,
"name": null
}
]
}
}
],
"recipeHasVideos": [{"order": 5,
"media": {"type": "image/jpeg",
"url": "https://fgdjrynm.filerobot.com/recipes/e4ceb35e02442e4d24a8483b682b0095f038f2c78d0aacd1861a0ea3c803e3dc.jpg?vh=8174b9",
"externalUrl": "https://linktoexternallocation.com/mkRzoy10JFHG7HoUqAwnMvA48.jpg",
"title": [{"lang": null,
"name": null
}
],
"description": [{"lang": null,
"name": null
}
]
}
}
],
"recipeHasWarehouses": [{"warehouse": {"name": [{"lang": null,
"name": null
}
],
"id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6"
}
}
]
}
],
"results": 10
}

Aggregation

Get the aggregations for all recipes (ingredients, tags, allergens, lifestyles, preferences, …)

SecurityoAuth2-clientCredentials

Request

Request Body schema: application/json

languages	Array of strings List of languages in which the aggregations should be returned. If no language is specified, all languages will be returned.
	object Brands that should (not) be returned in the aggregations.
	Array of objects Aggregation bucket filter. Specifies which buckets of the aggregation will be returned.
	Array of objects Aggregation bucket filter. Specifies how many buckets of the aggregation will be returened.
	object Publishing states that should (not) be returned in the aggregations.
	Array of objects Aggregation filter. Specifies which aggregations will be returned.

Responses

200

Succesful operation.

400

The request could not be understood by the server due to malformed syntax.

401

The caller is not authorized to execute the endpoint.

404

Resource not found.

500

The server could not process the request.

post/recipes/aggregation

Request samples

application/json

{"languages": ["nl"
],
"warehouses": {"must": ["45C88702-6CFC-48ED-AABE-ED852BDED6CB"
],
"mustNot": ["21F674D0-5A43-11EA-8740-59C528ECF237"
]
},
"bucketFilter": [{"filterName": "tags",
"id": "8FA89084-A62A-5923-92A6-0BC314B7890A",
"keys": ["4F2299E9-5E76-5ACE-8581-BFAF6C1D448A"
]
}
],
"bucketOptions": [{"filterName": "tags",
"maximumQuantity": 5
}
],
"publishingStates": {"must": ["published"
],
"mustNot": ["draft"
]
},
"bucketSelections": [{"filterName": "tags",
"id": "8FA89084-A62A-5923-92A6-0BC314B7890A"
}
]
}

Response samples

application/json

[{"id": "9BF104F0-957C-11EC-A6C0-B92742570A34",
"filterName": "tags",
"filterField": "tagTypeId",
"type": "range",
"range": {"min": 0,
"max": 259200,
"avg": 2806
},
"name": [{"lang": "nl",
"name": "Soort recept"
}
],
"buckets": [{"key": "4F2299E9-5E76-5ACE-8581-BFAF6C1D448A",
"count": 5433,
"text": [{"lang": "nl",
"name": "melk"
}
]
}
]
}
]