Jump to

• Request
• Response

Add Combo Meal Side Group Prices

post

/config/sim/v1/menuItems/combomeals/mealsidegroupprices

Add a price for a side of a Combo Meal unit

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 ()

Request body

Root Schema : ComboMealPrice

Type: object

Model for Price of side of Combo Meal Object

Show Source

• activeOnMenuLevel(optional): 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: integer
  Object Number of the Combo Meal

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

  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
• prepCost(optional): number
  The ?? la carte price of the combo group side items. You can override the ?? la carte price for individual combo group items by setting an ?? la carte price for those items.

  Example: 0.67
• price(optional): 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(optional): integer
  The sequence number of the price

  Example: 1
• sideNum: 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"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "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"
        },
        "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 ?? la carte price of the combo group side items. You can override the ?? la carte price for individual combo group items by setting an ?? la carte price for those items."
        },
        "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"
        }
    },
    "description":"Model for Price of side of Combo Meal Object"
}

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Combo Meal Price Response

Body ()

Root Schema : ComboMealPriceResponse

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",
    "required":[
        "hierUnitId",
        "comboMealObjNum",
        "sideNum",
        "sequenceNum"
    ],
    "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"
        }
    }
}

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