What’s Changing?
- New UoMs (units of measure)
- GET Endpoints: New endpoints, new parameters for existing endpoints, additional property in response
- Alternate Ingredient: mandatory fields
- API Import Review, Manual Approval screen: addition of ‘Total Items’ column
Release date: 25th and 26th August 2020
Reason for the Change
General system enhancements.
Customers Affected
All RME customers using the related functionality.
Release Notes
New standard UoMs
Fourteen new standard UoMs (units of measure) have been created, all of which are compatible for use with the Inventory application.
Unit Name (RME) |
Unit Type (RME) |
Unit Abbreviation |
Equates to [number + UoM] |
PACK |
Each |
PK |
1 Each |
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) |
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) |
Changes to APIs
Please note: Access to the endpoints mentioned below requires a username and password. These credentials can be supplied by Fourth on request – please raise a case via the Customer Community.
GET Endpoint > Processing Status of 'Batch'
- GET endpoint that returns the status of one or more ‘batches’ (payloads) that have been submitted to the import API
- Default response includes the latest 10 batches. A maximum of 100 batches can be retrieved. Batch IDs are unique. Response will include batch ID and processing status of the batch
- Filters - see sample requests below:
- Batch Size: Return a different number of batches than the default ‘latest 10’ batches
- Batch ID: Return a specific batch
- Errors: If the batch ID is invalid (does not exist for that customer), an error will be generated
- Status will be either: ‘not processed’ or ‘processed’. Only these two statuses will be available. UTC date/time of when processing was completed is also included in the response
- See below for sample requests/sample response (see https://developer.fourth.com for more detail)
Sample request for the last 10 batches
/ingredientandaccessimport/batches
Sample request with batch ID
/ingredientandaccessimport/batches?batchId=3722
Sample request with number of batches to return
/ingredientandaccessimport/batches?batchSize=15
Sample response
[
{
"Status": "Processed;Aug 10 2020 8:32AM",
"BatchId": 3722
},
}
]
GET Endpoint ingredients/{guid}/supplierspec > Accept Group GUID as Parameter
- This existing endpoint will accept Group GUID as a parameter
- The response includes all the ingredient records (and their supplier spec info) associated with the specified group
- Sample request: /v2/ingredients/dc5c6d78-1dd9-4bef-9aaf-175e93721a2c/supplierspec
GET Endpoints /ingredients > Add Alternate Ingredient GUID to Response for These Endpoints:
- api.starchef.net/v2/ingredients
- api.starchef.net/v2/ingredients/{guid}
- In the response, the new property is called ‘SuppliedProductGUID’
- This ‘SuppliedProductGUID’ is returned for the parent ingredient and for all alternate ingredients
- A sample response is included at the end of these release notes
GET Endpoint > / ingredientandaccessimport/ingredientcosts
- New GET endpoint that returns these values in the response:
[
{
"SupplierName": "Butcher",
"SupplierCode": "",
"StarChefKey": 213,
"ProductGUID": "a429bf60-bd54-4b82-8e28-151c4d94a1fb",
"IngredientCostPrice": "13.99",
"EffectiveDateOfCurrentCostPrice": "1/31/2019 9:08:50 AM",
"PendingIngredientCostPrice": "25.00",
"PendingCostEffectiveDate": "8/21/2020 12:00:00 AM",
"InvoicePrice": "0.00",
"PendingInvoicePrice": "0.00",
"PendingInvoicePriceEffectiveDate": null
}
]
- Filters
- Group GUID
- LastModifiedAfterDate
GET Endpoint for / ingredientandaccessimport/ingredientspriceband
- New GET endpoint that returns these values in the response:
[
{
"SupplierName": "Butcher",
"SupplierCode": "",
"StarChefKey": 213,
"ProductGUID": "a429bf60-bd54-4b82-8e28-151c4d94a1fb",
"IngredientCostPrice": "13.99",
"EffectiveDateOfCurrentCostPrice": "1/31/2019 9:08:50 AM",
"PendingIngredientCostPrice": "25.00",
"PendingCostEffectiveDate": "8/21/2020 12:00:00 AM",
"InvoicePrice": "0.00",
"PendingInvoicePrice": "0.00",
"PendingInvoicePriceEffectiveDate": null
}
]
- Filters
- Group GUID
- LastModifiedAfterDate
Alternate Ingredient Validation > Enforce Three Mandatory Ingredient Fields (Same as Parent)
If the fields below are 'mandatory' for parent ingredients, this validation will also be applied to alternate ingredients.
- Product Name
- Supplier Name
- Supplier Code
Please note: Mandatory field validation is only applied when the field is mandatory for the user's current user group.
API Import Review, Manual Approval Screen
A new column called ‘Total Items’ will be added to this screen – see Fig.1 below.
Fig.1 - 'Total Items' column in Manual Approval screen of the API Import Review
Comments
0 comments
Please sign in to leave a comment.