Jump to

• Request
• Response

Upsert Combo Meal Side Group Prices

post

/config/sim/v2/menuItems/comboMeals/upsertMealSideGroupPrices

Updates provided fields if the sequenceNum field is provided in the request body else inserts a new 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

• activeOnMenuLevel: integer
  The menu level (main or sub) on which the price is active. This should be a value between 0-8.Setting it to 0 indicates the prices is active on all levels

  Example: 0
• comboMealObjNum(required): integer
  Object Number of the Combo Meal

  Example: 1
• hierUnitId(required): integer
  Unique reference of the hierarchy unit

  Example: 2
• prepCost: number
  The preparation cost of the combo meal side.

  Example: 0.67
• 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. Required to update an existing price record.

  Example: 1
• sideNum(required): integer
  Sequence number of the side

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "comboMealObjNum",
        "sideNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit"
        },
        "comboMealObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the Combo Meal"
        },
        "sideNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the side"
        },
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"The sequence number of the price. Required to update an existing price record."
        },
        "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.67,
            "description":"The preparation cost of the combo meal side."
        },
        "activeOnMenuLevel":{
            "type":"integer",
            "example":0,
            "description":"The menu level (main or sub) on which the price is active. This should be a value between 0-8.Setting it to 0 indicates the prices is active on all levels"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Update operation executed successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• comboMealObjNum: integer
  Object Number of the Combo Meal

  Example: 1
• hierUnitId: integer
  Unique reference of the hierarchy unit

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

  Example: 1
• sideNum: integer
  Sequence number of the side

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit"
        },
        "comboMealObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the Combo Meal"
        },
        "sideNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the side"
        },
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"The sequence number of the price"
        }
    }
}

201 Response

Insert operation executed successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• comboMealObjNum: integer
  Object Number of the Combo Meal

  Example: 1
• hierUnitId: integer
  Unique reference of the hierarchy unit

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

  Example: 1
• sideNum: integer
  Sequence number of the side

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit"
        },
        "comboMealObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the Combo Meal"
        },
        "sideNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the side"
        },
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"The sequence number of the price"
        }
    }
}

Back to Top