Jump to

• Request
• Response

Add Combo Meals

post

/config/sim/v1/menuitems/combomeals

Add the Combo Meal object to a specified hierarchy unit of specified organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.
• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Root Schema : ComboMealsResourceObject

Type: object

Show Source

• autoComboMealAlgorithm(optional): integer
  The Auto-Combo Algorithm

  Example: 0
• autoComboMealAlgorithmName(optional): object TranslatedString_autoComboMealAlgorithmName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of auto combo meal algorithm
• hierUnitId: integer
  Unique hierarchy unit reference

  Example: 2
• hierUnitName(optional): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit

  Example: 1
• menuItemMasterName(optional): object TranslatedString_MenuItemMasterName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the menu item master assigned to the condiment item in configured languages
• menuItemMasterObjNum(optional): integer
  Menu item master object number

  Example: 101
• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• objectNum: integer
  Combo Meal object number

  Example: 1
• options(optional): string
  A string value of 0???s & 1???s representing enabled or disabled options

  Example: 00000000
• optionsExt(optional): object ComboMeals_OptionsExt
  An object containing the descriptive options list associated with the Combo Meal.
• priority(optional): integer
  The combo meal priority when pressing the Auto Combo function key

  Example: 1
• sides(optional): 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"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Combo Meal object number"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "menuItemMasterObjNum":{
            "type":"integer",
            "example":101,
            "description":"Menu item master object number"
        },
        "menuItemMasterName":{
            "$ref":"#/definitions/TranslatedString_MenuItemMasterName"
        },
        "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"
        },
        "autoComboMealAlgorithmName":{
            "$ref":"#/definitions/TranslatedString_autoComboMealAlgorithmName"
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0???s & 1???s representing enabled or disabled options"
        },
        "optionsExt":{
            "$ref":"#/definitions/ComboMeals_OptionsExt"
        },
        "sides":{
            "type":"array",
            "description":"An array of Sides that are associated with the combo meal",
            "items":{
                "$ref":"#/definitions/ComboMeals_Sides"
            }
        }
    }
}

Nested Schema : TranslatedString_autoComboMealAlgorithmName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of auto combo meal algorithm",
    "example":{
        "en-US":"FirstDealFound",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of auto combo meal algorithm

Example:

{
    "en-US":"FirstDealFound",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : TranslatedString_MenuItemMasterName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the menu item master assigned to the condiment item in configured languages",
    "example":{
        "en-US":"Condiment Set Items",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the menu item master assigned to the condiment item in configured languages

Example:

{
    "en-US":"Condiment Set Items",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\n\n**Example**\n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\", \"ar-AR\": \"????????\" }`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "ar-AR":"????????"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "ar-AR":"????????"
}

Nested Schema : ComboMeals_OptionsExt

Type: object

An object containing the descriptive options list associated with the Combo Meal.

Show Source

• addSidePricesToMealPrice(optional): boolean
  Flag indicating to add the prices of the combo meal side items to the price of the meal on the workstation client and the printed guest check.

  Example: false
• allowAutocomboInPreviousRound(optional): boolean
  Flag indicating to allow this combo meal to consider previous-round items when pressing the Auto Combo function key.

  Example: false
• allowResizingOfIndividualSides(optional): boolean
  Flag indicating to allow re-sizing of one selected combo meal side item.

  Example: false
• disableAutoComboRecognition(optional): boolean
  Flag indicating to prevent this combo meal from being considered when pressing the Auto Combo function key.

  Example: false
• doNotShowWithComboMealChoices(optional): boolean
  Flag indicating to exclude this meal from the list of choices if multiple combo meals can be created from existing menu items on the check.

  Example: false
• isDefinedComboMeal(optional): boolean
  Flag indicating if the item is a pre-defined combo meal.

  Example: false
• isSizedcomboMeal(optional): boolean
  Flag indicating to allow this combo meal to use Combo Size - Size 1-4 function keys, changing the size of the items ordered.

  Example: false
• keepLastItemSelectedAfterOrdering(optional): boolean
  Flag indicating if you expect modifications to the combo meal after adding the last side, keeping the combo meal selected.

  Example: false
• noBulkOrderWithQuantityOrder(optional): boolean
  Flag indicating to prompt for each non-default side item per meal

  Example: false
• noChargeForCondiments(optional): boolean
  Flag indicating when added condiments (to the meal) are non-priced.

  Example: false
• onlyPrintPricedSidesToGuestCheck(optional): boolean
  Flag indicating to prevent the combo meal side items from printing on the guest check if they have no price, or if their price is added to the price of the meal.

  Example: false

{
    "type":"object",
    "properties":{
        "disableAutoComboRecognition":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to prevent this combo meal from being considered when pressing the Auto Combo function key."
        },
        "allowAutocomboInPreviousRound":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to allow this combo meal to consider previous-round items when pressing the Auto Combo function key."
        },
        "isSizedcomboMeal":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to allow this combo meal to use Combo Size - Size 1-4 function keys, changing the size of the items ordered."
        },
        "addSidePricesToMealPrice":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to add the prices of the combo meal side items to the price of the meal on the workstation client and the printed guest check."
        },
        "onlyPrintPricedSidesToGuestCheck":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to prevent the combo meal side items from printing on the guest check if they have no price, or if their price is added to the price of the meal."
        },
        "noChargeForCondiments":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating when added condiments (to the meal) are non-priced."
        },
        "noBulkOrderWithQuantityOrder":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to prompt for each non-default side item per meal"
        },
        "allowResizingOfIndividualSides":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to allow re-sizing of one selected combo meal side item."
        },
        "doNotShowWithComboMealChoices":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to exclude this meal from the list of choices if multiple combo meals can be created from existing menu items on the check."
        },
        "keepLastItemSelectedAfterOrdering":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if you expect modifications to the combo meal after adding the last side, keeping the combo meal selected."
        },
        "isDefinedComboMeal":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the item is a pre-defined combo meal."
        }
    },
    "description":"An object containing the descriptive options list associated with the Combo Meal."
}

