1. Configuration and Content API Guide
  2. Tasks
  3. Menu Items
  4. Combo Side Groups
  5. Combo Side Groups

Get Combo Side Groups

post

/config/sim/v1/menuItems/getcombosidegroups

Gets all the Combo Meals Groups configured for the specified organization.

Request

Supported Media Types
Body ()
A request body
Root Schema : ComboMealsGroupsGetRequestBody
Type: object
Show Source
  • Example: locations
  • This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.
    Example: detailed
  • If specified, limits translated strings returned.
    Example: en-US, de-DE, es-MX
  • Number of results returned in this page. Not required if paging parameters are not supported.
    Example: 10
  • Starting resource record index. Not required if paging parameters are not supported
    Example: 2
  • Sorts the response by the specified field name and sort order.
    Example: objectNum
  • Search criteria to filter results based on field value
    Example: where equals(active,1)
Back to Top

Response

Supported Media Types

200 Response

A collection of Combo Meal Groups of the organization
Body ()
Root Schema : ComboMealGroupGetResponse
Type: object
Show Source
Nested Schema : items
Type: array
Array of Combo Meal Group objects of the organization.
Show Source
Nested Schema : ComboMealGroupResourceObject
Type: object
Show Source
Nested Schema : alternateGroups
Type: array
An array of Alternate Groups, if any, for this Combo Meal Group.
Show Source
Nested Schema : TranslatedString_HierUnitName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : items
Type: array
An array of items that are associated with the combo meal group
Show Source
Nested Schema : TranslatedString_ComboGroupName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the Combo Group in configured languages
Example:
{
    "en-US":"Combo Group 1",
    "es-MX":"Combo Grupo 1"
}
Nested Schema : ComboMealGroup_OptionsExt
Type: object
An object containing the descriptive options list associated with the Combo Meal Group.
Show Source
Nested Schema : ComboMealGroup_AlternateGroup
Type: object
Show Source
Nested Schema : ComboMealGroup_Items
Type: object
Model for Combo Meal Group_Item Object
Show Source
Nested Schema : OptionsExt_ComboGroupItem
Type: object
An object containing the descriptive options list associated with the Combo Meal Group Item
Show Source
Nested Schema : Price_ComboGroupItem
Type: object
Model for Combo Group Item Price Object
Show Source
  • The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels
    Example: 0
  • Object number of the effectivity group associated with the price
    Example: 1
  • The ?? la carte price of the combo group side items. You can override the ?? la carte price for individual combo group items by setting an ?? la carte price for those items.
    Example: 0.89
  • The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items
    Example: 1.23
  • The sequence number of the price
    Example: 1

400 Response

400 Bad Request
Body ()
Root Schema : ErrorDetails
Type: object
Response body when the request returns an error.
Show Source

404 Response

404 Requested resource not found
Back to Top