GET v{version}/menus/{menuId}/dishes

Details

Gets a dish array response by a specific menu.

https://api.procurewizard.com/v1.0/menus/{menuId}/dishes

Request

URI Parameters

These are parameters passed as part of the URL in the request.

Name	Description	Type	Additional information
menuId	The ID of the menu to retrieve dishes for.	integer	Required
version	The API version parameter. The current version is 1.0.	string	None

Response

Response Description

A response object of DishArrayResponse

Name	Description	Type	Additional information
data	The responses data. This is an array of DishResponseData objects. If there are no items in the collection, then an empty array is returned.	Collection of DishResponseData	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": "dish",
      "attributes": {
        "name": "Beans on Toast",
        "author": "Gordon Ramsey",
        "accessEposSettings": {
          "companyCode": "Sample string 1",
          "units": [
            {
              "unitId": 1,
              "name": "Sample string 2",
              "locationRef": "241fd030"
            },
            {
              "unitId": 1,
              "name": "Sample string 2",
              "locationRef": "241fd030"
            }
          ],
          "pluNumber": "Sample string 2",
          "salesGroup": "Sample string 3",
          "printGroup": "Sample string 4"
        },
        "tags": [
          {
            "tagId": 1,
            "name": "Sample string 2"
          },
          {
            "tagId": 1,
            "name": "Sample string 2"
          }
        ],
        "created": "2025-04-29T15:06:47.2620722+01:00",
        "updated": "2025-04-29T15:06:47.2620722+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": "dish",
      "attributes": {
        "name": "Beans on Toast",
        "author": "Gordon Ramsey",
        "accessEposSettings": {
          "companyCode": "Sample string 1",
          "units": [
            {
              "unitId": 1,
              "name": "Sample string 2",
              "locationRef": "241fd030"
            },
            {
              "unitId": 1,
              "name": "Sample string 2",
              "locationRef": "241fd030"
            }
          ],
          "pluNumber": "Sample string 2",
          "salesGroup": "Sample string 3",
          "printGroup": "Sample string 4"
        },
        "tags": [
          {
            "tagId": 1,
            "name": "Sample string 2"
          },
          {
            "tagId": 1,
            "name": "Sample string 2"
          }
        ],
        "created": "2025-04-29T15:06:47.2620722+01:00",
        "updated": "2025-04-29T15:06:47.2620722+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"
  }
}

Sample not available.

Back