Recipe & Menu Engineering Import API Release Notes

Overview

This page explains the changes that have happened to our Recipe & Menu Engineering Import API since August 2020.

These Release Notes are up-to-date at the time of the release. Further improvements or corrections to our API documentation will normally occur in the guide and reference only.

If you have already integrated with Fourth would like to be kept abreast of API changes via email, please fill in this form.

26 August 2020 — New endpoints for ingredient costs and price bands

Two new endpoints have been introduced to GET ingredient costs and price bands.

Ingredient costs

The new endpoint is:

• GET [ROOT]/ingredientcosts

By default, this returns details for all ingredients. You can filter the response using query parameters:

• lastModifiedAfter — Returns only records modified on or after the date. Use the format: yyyy-mm-dd
• groupGuid — The logical business grioup within Recipe & Menu Engineering.
• productId or GUID — The unique identifier
• setType — The ingredient set type, if these are in use. Options are: Blank, Trial, Archive, and Live.

This returns the existing and pending price details for an ingredient. If there is no value for a price it will be set to 0.00; for a date it will be set to null. For example:

[
  {
    "SupplierName": "The Vegan Butcher",
    "SupplierCode": "12A4D63C",
    "StarChefKey": 213,
    "ProductGUID": "a429bf60-bd54-4b82-8e28-151c4d94a1fb",
    "IngredientCostPrice": "13.99",
    "PendingIngredientCostPrice": "25.00",
    "PendingCostEffectiveDate": "8/21/2020 12:00:00 AM",
    "InvoicePrice": "0.00",
    "PendingInvoicePrice": "0.00",
    "PendingInvoicePriceEffectiveDate": null
  }
]

For more information on this endpoint, please see the API guide and reference.

Ingredients price band

The new endpoint is:

• GET [ROOT]/ingredientspriceband

By default, this returns details for all ingredients. You can filter the response using query parameters:

• lastModifiedAfter — Returns only records modified on or after the date. Use the format: yyyy-mm-dd
• groupGuid — The business group within Recipe & Menu Engineering.

 

26 August 2020 — New batch endpoint for checking request processing

For successfully submitted POST requests, Fourth returns a status in the synchronous response body. For example:

{
  "Status": "Processed;Aug 10 2020 8:32AM",
  "BatchId": "2345"
}

The two possible states are Processed (with a timestamp) and Not processed. To check the processing status later, you can now use the /batches endpoint:

[ROOT]/api/ingredientandaccessimport/batches

You can filter the response by individual request; for example:

[ROOT]/api/ingredientandaccessimport/batches?batchId=3722

Or filter by the number of results want returned (from 1 to 100). For example, this returns the last processing status of the last two requests made:

[ROOT]/api/ingredientandaccessimport/batches?batchSize=2

Sample response:

[
  {
    "Status": "Not processed",
    "BatchId": 3724
  },
{
    "Status": "Processed;Aug 28 2020  8:32AM",
    "BatchId": 3722
  }
]

26 August 2020 — New Units of Measure

New Units of Measure

Fourteen new standard RME UoMs (units of measure) have been created. These UoMs are compatible for use with the Inventory application.

Unit Name (RME)	Unit Type (RME)	Unit Abbreviation	Equates to [number + UoM]
KEG (D) 1/2	Volume	KEG (D) 1/2	1984 Floz (US)
KEG (D) 1/4	Volume	KEG (D) 1/4	992  Floz (US)
KEG (D) 1/6	Volume	KEG (D) 1/6	661 Floz (US)
KEG (I) 1/2	Volume	KEG (I) 1/2	1690.70 Fl oz (US)
KEG (I) 1/3	Volume	KEG (I) 1/3	1014.42 Fl oz (US)
KEG (I) 1/4	Volume	KEG (I) 1/4	845.35 Fl oz (US)
PACK	Each	PK	1 Each
TRAY	Each	TRAY	1 Each
SHEET	Each	SHT	1 Each
Pan 1/3 4 " Deep	Volume	Pan 1/3 x 4"	4.5 Quarts (US)
PAN 1/6 6" Deep	Volume	Pan 1/6 x 6"	2.5 Quarts (US)
Quart, Dry (US)	Volume	QT, Dry (US)	37.2364 Fl oz (US)
Bushel	Volume	BU	1191.57 Fl oz (US)
BARREL	Volume	BRL	5376 Fl oz (US)