Jump to

• Request
• Response

Update Combo Meals

post

/config/sim/v1/menuitems/updatecombomeals

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

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Root Schema : ComboMealsResourceObjectCUDRequestBody

Type: object

Show Source

• autoComboMealAlgorithm: integer
  The Auto-Combo Algorithm. Allowed values are 0,1,2

  Description	Value
  First Deal Found	0
  Best Deal for Customer	1
  Best Deal for Merchant	2

  Example: 0
• hierUnitId(required): integer
  Unique hierarchy unit reference

  Example: 2
• menuItemMasterObjNum: integer
  Menu item master object number

  Example: 101
• name(required): object name
• objectNum(required): integer
  Combo Meal object number

  Example: 1
• options: string
  A string value of 0s & 1s of length 16 representing enabled or disabled options

  Example: 0000000000000000
• pricingAlgorithm: integer
  Pricing Algorithm Values

  Description	Value
  Default	NULL
  Most Expensive Side Group	1
  Least Expensive Side Group	2

  Example: 1
• priority: integer
  The combo meal priority when pressing the Auto Combo function key

  Example: 1
• sides: array sides
  An array of Sides that are associated with the combo meal

{
    "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",
            "example":{
                "en-US":"Coffee",
                "de-DE":"Kaffee",
                "es-MX":"Cafe"
            }
        },
        "menuItemMasterObjNum":{
            "type":"integer",
            "example":101,
            "description":"Menu item master object number"
        },
        "priority":{
            "type":"integer",
            "example":1,
            "description":"The combo meal priority when pressing the Auto Combo function key"
        },
        "autoComboMealAlgorithm":{
            "type":"integer",
            "example":0,
            "description":"The Auto-Combo Algorithm. Allowed values are 0,1,2 <table border=\"1\"> <thead> <tr> <th>Description</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td>First Deal Found</td> <td>0</td> </tr> <tr> <td>Best Deal for Customer</td> <td>1</td> </tr> <tr> <td>Best Deal for Merchant</td> <td>2</td> </tr> </tbody> </table>"
        },
        "pricingAlgorithm":{
            "type":"integer",
            "example":1,
            "description":"Pricing Algorithm Values <table border=\"1\"> <thead> <tr> <th>Description</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td>Default</td> <td>NULL</td> </tr> <tr> <td>Most Expensive Side Group</td> <td>1</td> </tr> <tr> <td>Least Expensive Side Group</td> <td>2</td> </tr> </tbody> </table>"
        },
        "options":{
            "type":"string",
            "example":"0000000000000000",
            "description":"A string value of 0s & 1s of length 16 representing enabled or disabled options"
        },
        "sides":{
            "type":"array",
            "description":"An array of Sides that are associated with the combo meal",
            "items":{
                "$ref":"#/definitions/ComboMeals_Sides_CUD"
            }
        }
    }
}

Nested Schema : name

Type: object

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}

Nested Schema : sides

Type: array

An array of Sides that are associated with the combo meal

Show Source

• Array of: object ComboMeals_Sides_CUD

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

Nested Schema : ComboMeals_Sides_CUD

Type: object

Show Source

• comboGrpObjNum: integer
  Object number of the Side Item Group that contains the side items for the combo meal.

  Example: 1
• defaultMenuLevelIndex: integer
  Index of the default menu level for this combo group.

  Example: 1
• menuLevel: string
  A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group

  Example: 11001111
• prices: array prices
• sideCount: integer
  Number of Combo Meal Group items required for the combo meal side.

  Example: 1
• sideNum: integer
  Sequence number of the side. The field sideNum cannot be null within sides and must be in sequential order within a combo meal, starting from 0.

  Example: 1

{
    "type":"object",
    "properties":{
        "sideNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the side. The field sideNum cannot be null within sides and must be in sequential order within a combo meal, starting from 0."
        },
        "comboGrpObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Side Item Group that contains the side items for the combo meal."
        },
        "sideCount":{
            "type":"integer",
            "example":1,
            "description":"Number of Combo Meal Group items required for the combo meal side."
        },
        "defaultMenuLevelIndex":{
            "type":"integer",
            "example":1,
            "description":"Index of the default menu level for this combo group."
        },
        "menuLevel":{
            "type":"string",
            "example":"11001111",
            "description":"A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group"
        },
        "prices":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ComboMeals_Prices"
            }
        }
    }
}

Nested Schema : prices

Type: array

Show Source

• Array of: object ComboMeals_Prices
  An array of prices associated with the combo meal

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ComboMeals_Prices"
    }
}

Nested Schema : ComboMeals_Prices

Type: object

An array of prices associated with the combo meal

Show Source

• activeOnMenuLevel: integer
  The menu level (main or sub) on which the price is active.

  Example: 0
• prepCost: number
  The a-la carte price of the combo group side items.

  Example: 0.89
• price: number
  The default side item price to use for the combo group items.

  Example: 1.23
• sequenceNum: integer
  The sequence number of the price. The field sequenceNum cannot be null within side prices and must be in sequential order within a side, starting from 1.

  Example: 1

{
    "type":"object",
    "description":"An array of prices associated with the combo meal",
    "properties":{
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"The sequence number of the price. The field sequenceNum cannot be null within side prices and must be in sequential order within a side, starting from 1."
        },
        "price":{
            "type":"number",
            "example":1.23,
            "description":"The default side item price to use for the combo group items."
        },
        "prepCost":{
            "type":"number",
            "example":0.89,
            "description":"The a-la carte price of the combo group side items."
        },
        "activeOnMenuLevel":{
            "type":"integer",
            "example":0,
            "description":"The menu level (main or sub) on which the price is active."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Combo Meal Updated or Added.

Body ()

Root Schema : ComboMealsResponse

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"
        }
    }
}

Back to Top