Get menu items
post
/bi/v1/{orgIdentifier}/getMenuItemDimensions
Gets menu item dimensions for a specified location.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : locRequestPayload
Type:
objectRequest payload with location reference
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
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/getMenuItemDimensions
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,
"menuItems":[{
"num": 15253,
"name: "Hamburger",
"catGrpHierName1": "Menu Item Category Hierarchy 1",
"catGrpName1": "Menu Item Category Group 1",
"catGrpHierName2": "Menu Item Category Hierarchy 2",
"catGrpName2": "Menu Item Category Group 2",
"catGrpHierName3": "Menu Item Category Hierarchy 3",
"catGrpName3": "Menu Item Category Group 3",
"catGrpHierName4": "Menu Item Category Hierarchy 4",
"catGrpName4": "Menu Item Category Group 4",
"majGrpNum": 49469,
"majGrpName": "Food",
"famGrpNum": 261486,
"famGrpName": "Sides",
"majGrpMstrNum": 49469,
"majGrpMstrName": "Food",
"mgCatGrpHierName1": "Major Group Category Hierarchy 1",
"mgCatGrpName1": "Major Group Category Group 1",
"mgCatGrpHierName2": "Major Group Category Hierarchy 2",
"mgCatGrpName2": "Major Group Category Group 2",
"mgCatGrpHierName3": "Major Group Category Hierarchy 3",
"mgCatGrpName3": "Major Group Category Group 3",
"mgCatGrpHierName4": "Major Group Category Hierarchy 4",
"mgCatGrpName4": "Major Group Category Group 4",
"famGrpMstrNum": 261486,
"famGrpMstrName": "Sides",
"fgCatGrpHierName1": "Family Group Category Hierarchy 1",
"fgCatGrpName1": "Family Group Category Group 1",
"fgCatGrpHierName2": "Family Group Category Hierarchy 2",
"fgCatGrpName2": "Family Group Category Group 2",
"fgCatGrpHierName3": "Family Group Category Hierarchy 3",
"fgCatGrpName3": "Family Group Category Group 3",
"fgCatGrpHierName4": "Family Group Category Hierarchy 4",
"fgCatGrpName4": "Family Group Category Group 4",
"doNotIncludeInSales": false,
"category": "Gift Card",
"revFlag": true
"extRef1": "567abc",
"extRef2": "789def01"
}]
}