Configuration and Content API Guide

Get Menu Item Prices

post

/config/sim/v1/menuItems/getMenuItemPrices

Gets all the Menu Item Prices configured and hierarchy unit

Request

Supported Media Types

application/json
multipart/form-data

Request body

Root Schema : MenuItemPriceGetRequestBody

Type: object

Show Source

hierUnitId: integer

Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId.

Example: 1012
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
languages: string

If specified, limits translated strings returned.

Example: en-US, de-DE, es-MX
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(hierUnitId,1012)

{
    "type":"object",
    "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(hierUnitId,1012)",
            "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"
        },
        "languages":{
            "type":"string",
            "example":"en-US, de-DE, es-MX",
            "description":"If specified, limits translated strings returned."
        },
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Menu Item Prices

Root Schema : menuItemPricesGetResponse

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 Menu Item Price objects.
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 Menu Item Price objects.",
            "items":{
                "$ref":"#/definitions/MenuItemPrice"
            }
        },
        "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 Menu Item Price objects.

Show Source

Array of: object MenuItemPrice

Model for Menu Item Price object

{
    "type":"array",
    "description":"Array of Menu Item Price objects.",
    "items":{
        "$ref":"#/definitions/MenuItemPrice"
    }
}

Nested Schema : MenuItemPrice

Type: object

Model for Menu Item Price object

Show Source

activeOnMenuLevel: number

Menu Level Value

Example: 0.18
condimentParentTaxClassOverrideObjNum: number

Specifies the parent item's tax class override (condiment item only)

Example: 0.18
defSequenceNum: integer

Definition sequence number

Example: 5
effectivityGroupObjNum: number

Effectivity group option numbers

Example: 0.18
externalReference1: string

An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32

Example: ExternalReference1
externalReference2: string

An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32

Example: ExternalReference2
hierUnitId: integer

Hierarchy unit unique reference

Example: 1012
menuItemDefinitionId: integer

Unique menu item definition reference

Example: 501
menuItemMasterId: integer

Unique menu item master reference

Example: 1
menuItemMasterObjNum: integer

Menu item master object number

Example: 101
menuItemPriceId: number

Unique menu item price reference

Example: 5.16
options: string

A string value of 0s & 1s of length 8 representing enabled or disabled options

Example: 00000000
optionsExt: object optionsExt

An object containing the descriptive options list associated with the menu item prices
prepCost: number

Preparation cost

Example: 0.18
price: number

Menu item price. Note that precision is determined by currency settings.

Example: 0.18
priceSequenceNum: integer

Price record number

Example: 3
serviceChargeGroupObjNum: number

Service charge group object number

Example: 0.18
taxClassOverrideObjNum: number

Overrides menu item tax class setting (main item only)

Example: 0.18

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Hierarchy unit unique reference"
        },
        "menuItemMasterObjNum":{
            "type":"integer",
            "example":101,
            "description":"Menu item master object number"
        },
        "menuItemMasterId":{
            "type":"integer",
            "example":1,
            "description":"Unique menu item master reference"
        },
        "menuItemDefinitionId":{
            "type":"integer",
            "example":501,
            "description":"Unique menu item definition reference"
        },
        "defSequenceNum":{
            "type":"integer",
            "example":5,
            "description":"Definition sequence number"
        },
        "priceSequenceNum":{
            "type":"integer",
            "example":3,
            "description":"Price record number"
        },
        "menuItemPriceId":{
            "type":"number",
            "example":5.16,
            "description":"Unique menu item price reference"
        },
        "activeOnMenuLevel":{
            "type":"number",
            "example":0.18,
            "description":"Menu Level Value"
        },
        "prepCost":{
            "type":"number",
            "example":0.18,
            "description":"Preparation cost"
        },
        "price":{
            "type":"number",
            "example":0.18,
            "description":"Menu item price. Note that precision is determined by currency settings."
        },
        "taxClassOverrideObjNum":{
            "type":"number",
            "example":0.18,
            "description":"Overrides menu item tax class setting (main item only)"
        },
        "condimentParentTaxClassOverrideObjNum":{
            "type":"number",
            "example":0.18,
            "description":"Specifies the parent item's tax class override (condiment item only)"
        },
        "serviceChargeGroupObjNum":{
            "type":"number",
            "example":0.18,
            "description":"Service charge group object number"
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options"
        },
        "optionsExt":{
            "description":"An object containing the descriptive options list associated with the menu item prices",
            "type":"object",
            "properties":{
                "enableMenuItemTaxClassOverrideOverCondimentParent":{
                    "type":"boolean",
                    "example":false,
                    "description":"A flag indicating that menu item tax class override takes precedence over condiment parent tax class (Condiment only)"
                },
                "excludeCondimentParentItemFromMenuItemTaxClassOverride":{
                    "type":"boolean",
                    "example":false,
                    "description":"A flag indicating to exclude condiment parent item from menu item tax class override count (Condiment only)"
                }
            }
        },
        "effectivityGroupObjNum":{
            "type":"number",
            "example":0.18,
            "description":"Effectivity group option numbers"
        },
        "externalReference1":{
            "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32",
            "type":"string",
            "example":"ExternalReference1"
        },
        "externalReference2":{
            "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32",
            "type":"string",
            "example":"ExternalReference2"
        }
    },
    "description":"Model for Menu Item Price object"
}

Nested Schema : optionsExt

Type: object

An object containing the descriptive options list associated with the menu item prices

Show Source

enableMenuItemTaxClassOverrideOverCondimentParent: boolean

A flag indicating that menu item tax class override takes precedence over condiment parent tax class (Condiment only)

Example: false
excludeCondimentParentItemFromMenuItemTaxClassOverride: boolean

A flag indicating to exclude condiment parent item from menu item tax class override count (Condiment only)

Example: false

{
    "description":"An object containing the descriptive options list associated with the menu item prices",
    "type":"object",
    "properties":{
        "enableMenuItemTaxClassOverrideOverCondimentParent":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating that menu item tax class override takes precedence over condiment parent tax class (Condiment only)"
        },
        "excludeCondimentParentItemFromMenuItemTaxClassOverride":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to exclude condiment parent item from menu item tax class override count (Condiment only)"
        }
    }
}