NameDescriptionTypeAdditional information
WebSalesGroupId

You can group sales items under web sales groups in menu configurator. WebSalesGroupId is ID of web sales group, icon , where referenced SalesItem of referenced LineItem belongs to.

To order Quick Combo, you must select one item for each compoment. Those items are LineItems that belong to the Quick Combo. They are identified by OrderWebSalesGroups having same GroupLineId.

Value is not required in special case, when ordering QuickCombo that is not configured using web sales groups. For this case, if you still provide value, use 0, otherwise request will fail with error message.


Calculate Tax And Total example for QuickCombo configured in Menu Configurator using web sales groups:
"LineItems": [ // first LineItem - Gyros Pita { "ItemLineNumber": 1, "SalesItemId": 2513, "MenuItemId": 1450 }, // Other LineItems { "ItemLineNumber": 2, "SalesItemId": 2516, "MenuItemId": 1450 }, { "ItemLineNumber": 3, "SalesItemId": 2372, "MenuItemId": 1450 } ], "ComboItems": [ { "PromoId": 10, "WebSalesGroupLineItems": [ // OrderWebSalesGroup referencing first LineItem: { "WebSalesGroupId": 636721855405235744, "LineItemNumber": 1, "GroupLineId": 1, "MenuItemName": "Pita Combo" }, // Other references: { "WebSalesGroupId": 636721855669772944, "LineItemNumber": 2, "GroupLineId": 1, "MenuItemName": "Pita Combo" }, { "WebSalesGroupId": 636721855802338736, "LineItemNumber": 3, "GroupLineId": 1, "MenuItemName": "Pita Combo" } ] } ]

Quick Combo using web sales groups.

Calculate Tax And Total for QuickCombo configured in Menu Configurator not using web sales groups:
"LineItems": [ // first LineItem - Gyros Pita { "ItemLineNumber": 1, "SalesItemId": 2513, "MenuItemId": 1440 }, // Other LineItems { "ItemLineNumber": 2, "SalesItemId": 2516, "MenuItemId": 1440 }, { "ItemLineNumber": 3, "SalesItemId": 2372, "MenuItemId": 1440 } ], "ComboItems": [ { "PromoId": 10, "WebSalesGroupLineItems": [ // Reference to first LineItem // Notice WebSalesGroupId is not provided. { "LineItemNumber": 1, "GroupLineId": 1, "MenuItemName": "Pita Combo" }, // Other references: { "LineItemNumber": 2, "GroupLineId": 1, "MenuItemName": "Pita Combo" }, { "LineItemNumber": 3, "GroupLineId": 1, "MenuItemName": "Pita Combo" } ] } ]

Quick Combo not using web sales groups.

integer

None.

LineItemNumber

Required. Identifies line item which belongs to group. This must match ItemLineNumber of referenced LineItem.

integer

None.

GroupLineId

Provide same GroupLineId for items that are part same of combo. You can provide any GroupLineId, just make sure it is unique within entire Calculate Tax And Total request.


Example to order 2x same QuickCombo, PromoId=10 1x other QuickCombo, PromoId=17
"LineItems": [ { "ItemLineNumber": 1, "SalesItemId": 2001, "MenuItemId": 1001 }, { "ItemLineNumber": 2, "SalesItemId": 2002, "MenuItemId": 1001 }, { "ItemLineNumber": 3, "SalesItemId": 2003, "MenuItemId": 1001 }, { "ItemLineNumber": 4, "SalesItemId": 2001, "MenuItemId": 1001 }, { "ItemLineNumber": 5, "SalesItemId": 2002, "MenuItemId": 1001 }, { "ItemLineNumber": 6, "SalesItemId": 2003, "MenuItemId": 1001 } { "ItemLineNumber": 7, "SalesItemId": 2011, "MenuItemId": 1037 }, { "ItemLineNumber": 8, "SalesItemId": 2012, "MenuItemId": 1037 }, { "ItemLineNumber": 9, "SalesItemId": 2013, "MenuItemId": 1037 } ], "ComboItems": [ { "PromoId": 10, "WebSalesGroupLineItems": [ { "LineItemNumber": 1, "GroupLineId": 1, "MenuItemName": "Combo" }, { "LineItemNumber": 2, "GroupLineId": 1, "MenuItemName": "Combo" }, { "LineItemNumber": 3, "GroupLineId": 1, "MenuItemName": "Combo" }, { "LineItemNumber": 4, "GroupLineId": 2, "MenuItemName": "Combo" }, { "LineItemNumber": 5, "GroupLineId": 2, "MenuItemName": "Combo" }, { "LineItemNumber": 6, "GroupLineId": 2, "MenuItemName": "Combo" } ] } { "PromoId": 17, "WebSalesGroupLineItems": [ { "LineItemNumber": 7, "GroupLineId": 3, "MenuItemName": "Combo" }, { "LineItemNumber": 8, "GroupLineId": 3, "MenuItemName": "Combo" }, { "LineItemNumber": 9, "GroupLineId": 3, "MenuItemName": "Combo" }, ] } ]
NOTE: For LineItems that belong to QuickCombo, do not specify Quantity. If you want to order more quick combos, list each of the LineItems, associated OrderWebSalesGroups and ComboItem separately.

integer

None.

MenuItemName

Used for display on receipt on online ordering web site, located at top right section of order entry page. Also visbile on customer account order history on web site.
Value is required, but you can leave an empty. For example you do not use ordering web site or you do not care about displaying on ordering web site.

string

None.

SalesItemId

This is not used. Does not matter whether or what value is specified.

integer

None.