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

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : MenuItemPriceGetRequestBody

Type: object

Show Source

• hierUnitId: integer
  Hierarchy unit unique reference

  Example: 1012
• include(optional): string
  Example: locations
• languages(optional): string
  If specified, limits translated strings returned.

  Example: en-US, es-SS,lt-LT
• limit(optional): integer
  Number of results returned in this page. Not required if paging parameters are not supported.

  Example: 10
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported

  Example: 2
• orderBy(optional): string
  Sorts the response by the specified field name and sort order.

  Example: comboMealGroups.objectNum
• searchCriteria(optional): string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "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":"comboMealGroups.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"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-SS,lt-LT",
            "description":"If specified, limits translated strings returned."
        },
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Hierarchy unit unique reference"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of menuItemPrices for the Hierarchy

Body ()

Root Schema : menuItemPrices

Type: object

Model for Menu Item Price object

Show Source

• activeOnMenuLevel(optional): number
  Menu Level Value

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

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

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

  Example: 0.18
• hierUnitId: integer
  Hierarchy unit unique reference

  Example: 1012
• menuItemDefinitionId: integer
  Unique menu item definition reference

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

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

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

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

  Example: 00000000
• prepCost(optional): number
  Preparation cost

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

  Example: 0.18
• priceSequenceNum: integer
  Price record number

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

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

  Example: 0.18

{
    "type":"object",
    "required":[
        "hierUnitId",
        "menuItemDefinitionId",
        "priceSequenceNum"
    ],
    "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 0???s & 1???s representing enabled or disabled options"
        },
        "effectivityGroupObjNum":{
            "type":"number",
            "example":0.18,
            "description":"Effectivity group option numbers"
        }
    },
    "description":"Model for Menu Item Price object"
}

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

404 Response

404 Requested resource not found

Back to Top