What’s New?
-
New Endpoints for Ingredient Details
A new endpoint has been added to facilitate the updating of a limited number of specialist ingredient properties. Please submit a support request to have this enabledGreat Idea! This feature was originally raised as an Idea in our Customer Community.
Release date: 12th May 2026
| URL (base endpoint URL + the following) | Supported Verbs | Resource Description |
| /ingredientdetails |
GET POST |
Retrieve a list of ingredients and their properties as detailed below Update an existing ingredient's properties as detailed below |
POST/ingredientdetails
Sample payload
[
{
"supplierName": "Dairy Supplier",
"supplierCode": "B365",
"starChefKey": "0030702",
"imageUrl": "https://example.com/image.jpg",
"sellable": "False",
"orderable": "False",
"available": "True",
"inAztec": "False"
}
]
Ingredient identifiers
To identify a unique ingredient record within the payload, use either:
-
StarChefKey
OR
supplierName + supplierCode combination
If both identifiers are provided, the StarChef key will be referenced, and the supplierName + supplierCode combination will be ignored.
| Properties | ||||
| Name | Type | Description | Validation | Example |
| supplierName | string | Name of the supplier. When combined with supplierCode value, can be used as identifier for an ingredient |
maxLength: 150 minLength: 1 Optional if StarChef key is used as unique identifier in payload |
Dairy Supplier |
| supplierCode | string | Unique identifier for the ingredient, provided by the supplier. When combined with supplierName value, can be used as identifier for an ingredient |
maxLength: 50 minLength: 1 Optional if StarChef key is used as unique identifier in payload |
B365 |
| starChefKey | integer | Unique Fourth identifier for the ingredient (corresponds to product key in the user interface) | Mandatory unless Supplier Name + Supplier Code are used as unique identifier in payload | 0030702 |
| imageUrl | string |
Image URL for the ingredient On the UI, corresponds to Ingredients > Supplier Spec > Image URL
|
maxLength: 200 Optional |
https://example.com/image.jpg |
| sellable | string |
On the UI, corresponds to Ingredients > Details > Sellable (tick box) If 'sellable' = true, usually the 'portions' values will be populated (via the UI). These values are used by POS rather than for any RME calculations |
True or False Optional |
False |
| orderable | string | On the UI, corresponds to Ingredients > Supply Details > Orderable (tick box) |
True or False Optional |
False |
| available | string | On the UI, corresponds to Ingredients > Supplier Spec > Available (tick box) |
True or False Optional |
True |
| inAztec | string | On the UI, corresponds to Ingredients > Supplier Spec > inAztec (tick box) |
True or False Optional |
True |
Omitted fields
If one or more properties are not included in the request payload, the omitted fields are not modified. Existing values are preserved.
Empty string values
- imageUrl - If the imageUrl property is explicitly included with an empty string value, any existing value will be cleared (set to empty string).
- sellable/orderable/available/inAztec - If any of these properties are explicitly included with an empty string value, the empty string is treated as 'null'. The field will retain its existing value.
Default values
The new endpoint allows existing ingredient updates rather than new ingredient creation. If new ingredients are created via the API using the POST/ingredients request, the default values will be as follows:
| Field | Default Value |
| imageUrl | Empty string ("") |
| sellable | False |
| orderable | True |
| available | True |
| inAztec | False |
Note: Default values apply only to initial ingredient creation.
GET/ingredientdetails
Sample response
[
{
"supplierName": "Dairy",
"supplierCode": "B365",
"starChefKey": "0030702",
"imageUrl": "https://example.com/image.jpg",
"sellable": "False",
"orderable": "False",
"available": "True",
"inAztec": "False"
}
]
Comments
Please sign in to leave a comment.