GET v{version}/recipes
Details
Gets all recipes for a Purchaser.
https://api.procurewizard.com/v1.0/recipesRequest
URI Parameters
These are parameters passed as part of the URL in the request.
| Name | Description | Type | Additional information |
|---|---|---|---|
| version |
The API version parameter. The current version is 1.0. |
string |
None |
Response
Response Description
A response object of RecipeArrayResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| data |
The responses data. This is an array of RecipeResponseData objects. If there are no items in the collection, then an empty array is returned. |
Collection of RecipeResponseData |
None |
| jsonApi |
Implementation details of JSON:API. |
Implementation |
None |
| links |
Related links. |
Links |
None |
| meta |
A meta object used to include non-standard meta-information. Client meta data will be ignored by the server. |
MetaData |
None |
Response Formats
Example responses of what the data might contain.
{
"data": [
{
"id": "12345",
"type": "recipe",
"attributes": {
"name": "Sample string 1",
"author": "Sample string 2",
"unitMeasureId": 3,
"amount": 4.0,
"info": {
"method": [
"Sample string 1",
"Sample string 2"
],
"misEnPlace": [
"Sample string 1",
"Sample string 2"
],
"criticalControlPoints": [
"Sample string 1",
"Sample string 2"
],
"prepration": [
"Sample string 1",
"Sample string 2"
]
},
"media": {
"images": [
"/assets/images/propertysamples/dish1.jpg",
"/assets/images/propertysamples/dish2.jpg"
],
"videoEmbedScript": "<iframe width='560' height='315' src='https://www.youtube.com/embed/xU0UfZxl_uA' frameborder='0' allow='autoplay;'></iframe>"
},
"tags": [
{
"tagId": 1,
"name": "Sample string 2"
},
{
"tagId": 1,
"name": "Sample string 2"
}
],
"created": "2025-04-29T14:54:01.9878279+01:00",
"updated": "2025-04-29T14:54:01.9878279+01:00",
"labelling": {
"title": "Sample string 1",
"description": "Sample string 2",
"shelfLife": 1,
"totalGreenhouseGasesPerServing": {
"value": 1.0,
"unit": 1
},
"totalGreenhouseGasesOverall": {
"value": 1.0,
"unit": 1
},
"ingredients": "Sample string 3",
"barcode": "Sample string 4",
"precautionaryAllergenStatement": "Sample string 5"
}
}
},
{
"id": "12345",
"type": "recipe",
"attributes": {
"name": "Sample string 1",
"author": "Sample string 2",
"unitMeasureId": 3,
"amount": 4.0,
"info": {
"method": [
"Sample string 1",
"Sample string 2"
],
"misEnPlace": [
"Sample string 1",
"Sample string 2"
],
"criticalControlPoints": [
"Sample string 1",
"Sample string 2"
],
"prepration": [
"Sample string 1",
"Sample string 2"
]
},
"media": {
"images": [
"/assets/images/propertysamples/dish1.jpg",
"/assets/images/propertysamples/dish2.jpg"
],
"videoEmbedScript": "<iframe width='560' height='315' src='https://www.youtube.com/embed/xU0UfZxl_uA' frameborder='0' allow='autoplay;'></iframe>"
},
"tags": [
{
"tagId": 1,
"name": "Sample string 2"
},
{
"tagId": 1,
"name": "Sample string 2"
}
],
"created": "2025-04-29T14:54:01.9878279+01:00",
"updated": "2025-04-29T14:54:01.9878279+01:00",
"labelling": {
"title": "Sample string 1",
"description": "Sample string 2",
"shelfLife": 1,
"totalGreenhouseGasesPerServing": {
"value": 1.0,
"unit": 1
},
"totalGreenhouseGasesOverall": {
"value": 1.0,
"unit": 1
},
"ingredients": "Sample string 3",
"barcode": "Sample string 4",
"precautionaryAllergenStatement": "Sample string 5"
}
}
}
],
"links": {
"self": {
"href": "http://example-url-1.com"
},
"related": {
"href": "http://example-url-1.com"
}
},
"meta": {
"copyright": "© 2025 The Access Group"
},
"jsonApi": {
"version": "1.0"
}
}
<RecipeArrayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.MenusDishesRecipes.Recipes">
<JsonApi xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
<d2p1:Version>1.0</d2p1:Version>
</JsonApi>
<Links xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
<Related xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
<d3p1:Href>http://example-url-1.com/</d3p1:Href>
<d3p1:Meta i:nil="true" />
</Related>
<Self xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
<d3p1:Href>http://example-url-1.com/</d3p1:Href>
<d3p1:Meta i:nil="true" />
</Self>
</Links>
<Meta xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
<Copyright>© 2025 The Access Group</Copyright>
</Meta>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.MenusDishesRecipes.Recipes" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
<d2p1:RecipeResponseData>
<Id xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">12345</Id>
<Attributes xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
<d2p1:Amount>4</d2p1:Amount>
<d2p1:Author>Sample string 2</d2p1:Author>
<d2p1:Created>2025-04-29T14:54:01.9878279+01:00</d2p1:Created>
<d2p1:Info>
<d2p1:CriticalControlPoints xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>Sample string 1</d6p1:string>
<d6p1:string>Sample string 2</d6p1:string>
</d2p1:CriticalControlPoints>
<d2p1:Method xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>Sample string 1</d6p1:string>
<d6p1:string>Sample string 2</d6p1:string>
</d2p1:Method>
<d2p1:MisEnPlace xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>Sample string 1</d6p1:string>
<d6p1:string>Sample string 2</d6p1:string>
</d2p1:MisEnPlace>
<d2p1:Prepration xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>Sample string 1</d6p1:string>
<d6p1:string>Sample string 2</d6p1:string>
</d2p1:Prepration>
</d2p1:Info>
<d2p1:Labelling xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.MenusDishesRecipes">
<d5p1:Barcode>Sample string 4</d5p1:Barcode>
<d5p1:Description>Sample string 2</d5p1:Description>
<d5p1:Ingredients>Sample string 3</d5p1:Ingredients>
<d5p1:PrecautionaryAllergenStatement>Sample string 5</d5p1:PrecautionaryAllergenStatement>
<d5p1:ShelfLife>1</d5p1:ShelfLife>
<d5p1:Title>Sample string 1</d5p1:Title>
<d5p1:TotalGreenhouseGasesOverall>
<d5p1:Unit>1</d5p1:Unit>
<d5p1:Value>1</d5p1:Value>
</d5p1:TotalGreenhouseGasesOverall>
<d5p1:TotalGreenhouseGasesPerServing>
<d5p1:Unit>1</d5p1:Unit>
<d5p1:Value>1</d5p1:Value>
</d5p1:TotalGreenhouseGasesPerServing>
</d2p1:Labelling>
<d2p1:Media>
<d2p1:Images xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyURI>/assets/images/propertysamples/dish1.jpg</d6p1:anyURI>
<d6p1:anyURI>/assets/images/propertysamples/dish2.jpg</d6p1:anyURI>
</d2p1:Images>
<d2p1:VideoEmbedScript><iframe width='560' height='315' src='https://www.youtube.com/embed/xU0UfZxl_uA' frameborder='0' allow='autoplay;'></iframe></d2p1:VideoEmbedScript>
</d2p1:Media>
<d2p1:Name>Sample string 1</d2p1:Name>
<d2p1:Tags xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
<d5p1:Tag>
<d5p1:Name>Sample string 2</d5p1:Name>
<d5p1:TagId>1</d5p1:TagId>
</d5p1:Tag>
<d5p1:Tag>
<d5p1:Name>Sample string 2</d5p1:Name>
<d5p1:TagId>1</d5p1:TagId>
</d5p1:Tag>
</d2p1:Tags>
<d2p1:UnitMeasureId>3</d2p1:UnitMeasureId>
<d2p1:Updated>2025-04-29T14:54:01.9878279+01:00</d2p1:Updated>
</Attributes>
</d2p1:RecipeResponseData>
<d2p1:RecipeResponseData>
<Id xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">12345</Id>
<Attributes xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
<d2p1:Amount>4</d2p1:Amount>
<d2p1:Author>Sample string 2</d2p1:Author>
<d2p1:Created>2025-04-29T14:54:01.9878279+01:00</d2p1:Created>
<d2p1:Info>
<d2p1:CriticalControlPoints xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>Sample string 1</d6p1:string>
<d6p1:string>Sample string 2</d6p1:string>
</d2p1:CriticalControlPoints>
<d2p1:Method xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>Sample string 1</d6p1:string>
<d6p1:string>Sample string 2</d6p1:string>
</d2p1:Method>
<d2p1:MisEnPlace xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>Sample string 1</d6p1:string>
<d6p1:string>Sample string 2</d6p1:string>
</d2p1:MisEnPlace>
<d2p1:Prepration xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>Sample string 1</d6p1:string>
<d6p1:string>Sample string 2</d6p1:string>
</d2p1:Prepration>
</d2p1:Info>
<d2p1:Labelling xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.MenusDishesRecipes">
<d5p1:Barcode>Sample string 4</d5p1:Barcode>
<d5p1:Description>Sample string 2</d5p1:Description>
<d5p1:Ingredients>Sample string 3</d5p1:Ingredients>
<d5p1:PrecautionaryAllergenStatement>Sample string 5</d5p1:PrecautionaryAllergenStatement>
<d5p1:ShelfLife>1</d5p1:ShelfLife>
<d5p1:Title>Sample string 1</d5p1:Title>
<d5p1:TotalGreenhouseGasesOverall>
<d5p1:Unit>1</d5p1:Unit>
<d5p1:Value>1</d5p1:Value>
</d5p1:TotalGreenhouseGasesOverall>
<d5p1:TotalGreenhouseGasesPerServing>
<d5p1:Unit>1</d5p1:Unit>
<d5p1:Value>1</d5p1:Value>
</d5p1:TotalGreenhouseGasesPerServing>
</d2p1:Labelling>
<d2p1:Media>
<d2p1:Images xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyURI>/assets/images/propertysamples/dish1.jpg</d6p1:anyURI>
<d6p1:anyURI>/assets/images/propertysamples/dish2.jpg</d6p1:anyURI>
</d2p1:Images>
<d2p1:VideoEmbedScript><iframe width='560' height='315' src='https://www.youtube.com/embed/xU0UfZxl_uA' frameborder='0' allow='autoplay;'></iframe></d2p1:VideoEmbedScript>
</d2p1:Media>
<d2p1:Name>Sample string 1</d2p1:Name>
<d2p1:Tags xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
<d5p1:Tag>
<d5p1:Name>Sample string 2</d5p1:Name>
<d5p1:TagId>1</d5p1:TagId>
</d5p1:Tag>
<d5p1:Tag>
<d5p1:Name>Sample string 2</d5p1:Name>
<d5p1:TagId>1</d5p1:TagId>
</d5p1:Tag>
</d2p1:Tags>
<d2p1:UnitMeasureId>3</d2p1:UnitMeasureId>
<d2p1:Updated>2025-04-29T14:54:01.9878279+01:00</d2p1:Updated>
</Attributes>
</d2p1:RecipeResponseData>
</Data>
</RecipeArrayResponse>