Menu - Payload format
Benet, Anton
Yildirim, Semih
Owned by Benet, Anton
Payloads from Partner API and Oracle for each menu structure.
Partner API structure examples: Orders API - Cart Structure Examples
Contents
Oracle Symphony API Guide & Agreements
https://docs.oracle.com/en/industries/food-beverage/simphony/19.4/stsgg/F56815_08.pdf
Items
Single item
"cart": {
"menuSelections": [
{
"externalReferenceId": "801500",
"id": "item_67165",
"menuSelections": [],
"price": {
"amount": 649,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
}
]
}{
"menuItems": [
{
"menuItemId": 1001001, // PLU of the single Whopper no cheese. This is the unique identifier per organization (e.g. BK UK, BK DE).
"name": {
"en-US": "Whopper", // This name comes from the menu item master
"es-MX": "Whopper s/Q"
},
"familyGroupRef": 10001, // Used for reporting purposes
"definitions": [
{
"definitionSequence": 2, //This determines the channel (delivery) and the price
"name": {
"en-US": "Whopper", // Names used in the POS specific to the definition sequence
"es-MX": "Whopper s/Q"
},
"name2": {}, // Alternative name to display in KDS
"slus": [
{
"sluNumber": 1, // Screen where item is displayed in the POS (e.g. display in scree named 'A LA CARTA')
"sluId": 101,
"name": {
"en-US": "A LA CARTA DEV"
}
}
],
"prices": [
{
"priceSequence": 1, // Delivery
"price": 119,
"name": "Integrador"
},
{
"priceSequence": 2, // Non-integrated delivery
"price": 119 // Same price for both
}
],
"defaultCondiments": [
{ // Condiuments that come by defaul with the product (i.e. recipe). E.g. tomato, lettuce, bun...
"condimentRef": 9102001,
"quantity": 1
},
{
"condimentRef": 9012002,
"quantity": 1
},
{
"condimentRef": 9012006,
"quantity": 1
},
{
"condimentRef": 9072006,
"quantity": 1
},
{
"condimentRef": 9012009,
"quantity": 2
},
{
"condimentRef": 9012007,
"quantity": 1
},
{
"condimentRef": 9012003,
"quantity": 1
},
{
"condimentRef": 9012008,
"quantity": 4
},
{
"condimentRef": 9055023,
"quantity": 1
}
],
"condimentGroupRules": [
{ // Each of these condiment groups refer to multiple modifiers.
"condimentGroupRef": 121,
"minimumCount": 0,
"maximumCount": 0
},
{
"condimentGroupRef": 122, // Condiment group 'Lg Burger Extras'. The condimentGroup has condimentGroupIds which represent each of the modifier PLUs that can be added to this Whopper.
"minimumCount": 0,
"maximumCount": 0
},
{
"condimentGroupRef": 123,
"minimumCount": 0,
"maximumCount": 0
},
{
"condimentGroupRef": 256,
"minimumCount": 0,
"maximumCount": 0
}
],
"consumerName": { // Name not used by the POS but used to display to customer. Used for 3P consuming the menu.
"en-US": null,
"es-MX": "Whopper sin Queso"
},
"consumerDescription": { // Description not used by the POS but used to display to customer. Used for 3P consuming the menu.
"en-US": null,
"es-MX": "Consumer Item Desc"
},
"images": [
{ //Images configured in the POS, used for the POS screen.
"index": "1",
"url": "https://dimages.bk.com/1400x800 px/91_Whopper.png"
},
{
"index": "3",
"url": "https://dimages.bk.com/1400x800 px/91_Whopper.png"
},
{
"index": "6",
"url": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/oraclegbuprod/b/IC_FBGBU_SS_54416_bt-sim-230712013344-BUK-6e3d4c47-94fb-42e8-a7bb-9c87ae600a37/o/BUK230731151512503.png",
"description": "@POS",
"isCloudImage": true,
"size": "Size: 171 kb, png: 400 x 400 px"
}
],
"consumerAdvisoryText": {}, // E.g. contains gluten.
"nutritionalData": [ //Nutritional info. Markets generally don't maintain it.
{
"nutritionalItemId": "calories",
"value": 670,
"unitOfMeasure": "Calories",
"name": {
"en-US": "Calories"
}
}
],
"extensions": { // Additional info that can be used by third parties.
"PLU - Item": "20100",
"PLU - Combo Sm": "3020100",
"PLU - Combo Md": "3020101",
"PLU - Combo Lg": "3020102"
},
"taxClassRef": 20 // Defines how to tax the item. The taxClass 20 will define what the VAT is, etc.
},
{
"definitionSequence": 1, // This is the same as above but for in-store (sequence 1)
"name": {
"en-US": "Whopper",
"es-MX": "Whopper s/Q"
},
"name2": {},
"slus": [
{
"sluNumber": 1,
"sluId": 100,
"name": {
"en-US": "Whoppers"
}
}
],
"prices": [
{
"priceSequence": 1,
"price": 109
}
],
"defaultCondiments": [
{
"condimentRef": 9102001,
"quantity": 1
},
{
"condimentRef": 9012002,
"quantity": 1
},
{
"condimentRef": 9012006,
"quantity": 1
},
{
"condimentRef": 9072006,
"quantity": 1
},
{
"condimentRef": 9012009,
"quantity": 2
},
{
"condimentRef": 9012007,
"quantity": 1
},
{
"condimentRef": 9012003,
"quantity": 1
},
{
"condimentRef": 9012008,
"quantity": 4
},
{
"condimentRef": 9055023,
"quantity": 1
}
],
"condimentGroupRules": [
{
"condimentGroupRef": 91,
"minimumCount": 0,
"maximumCount": 0
},
{
"condimentGroupRef": 92,
"minimumCount": 0,
"maximumCount": 0
},
{
"condimentGroupRef": 93,
"minimumCount": 0,
"maximumCount": 0
},
{
"condimentGroupRef": 121,
"minimumCount": 0,
"maximumCount": 0
},
{
"condimentGroupRef": 122,
"minimumCount": 0,
"maximumCount": 0
},
{
"condimentGroupRef": 123,
"minimumCount": 0,
"maximumCount": 0
},
{
"condimentGroupRef": 256,
"minimumCount": 0,
"maximumCount": 0
}
],
"consumerName": {
"en-US": null,
"es-MX": "Whopper sin Queso"
},
"consumerDescription": {
"en-US": null,
"es-MX": "Consumer Item Desc"
},
"images": [
{
"index": "1",
"url": "https://dimages.bk.com/1400x800 px/91_Whopper.png"
},
{
"index": "3",
"url": "https://dimages.bk.com/1400x800 px/91_Whopper.png"
},
{
"index": "6",
"url": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/oraclegbuprod/b/IC_FBGBU_SS_54416_bt-sim-230712013344-BUK-6e3d4c47-94fb-42e8-a7bb-9c87ae600a37/o/BUK230731151512503.png",
"description": "@POS",
"isCloudImage": true,
"size": "Size: 171 kb, png: 400 x 400 px"
}
],
"consumerAdvisoryText": {},
"nutritionalData": [
{
"nutritionalItemId": "calories",
"value": 670,
"unitOfMeasure": "Calories",
"name": {
"en-US": "Calories"
}
}
],
"extensions": {
"PLU - Item": "20100",
"PLU - Combo Sm": "3020100",
"PLU - Combo Md": "3020101",
"PLU - Combo Lg": "3020102"
},
"taxClassRef": 20
}
]
}{
"header": {
"orgShortName": "{{OrgShortName}}", // org name
"locRef": "{{LocRef}}",
"rvcRef": {{RvcRef}}, // revenue center
"idempotencyId": "{{$guid}}", // single ID
"orderTypeRef": 9, // needs to match with the POS type, e.g. 9 is delivery
"checkEmployeeRef": {{check_employee_ref}},
"informationLines": ["{\"custName\":\"Rafael\", \"custId:ABC0987654321\"}"] // this displays in receipt
}
,
"menuItems": [
{ "menuItemId":1001001, // Whopper PLU
"definitionSequence": 1, // In-store (def 1)
"quantity": 1 // Number of Whoppers
}
],
"tenders": [
{
"tenderId": 901 // Pay at counter tender. Order is unpaid. tenderId differs based on payment method.
}
]
}Item with modifiers
The following payloads are from BK MX and are not up to date/standard. We won’t use definitionSequence 1, 2 for different service modes.
Condiment Group
Condiment Item. This applies also to defaultCondiments
Combos
Single combo
Combo with modifiers on items
Combo with premium comboslot
Offers
See Offers & Rewards - Payload Format .
Rewards
See Offers & Rewards - Payload Format | Reward payload structures .