POST v{version}/dishes/{dishId}

Details

Updates an individual dish.

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

Request

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.	integer	Required
version	The API version parameter. The current version is 1.0.	string	None

Body Parameters

A dish request. This is the document sent by a client.

DishRequest

Name	Description	Type	Additional information
data	The responses data.	DishRequestData	None
jsonApi	Implementation details of JSON:API.	Implementation	None
meta	A meta object used to include non-standard meta-information. Client meta data will be ignored by the server.	MetaData	None

Request Formats

    
{
  "data": {
    "id": "56789",
    "type": "dish",
    "attributes": {
      "accessEposSettings": {
        "pluNumber": "Sample string 1",
        "salesGroup": "Sample string 2",
        "printGroup": "Sample string 3"
      }
    }
  }
}

    
<DishRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.MenusDishesRecipes.Dishes">
  <JsonApi xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api" />
  <Meta i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi" />
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.MenusDishesRecipes.Dishes" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
    <Id xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">56789</Id>
    <Type xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">dish</Type>
    <Attributes xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
      <d2p1:AccessEposSettings>
        <d2p1:PluNumber>Sample string 1</d2p1:PluNumber>
        <d2p1:PrintGroup>Sample string 3</d2p1:PrintGroup>
        <d2p1:SalesGroup>Sample string 2</d2p1:SalesGroup>
      </d2p1:AccessEposSettings>
    </Attributes>
  </Data>
</DishRequest>

Response

Response Description

A response object of DishResponse

Name	Description	Type	Additional information
data	The responses data.	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",
      "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": "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:30:24.5767818+01:00",
      "updated": "2025-04-29T15:30:24.5767818+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