Nested Schema : sides

Type: array

An array of Sides that are associated with the combo meal

Show Source

• Array of: object ComboMeals_Sides

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

Nested Schema : ComboMeals_Sides

Type: object

Show Source

• comboGroupName(optional): string
  name of the combo meal group
• comboGrpObjNum(optional): integer
  Object number of the Side Item Group that contains the side items for the combo meal.

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

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

  Example: 11001111
• menuLevelExt(optional): object ComboMeals_MenuLevelExt
  An object containing the descriptive list of menu levels associated with the Combo Meal
• prices(optional): array prices
• sideCount(optional): integer
  Number of Combo Meal Group items required for the combo meal side.

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

  Example: 1

{
    "type":"object",
    "properties":{
        "sideNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the side."
        },
        "comboGrpObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Side Item Group that contains the side items for the combo meal."
        },
        "comboGroupName":{
            "type":"string",
            "description":"name of the combo meal 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 0???s & 1???s representing the configured menu levels that are available for ordering with this combo group"
        },
        "menuLevelExt":{
            "$ref":"#/definitions/ComboMeals_MenuLevelExt"
        },
        "prices":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ComboMeals_Prices"
            }
        }
    }
}

Nested Schema : ComboMeals_MenuLevelExt

Type: object

An object containing the descriptive list of menu levels associated with the Combo Meal

Show Source

• menuLevel1(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 1

  Example: true
• menuLevel2(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 2

  Example: false
• menuLevel3(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 3

  Example: true
• menuLevel4(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 4

  Example: false
• menuLevel5(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 5

  Example: true
• menuLevel6(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 6

  Example: false
• menuLevel7(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 7

  Example: true
• menuLevel8(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 8

  Example: true

{
    "type":"object",
    "description":"An object containing the descriptive list of menu levels associated with the Combo Meal",
    "properties":{
        "menuLevel1":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 1"
        },
        "menuLevel2":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating if the combo meal is associated with Menu Level 2"
        },
        "menuLevel3":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 3"
        },
        "menuLevel4":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating if the combo meal is associated with Menu Level 4"
        },
        "menuLevel5":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 5"
        },
        "menuLevel6":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating if the combo meal is associated with Menu Level 6"
        },
        "menuLevel7":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 7"
        },
        "menuLevel8":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 8"
        }
    }
}

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(optional): integer
  The menu level (main or sub) on which the price is active.

  Example: 0
• prepCost(optional): number
  The ?? la carte price of the combo group side items.

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

  Example: 1.23
• sequenceNum(optional): integer
  The sequence number of the price

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

A response body for Combo Meals

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",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "objectNum":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the Combo Meal"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top