Get menu item prices

post

/bi/v1/{orgIdentifier}/getMenuItemPrices

Gets the active menu item prices for a specified location. Active prices are prices with no "effective to" date or prices with a future "effective to" date that is past the current business date.

Request

Path Parameters
Body ()
The request body defines the details of the API request.
Root Schema : mnprRequestPayload
Type: object
Request payload for menu item prices
Show Source
  • Title: Application Name
    Maximum Length: 128
    The name of the application which is accessing the API.

    First Available Version: 20.1.10

  • Title: Effective From Date
    Gets prices with an "effective from" date on or after the specified date. The prices returned can have any "effective to" date (none, in the past, or in the future). When used with the effToDt parameter, the API will return prices that were effective in the range between the "effective from" and "effective to" dates (inclusive). The parameter is limited to the last 3 years from the current business date.
  • Title: Effective To Date
    Gets prices with an "effective to" date on or prior to the specified date. When used with the effFrDt parameter, the API will return prices that were effective in the range between the "effective from" and "effective to" dates (inclusive). The parameter is limited to the last 3 years from the current business date.
  • Title: Include
    List of objects to include in response
  • Title: Location Reference
    The location reference, this may be a store number or name depending on the organization
  • Title: Search Criteria
    Search criteria to filter results based on field value
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : menuItemPriceDimensions
Type: object
The response body contains information about the menu item prices for the specified locatio
Show Source
Nested Schema : Menu Items
Type: array
Title: Menu Items
An array of menu item prices
Show Source
Nested Schema : menuItemPrice
Type: object
The response body contains information about the menu item price for the specified location.
Show Source
  • Title: Cost
    The menu item's cost. This attribute will not be returned in the response if value is 0 or null
  • The price's effective from date. This object will not be present if there is no effective from date.
  • The prices effective to date. This object will not be present if there is no effective to date. This attribute will not be returned in the response if value is null
  • Title: External reference 1 that corresponds to an identifier in a third party system
    Maximum Length: 32
    External reference 1 that corresponds to an identifier in a third party system. This attribute is optional. This attribute will not be returned in the response if value is null.

    First Available Version 20.2

  • Title: External reference 2 that corresponds to an identifier in a third party system
    Maximum Length: 32
    External reference 2 that corresponds to an identifier in a third party system. This attribute is Optional optional. This attribute will not be returned in the response if value is null.

    First Available Version 20.2

  • Title: Number
    Maximum Length: 16
    Menu item number
  • Title: Price Level Name
    Maximum Length: 99
    The price level name of the menu item price. This attribute will not be returned in the response if value is null
  • Title: Price level Number
    Maximum Length: 16
    The price level number of the menu item price
  • Title: Price
    The menu item's price
  • Title: Revenue Center Number
    Maximum Length: 10
    The revenue center number

400 Response

Bad Request
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

401 Response

Unauthorized
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

403 Response

Service Unavailable
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

404 Response

Resource Not Found
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

Default Response

Unexpected Error
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source
Back to Top

Examples

The following example shows how to get the menu item dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL

curl -i -X POST -H "Authorization: Bearer 
  
   " -H "Content-Type:application/json" -d {"locRef":"1234"} https://baseurl/bi/v1/orgidentifier/getMenuItemPrices 
  

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK  Date: Tue, 20 Oct 2020 21:24:33 GMT  Transfer-Encoding: chunked  Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
 "locRef": "1234",
 "menuItemPrices":[{
  "num": 15253,
  "rvcNum": 421,
  "prcLvlNum": 3,
  "prcLvlName": "level",
  "price": 1234.56,
  "cost": 1234.56,
  "effFrDt": "2018-10-18",
  "effToDt": "2019-07-29"
  "extRef1": "567abc",
  "extRef2": "789def01"
 }]
}
Back to Top