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/menuItemPricesGetResponse"
            }
        },
        "offset":{
            "type":"integer",
            "example":"0",
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":"10",
            "description":"Server page size"
        }
    }
}

Show Source

• Array of: object menuItemPricesGetResponse
  Model for Menu Item Price object

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

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

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

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