GET v{version}/tills/{tillId}/dishes

Details

Gets a dish array response for a specific till.

https://api.procurewizard.com/v1.0/tills/{tillId}/dishes

Request

URI Parameters

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

Name Description Type Additional information
tillId

The ID of the till.

integer

Required

version

The API version parameter. The current version is 1.0.

string

None

Response

Response Description

A response object of DishWithoutPositionArrayResponse
Name Description Type Additional information
data

The responses data. This is an array of DishWithoutPositionResponseData objects. If there are no items in the collection, then an empty array is returned.

Collection of DishWithoutPositionResponseData

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": "Sample string 1",
        "author": "Sample string 2",
        "info": {
          "method": [
            "Open tin.",
            "Put in pan.",
            "Put on hob.",
            "Make toast."
          ],
          "misEnPlace": [
            "Have tins of beans ready.",
            "Slice loaf of bread."
          ],
          "criticalControlPoints": [
            "Is the gas off?"
          ],
          "prepration": [
            "Cut toast into nice triangles.",
            "Pour beans over."
          ]
        },
        "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>"
        },
        "accessEposSettings": {
          "companyCode": "Sample string 1",
          "units": [
            {
              "unitId": 1,
              "name": "Sample string 2",
              "locationRef": "6a15f8ed"
            },
            {
              "unitId": 1,
              "name": "Sample string 2",
              "locationRef": "6a15f8ed"
            }
          ],
          "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": "2026-06-20T21:42:15.4455675+01:00",
        "updated": "2026-06-20T21:42:15.4455675+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"
        },
        "dishPlu": "Sample string 5"
      }
    },
    {
      "id": "12345",
      "type": "dish",
      "attributes": {
        "name": "Sample string 1",
        "author": "Sample string 2",
        "info": {
          "method": [
            "Open tin.",
            "Put in pan.",
            "Put on hob.",
            "Make toast."
          ],
          "misEnPlace": [
            "Have tins of beans ready.",
            "Slice loaf of bread."
          ],
          "criticalControlPoints": [
            "Is the gas off?"
          ],
          "prepration": [
            "Cut toast into nice triangles.",
            "Pour beans over."
          ]
        },
        "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>"
        },
        "accessEposSettings": {
          "companyCode": "Sample string 1",
          "units": [
            {
              "unitId": 1,
              "name": "Sample string 2",
              "locationRef": "6a15f8ed"
            },
            {
              "unitId": 1,
              "name": "Sample string 2",
              "locationRef": "6a15f8ed"
            }
          ],
          "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": "2026-06-20T21:42:15.4455675+01:00",
        "updated": "2026-06-20T21:42:15.4455675+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"
        },
        "dishPlu": "Sample string 5"
      }
    }
  ],
  "links": {
    "self": {
      "href": "http://example-url-1.com",
      "meta": null
    },
    "related": {
      "href": "http://example-url-1.com",
      "meta": null
    }
  },
  "meta": {
    "copyright": "© 2026 The Access Group"
  },
  "jsonApi": {
    "version": "1.0"
  }
}
    

Sample not available.

Sample not available.

Back