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
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : mnprRequestPayload
Type:
objectRequest payload for menu item prices
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
effFrDt:
string(date)
Title:
Effective From DateGets 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. -
effToDt:
string(date)
Title:
Effective To DateGets 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. -
include:
string
Title:
IncludeList of objects to include in response -
locRef(required):
string
Title:
Location ReferenceThe location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaSearch criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
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"
}]
}