Jump to

• Request
• Response

Upsert Combo Side Group Item Prices

post

/config/sim/v2/menuItems/comboSideGroups/upsertSideGroupItemPrices

Updates provided fields if sequenceNum is specified in the request body, else inserts a new combo side group item price.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

Upsert Request body

Root Schema : schema

Type: 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
• comboMealGroupId(required): integer
  Combo Meal Group Id

  Example: 1
• comboMealGroupItemObjNum(required): integer
  Object number of the menu item master associated with the combo group item

  Example: 1
• effectivityGroupObjNum: integer
  Object number of the effectivity group associated with the price

  Example: 1
• hierUnitId(required): integer
  Unique reference of the hierarchy unit where price is defined.

  Example: 2
• prepcost: number
  The preparation cost of the combo group side 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
  Sequence number of the price. Required to update an existing price.

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "comboMealGroupItemObjNum",
        "comboMealGroupId"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit where price is defined."
        },
        "comboMealGroupId":{
            "type":"integer",
            "example":1,
            "description":"Combo Meal Group Id"
        },
        "comboMealGroupItemObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu item master associated with the combo group item"
        },
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the price. Required to update an existing 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 preparation cost of the combo group side 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Combo Group Item Price Updated.

Body ()

Root Schema : schema

Type: object

Show Source

• comboMealGroupId: integer
  Combo Meal Group Id

  Example: 1
• comboMealGroupItemObjNum: integer
  Object number of the menu item master associated with the combo group item

  Example: 1
• hierUnitId: integer
  Unique reference of the hierarchy unit where price is defined.

  Example: 2
• sequenceNum: integer
  The sequence number of the price

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit where price is defined."
        },
        "comboMealGroupId":{
            "type":"integer",
            "example":1,
            "description":"Combo Meal Group Id"
        },
        "comboMealGroupItemObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu item master associated with the combo group item"
        },
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"The sequence number of the price"
        }
    }
}

201 Response

Combo Group Item Price Added.

Body ()

Root Schema : schema

Type: object

Show Source

• comboMealGroupId: integer
  Combo Meal Group Id

  Example: 1
• comboMealGroupItemObjNum: integer
  Object number of the menu item master associated with the combo group item

  Example: 1
• hierUnitId: integer
  Unique reference of the hierarchy unit where price is defined.

  Example: 2
• sequenceNum: integer
  The sequence number of the price

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit where price is defined."
        },
        "comboMealGroupId":{
            "type":"integer",
            "example":1,
            "description":"Combo Meal Group Id"
        },
        "comboMealGroupItemObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu item master associated with the combo group item"
        },
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"The sequence number of the price"
        }
    }
}

Back to Top