Configuration and Content API Guide

Get Combo Meal Side Group Prices

post

/config/sim/v2/menuItems/comboMeals/getMealSideGroupPrices

Gets a list of all the prices of a side in a combo meal for the specified organization

Request

Supported Media Types

application/json
multipart/form-data

Request body

Root Schema : schema

Type: object

Show Source

comboMealObjNum(required): integer

Object Number of the Combo Meal

Example: 1
hierUnitId(required): integer

Unique reference of the hierarchy unit

Example: 2
include: string

Example: locations
includeAll: string

This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

Example: detailed
langIds: string

If specified, limits translated strings returned.

Example: 1,2,3
limit: integer

Number of results returned in this page. Not required if paging parameters are not supported.

Example: 10
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 2
orderBy: string

Sorts the response by the specified field name and sort order.

Example: objectNum
searchCriteria: string

Search criteria to filter results based on field value

Example: where equals(active,1)
sideNum(required): integer

Sequence number of the side

Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "comboMealObjNum",
        "sideNum"
    ],
    "properties":{
        "offset":{
            "type":"integer",
            "example":2,
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Number of results returned in this page. Not required if paging parameters are not supported."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "langIds":{
            "type":"string",
            "example":"1,2,3",
            "description":"If specified, limits translated strings returned."
        },
        "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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Combomeal Side Group Prices.

Root Schema : schema

Type: object

Show Source

count: integer

Current response record count.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Combo Meal Side Group Price objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Combo Meal Side Group Price objects of the organization.",
            "items":{
                "$ref":"#/definitions/ComboMealPricev2"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Combo Meal Side Group Price objects of the organization.

Show Source

Array of: object ComboMealPricev2

Model for Price of side of Combo Meal Object

{
    "type":"array",
    "description":"Array of Combo Meal Side Group Price objects of the organization.",
    "items":{
        "$ref":"#/definitions/ComboMealPricev2"
    }
}

Nested Schema : ComboMealPricev2

Type: object

Model for Price of side of Combo Meal 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: integer

Object Number of the Combo Meal

Example: 1
hierUnitId: integer

Unique reference of the hierarchy unit

Example: 2
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
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

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"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number 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"
        },
        "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"
        }
    },
    "description":"Model for Price of side of Combo Meal Object"
}