Jump to

• Request
• Response

Upsert Combo Meal Side Groups

post

/config/sim/v2/menuItems/comboMeals/upsertMealSideGroups

Updates provided fields if sideNum is specified in the request body, else inserts a new combo meal side group.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

Combo Meal Side Groups Upsert Request body

Root Schema : schema

Type: object

Show Source

• comboGrpObjNum: integer
  Object number of the Side Item Group that contains the side items for the combo meal. Its value cannot be set to null. Required field to create a new Combo Meal Side Group.

  Example: 1
• comboMealObjNum(required): integer
  Combo Meal object number

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

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

  Example: 2
• 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
• sideCount: integer
  Number of Combo Meal Group items required for the combo meal side.

  Example: 1
• sideNum: integer
  Sequence number of the side. Required to update an existing combo meal side group.

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "comboMealObjNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "comboMealObjNum":{
            "type":"integer",
            "example":1,
            "description":"Combo Meal object number"
        },
        "sideNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the side. Required to update an existing combo meal side group."
        },
        "comboGrpObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Side Item Group that contains the side items for the combo meal. Its value cannot be set to null. Required field to create a new Combo Meal Side Group."
        },
        "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Combo Meal Side Group Updated.

Body ()

Root Schema : schema

Type: object

Show Source

• comboMealObjNum: integer
  Unique reference of the Combo Meal.

  Example: 2
• hierUnitId: integer
  Unique hierarchy unit value

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

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "comboMealObjNum":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the Combo Meal."
        },
        "sideNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the side."
        }
    }
}

201 Response

Combo Meal Side Group Added.

Body ()

Root Schema : schema

Type: object

Show Source

• comboMealObjNum: integer
  Unique reference of the Combo Meal.

  Example: 2
• hierUnitId: integer
  Unique hierarchy unit value

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

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "comboMealObjNum":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the Combo Meal."
        },
        "sideNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the side."
        }
    }
}

Back to Top