Release Notes: Recipe and Menus: Export (GET) APIs – Fourth & HotSchedules Customer Success Portal

What’s Changing?

Export (GET) APIs

Ingredient Export (GET) API for Process Data: Display Parent Ingredient ‘Process Data’ when Alternate Ingredient GUID is included in request
Menu Export (GET API): Optimise Date Filter
Recipe GET API for Intolerance Values: Add ‘LastModifiedAfter’ Filter

Release date: 14th April (USA) / 15^th April (EMEA/APAC) 2020

Reason for the Change

General system enhancements.

Customers Affected

Export APIs: Impacts all customers using these endpoints.

Release Notes

Ingredient Export (GET) API for Process Data: Display Parent Ingredient’s ‘Process Data’ in response when Alternate Ingredient GUID is used in request

When alternate ingredient GUID is included in the request, parent ingredient ‘process data’ will be displayed.

Endpoint: api.starchef.net/v2/ingredients/{GUID}/processdata

Note: Parent ingredient data is displayed because alternate ingredients do not have their own process data values. This is consistent with other parent/alternate ingredient values such as intolerance and nutrition values.

User-added image
Fig.1 – Example of response for ingredient ‘process data’ endpoint

Menu Export (GET) API: Optimise Date Filter

This endpoint’s date filter has been refactored to improve the speed of response.

Example request: api.starchef.net/menus?lastModifiedAfter=YYYY-MM-DD

Recipe Export (GET) API for Intolerance values: Add LastModifiedAfter Filter

A date filter has been added to this endpoint.

Example request: api.starchef.net/v2/recipes/{GUID}/intolerances?lastModifiedAfter=YYYY-MM-DD