Configuration and Content API Guide

Update Combo Side Groups

post

/config/sim/v1/menuItems/updatecombosidegroups

Updates the Combo Meal Group. If Combo MealGroup is not found, it creates a new Combo Meal Group.

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string

Detail that identifies, who made the change.

Root Schema : ComboMealGroupCUDRequestBody

Type: object

Show Source

alternateGroups: array alternateGroups

An array of Alternate Groups, if any, for this Combo Meal Group.
hierUnitId(required): integer

Unique hierarchy unit reference

Example: 2
items: array items

An array of items that are associated with the combo meal group
name(required): object name

Name
objectNum(required): integer

Combo Meal object number

Example: 1
options: string

A string value of 0s & 1s of length 8 representing enabled or disabled options

Example: 00000000

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Combo Meal object number"
        },
        "name":{
            "type":"object",
            "description":"Name",
            "example":{
                "en-US":"Combo Group 1",
                "es-MX":"Combo Grupo 1"
            }
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options"
        },
        "alternateGroups":{
            "type":"array",
            "description":"An array of Alternate Groups, if any, for this Combo Meal Group.",
            "items":{
                "$ref":"#/definitions/ComboMealGroup_AlternateGroup"
            }
        },
        "items":{
            "type":"array",
            "description":"An array of items that are associated with the combo meal group",
            "items":{
                "$ref":"#/definitions/ComboMealGroup_Items_CUD"
            }
        }
    }
}

Nested Schema : alternateGroups

Type: array

An array of Alternate Groups, if any, for this Combo Meal Group.

Show Source

Array of: object ComboMealGroup_AlternateGroup

{
    "type":"array",
    "description":"An array of Alternate Groups, if any, for this Combo Meal Group.",
    "items":{
        "$ref":"#/definitions/ComboMealGroup_AlternateGroup"
    }
}

Nested Schema : items

Type: array

An array of items that are associated with the combo meal group

Show Source

Array of: object ComboMealGroup_Items_CUD

Model for Combo Meal Group_Item Object

{
    "type":"array",
    "description":"An array of items that are associated with the combo meal group",
    "items":{
        "$ref":"#/definitions/ComboMealGroup_Items_CUD"
    }
}

Nested Schema : name

Type: object

Name

Example:

{
    "en-US":"Combo Group 1",
    "es-MX":"Combo Grupo 1"
}

Nested Schema : ComboMealGroup_AlternateGroup

Type: object

Show Source

alternateGroupObjNum: integer

Object number of the alternate combo meal group.

Example: 2
sequenceNum: integer

Sequence number of the alternate combo meal group.

Example: 1

{
    "type":"object",
    "properties":{
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the alternate combo meal group."
        },
        "alternateGroupObjNum":{
            "type":"integer",
            "example":2,
            "description":"Object number of the alternate combo meal group."
        }
    }
}

Nested Schema : ComboMealGroup_Items_CUD

Type: object

Model for Combo Meal Group_Item Object

Show Source

effectivityGroupObjNum: integer

Object number of the effectivity group

Example: 1
itemObjNum: integer

Object number of the Menu Item Master that contains the side items for the combo meal

Example: 1
options: string

A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item

Example: 0000000000000000
prices: object Price_ComboGroupItem

Model for Combo Group Item Price Object
quantity: integer

Number of Combo Meal Group items required for the combo meal side

Example: 1
size1ItemObjNum: integer

Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663).

Example: 0
size1MenuLevelIndex: integer

Menu Level index for using the Combo Size 1.

Example: 0
size2ItemObjNum: integer

Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664).

Example: 0
size2MenuLevelIndex: integer

Menu Level index for using the Combo Size 2.

Example: 0
size3ItemObjNum: integer

Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665).

Example: 0
size3MenuLevelIndex: integer

Menu Level index for using the Combo Size 3.

Example: 0
size4ItemObjNum: integer

Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666).

Example: 0
size4MenuLevelIndex: integer

Menu Level index for using the Combo Size 4.

Example: 0

{
    "type":"object",
    "properties":{
        "itemObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Menu Item Master that contains the side items for the combo meal"
        },
        "quantity":{
            "type":"integer",
            "example":1,
            "description":"Number of Combo Meal Group items required for the combo meal side"
        },
        "options":{
            "type":"string",
            "example":"0000000000000000",
            "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item"
        },
        "size1ItemObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)."
        },
        "size2ItemObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)."
        },
        "size3ItemObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)."
        },
        "size4ItemObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)."
        },
        "size1MenuLevelIndex":{
            "type":"integer",
            "example":0,
            "description":"Menu Level index for using the Combo Size 1."
        },
        "size2MenuLevelIndex":{
            "type":"integer",
            "example":0,
            "description":"Menu Level index for using the Combo Size 2."
        },
        "size3MenuLevelIndex":{
            "type":"integer",
            "example":0,
            "description":"Menu Level index for using the Combo Size 3."
        },
        "size4MenuLevelIndex":{
            "type":"integer",
            "example":0,
            "description":"Menu Level index for using the Combo Size 4."
        },
        "effectivityGroupObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the effectivity group"
        },
        "prices":{
            "description":"An array of prices associated with the combo meal group items.",
            "$ref":"#/definitions/Price_ComboGroupItem"
        }
    },
    "description":"Model for Combo Meal Group_Item Object"
}

Nested Schema : Price_ComboGroupItem

Type: object

Model for Combo Group Item Price Object

Show Source

activeOnLevel: integer

The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels

Example: 0
effectivityGroupObjNum: integer

Object number of the effectivity group associated with the price

Example: 1
prepcost: number

The a-la carte price of the combo group side items. You can override the a-la carte price for individual combo group items by setting an a-la carte price for those items.

Example: 0.89
price: number

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
sequenceNum: integer

The sequence number of the price

Example: 1

{
    "type":"object",
    "properties":{
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"The sequence number of the price"
        },
        "price":{
            "type":"number",
            "example":1.23,
            "description":"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"
        },
        "prepcost":{
            "type":"number",
            "example":0.89,
            "description":"The a-la carte price of the combo group side items. You can override the a-la carte price for individual combo group items by setting an a-la carte price for those items."
        },
        "activeOnLevel":{
            "type":"integer",
            "example":0,
            "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels"
        },
        "effectivityGroupObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the effectivity group associated with the price"
        }
    },
    "description":"Model for Combo Group Item Price Object"
}

Response

Supported Media Types

application/json

200 Response

Combo Side Group Updated or Added.

Root Schema : ComboMealsGroupResponse

Type: object

Show Source

hierUnitId: integer

Unique hierarchy unit value

Example: 1
objectNum: integer

Unique reference of the Combo Meal

Example: 2

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "objectNum":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the Combo Meal"
        }
    }
}