Jump to

• Request
• Response

Upsert Combo Meals Lite

post

/config/sim/v2/menuItems/upsertComboMealsLite

Updates provided fields if the Combo Meal exists; inserts a new Combo Meal if it doesn't.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

Combo Meals Lite upsert request body

Root Schema : schema

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: object name
  Combo Meal Name. Required to create a new Combo Meal.
• 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

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "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":"Combo Meal Name. Required to create a new Combo Meal.",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "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"
        }
    }
}

Nested Schema : name

Type: object

Combo Meal Name. Required to create a new Combo Meal.

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Combo Meal Updated.

Body ()

Root Schema : schema

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

201 Response

Combo Meal Inserted.

Body ()

Root Schema : schema

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