Jump to

• Request
• Response

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

Body ()

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of menuItemPrices for the Hierarchy

Body ()

Root Schema : menuItemPricesGetResponse

Type: object

Model for Menu Item Price object

Show Source

• activeOnMenuLevel(required): number
  Menu Level Value

  Example: 0.18
• condimentParentTaxClassOverrideObjNum(required): number
  Specifies the parent item's tax class override (condiment item only)

  Example: 0.18
• defSequenceNum(required): integer
  Definition sequence number

  Example: 5
• effectivityGroupObjNum(required): number
  Effectivity group option numbers

  Example: 0.18
• hierUnitId(required): integer
  Hierarchy unit unique reference

  Example: 1012
• menuItemDefinitionId(required): integer
  Unique menu item definition reference

  Example: 501
• menuItemMasterId(required): integer
  Unique menu item master reference

  Example: 1
• menuItemMasterObjNum(required): integer
  Menu item master object number

  Example: 101
• menuItemPriceId(required): number
  Unique menu item price reference

  Example: 5.16
• options(required): string
  A string value of 0s & 1s of length 8 representing enabled or disabled options

  Example: 00000000
• optionsExt(required): object optionsExt
  An object containing the descriptive options list associated with the menu item prices
• prepCost(required): number
  Preparation cost

  Example: 0.18
• price(required): number
  Menu item price. Note that precision is determined by currency settings.

  Example: 0.18
• priceSequenceNum(required): integer
  Price record number

  Example: 3
• serviceChargeGroupObjNum(required): number
  Service charge group object number

  Example: 0.18
• taxClassOverrideObjNum(required): number
  Overrides menu item tax class setting (main item only)

  Example: 0.18

{
    "type":"object",
    "required":[
        "hierUnitId",
        "menuItemMasterObjNum",
        "menuItemMasterId",
        "menuItemDefinitionId",
        "defSequenceNum",
        "priceSequenceNum",
        "menuItemPriceId",
        "activeOnMenuLevel",
        "prepCost",
        "price",
        "taxClassOverrideObjNum",
        "condimentParentTaxClassOverrideObjNum",
        "serviceChargeGroupObjNum",
        "options",
        "optionsExt",
        "effectivityGroupObjNum"
    ],
    "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"
        }
    },
    "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)"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

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

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

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

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

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

  Example: VALIDATION ERROR
• type(required): 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",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "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"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top