GET v{version}/dishes/{dishId}/ingredients
Details
Gets an ingredients response for a specific dish.
https://api.procurewizard.com/v1.0/dishes/{dishId}/ingredientsRequest
URI Parameters
These are parameters passed as part of the URL in the request.
Name | Description | Type | Additional information |
---|---|---|---|
dishId |
The ID of the dish to retrieve ingredients for. |
integer |
Required |
version |
The API version parameter. The current version is 1.0. |
string |
None |
Response
Response Description
A response object of IngredientArrayResponseName | Description | Type | Additional information |
---|---|---|---|
data |
The responses data. This is an array of IngredientResponseData objects. If there are no items in the collection, then an empty array is returned. |
Collection of IngredientResponseData |
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": "ingredient",
"attributes": {
"quantity": 1.1,
"type": "product",
"typeId": 2,
"conversionUnitMeasureId": 3
}
},
{
"id": "12345",
"type": "ingredient",
"attributes": {
"quantity": 1.1,
"type": "product",
"typeId": 2,
"conversionUnitMeasureId": 3
}
}
],
"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"
}
}
<IngredientArrayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.MenusDishesRecipes.Ingredients">
<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.Ingredients" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
<d2p1:IngredientResponseData>
<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:ConversionUnitMeasureId>3</d2p1:ConversionUnitMeasureId>
<d2p1:Quantity>1.1</d2p1:Quantity>
<d2p1:Type>Product</d2p1:Type>
<d2p1:TypeId>2</d2p1:TypeId>
</Attributes>
</d2p1:IngredientResponseData>
<d2p1:IngredientResponseData>
<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:ConversionUnitMeasureId>3</d2p1:ConversionUnitMeasureId>
<d2p1:Quantity>1.1</d2p1:Quantity>
<d2p1:Type>Product</d2p1:Type>
<d2p1:TypeId>2</d2p1:TypeId>
</Attributes>
</d2p1:IngredientResponseData>
</Data>
</IngredientArrayResponse>