Get Single Menu
Returns details of a particular menu based on its unique identifier and other query parameters.
Path parameters
-
menuId integer(int64) Required
Unique identifier for the menu.
Query parameters
-
businessLocationId integer(int64) Required
The unique identifier of the business location.
-
accountProfile string
The account profile
code
. Item prices returned will be those associated with this account profile, when applicable. See Guide for more details.Default value is empty.
-
richContent boolean
Query parameter to include rich content of menu items.
Default value is
false
.
Responses
-
• 200 application/json
Successful retrieval of menu details.
Hide response attributes Show response attributes object-
menuName string
The name of the menu.
-
menuEntryGroups array[object]
Menu groups of this menu. The top-level entry will always be of type "group", representing a menu screen. Beneath each
menuEntryGroup
will be amenuEntry
array containing any combination of one or more menu entries:- A
menuItemEntry
represents an individual item. - A
menuGroupEntry
represents a menu sub-screen. - A
menuDealEntry
represents a combo.
Hide menuEntryGroups attributes Show menuEntryGroups attributes object-
@type string
Indicates this is a menu group, which represents a menu screen in the POS.
Value is
group
. -
id string
The menu group ID.
-
name string
The menu group name.
-
color string
The color of the button in the POS.
-
menuEntry array[object]
Array of menu entry objects.
One of: Hide attributes Show attributes-
@type string Discriminator
Indicates this is an individual item.
Value is
menuItem
. -
productName string
The name of the item.
-
productPrice number
The price of the item.
-
color string
The color of the menu button for this item.
-
sku string
The SKU of the item.
-
customItemNameEnabled boolean
Whether the name of the item can be customized.
-
pricingStrategy string
The pricing type of the item.
Values are
CUSTOMIZED_ITEM_PRICE_WILL_BE_NEGATIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_POSTIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_A_PERCENTAGE_OF_TOTAL
, orPRICE_CANNOT_BE_CUSTOMIZED
. -
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
defaultTaxAmount number
The tax amount as calculated at the default tax rate.
-
defaultTaxPercentage number
The default tax percentage for this item.
-
taxIncludedInPrice boolean
Whether or not tax is included in the price of the item.
-
asSubItem boolean
Indicates whether or not this product is a sub-item that cannot be sold alone. Note - when the item is nested under a
menuDeal
this will always be false. -
productionInstructionList array[object]
Array of production instructions for this product
Hide productionInstructionList attributes Show productionInstructionList attributes object-
multiSelectionPermitted boolean
Specifies if more than one production instruction can be selected for this group.
-
The group name for this production instruction.
-
productionIntructionGroupId integer(int64)
The unique identifier for this production instruction group.
-
productionInstructionList array[object]
Array of production instructions for this group
Hide productionInstructionList attributes Show productionInstructionList attributes object-
instruction string
The name of the production instruction.
-
ikentooModifierId integer(int64)
The unique identifier of this production instruction.
-
-
Hide attributes Show attributes-
@type string Discriminator
Indicates the item is a Combo.
Value is
menuDeal
. -
items array[object]
List of items to select from.
Hide items attributes Show items attributes object-
@type string
Indicates this is an individual item.
Value is
menuItem
. -
productName string
The name of the item.
-
productPrice number
The price of the item.
-
color string
The color of the menu button for this item.
-
sku string
The SKU of the item.
-
customItemNameEnabled boolean
Whether the name of the item can be customized.
-
pricingStrategy string
The pricing type of the item.
Values are
CUSTOMIZED_ITEM_PRICE_WILL_BE_NEGATIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_POSTIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_A_PERCENTAGE_OF_TOTAL
, orPRICE_CANNOT_BE_CUSTOMIZED
. -
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
defaultTaxAmount number
The tax amount as calculated at the default tax rate.
-
defaultTaxPercentage number
The default tax percentage for this item.
-
taxIncludedInPrice boolean
Whether or not tax is included in the price of the item.
-
asSubItem boolean
Indicates whether or not this product is a sub-item that cannot be sold alone. Note - when the item is nested under a
menuDeal
this will always be false. -
productionInstructionList array[object]
Array of production instructions for this product
Hide productionInstructionList attributes Show productionInstructionList attributes object-
multiSelectionPermitted boolean
Specifies if more than one production instruction can be selected for this group.
-
The group name for this production instruction.
-
productionIntructionGroupId integer(int64)
The unique identifier for this production instruction group.
-
productionInstructionList array[object]
Array of production instructions for this group
Hide productionInstructionList attributes Show productionInstructionList attributes object-
instruction string
The name of the production instruction.
-
ikentooModifierId integer(int64)
The unique identifier of this production instruction.
-
-
-
-
menuDealGroups array[object]
Collections of item groups within the combo to select from.
Hide menuDealGroups attributes Show menuDealGroups attributes object-
description string
Description of the combo item grouping.
-
sku string
The SKU of the combo item grouping.
-
mustSelectAnItem boolean
Whether or not this is a required selection.
-
multiSelectionPermitted boolean
Whether or not multiple items can be selected from this item grouping.
-
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
items array[object]
List of items to select from.
Hide items attributes Show items attributes object-
@type string
Indicates this is an individual item.
Value is
menuItem
. -
productName string
The name of the item.
-
productPrice number
The price of the item.
-
color string
The color of the menu button for this item.
-
sku string
The SKU of the item.
-
customItemNameEnabled boolean
Whether the name of the item can be customized.
-
pricingStrategy string
The pricing type of the item.
Values are
CUSTOMIZED_ITEM_PRICE_WILL_BE_NEGATIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_POSTIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_A_PERCENTAGE_OF_TOTAL
, orPRICE_CANNOT_BE_CUSTOMIZED
. -
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
defaultTaxAmount number
The tax amount as calculated at the default tax rate.
-
defaultTaxPercentage number
The default tax percentage for this item.
-
taxIncludedInPrice boolean
Whether or not tax is included in the price of the item.
-
asSubItem boolean
Indicates whether or not this product is a sub-item that cannot be sold alone. Note - when the item is nested under a
menuDeal
this will always be false. -
productionInstructionList array[object]
Array of production instructions for this product
Hide productionInstructionList attributes Show productionInstructionList attributes object-
multiSelectionPermitted boolean
Specifies if more than one production instruction can be selected for this group.
-
The group name for this production instruction.
-
productionIntructionGroupId integer(int64)
The unique identifier for this production instruction group.
-
productionInstructionList array[object]
Array of production instructions for this group
Hide productionInstructionList attributes Show productionInstructionList attributes object-
instruction string
The name of the production instruction.
-
ikentooModifierId integer(int64)
The unique identifier of this production instruction.
-
-
-
-
-
productName string
The name of the item.
-
productPrice number
The price of the item.
-
color string
The color of the menu button for this item.
-
sku string
The SKU of the item.
-
customItemNameEnabled boolean
Whether the name of the item can be customized.
-
pricingStrategy string
The pricing type of the item.
Values are
CUSTOMIZED_ITEM_PRICE_WILL_BE_NEGATIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_POSTIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_A_PERCENTAGE_OF_TOTAL
, orPRICE_CANNOT_BE_CUSTOMIZED
. -
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
defaultTaxAmount number
The tax amount as calculated at the default tax rate.
-
defaultTaxPercentage number
The default tax percentage for this item.
-
taxIncludedInPrice boolean
Whether or not tax is included in the price of the item.
Hide attributes Show attributes-
@type string Discriminator
Indicates this is a sub-screen of the menu in the POS. The object will have the same structure as the
menuEntryGroups
object and may contain any of the threemenuEntry
types.Value is
group
. -
id string
The menu group ID.
-
name string
The menu group name.
-
color string
The color of the button in the POS.
-
menuEntry array[object]
Array of menu entry objects.
One of: Hide attributes Show attributes-
@type string Discriminator
Indicates this is an individual item.
Value is
menuItem
. -
productName string
The name of the item.
-
productPrice number
The price of the item.
-
color string
The color of the menu button for this item.
-
sku string
The SKU of the item.
-
customItemNameEnabled boolean
Whether the name of the item can be customized.
-
pricingStrategy string
The pricing type of the item.
Values are
CUSTOMIZED_ITEM_PRICE_WILL_BE_NEGATIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_POSTIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_A_PERCENTAGE_OF_TOTAL
, orPRICE_CANNOT_BE_CUSTOMIZED
. -
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
defaultTaxAmount number
The tax amount as calculated at the default tax rate.
-
defaultTaxPercentage number
The default tax percentage for this item.
-
taxIncludedInPrice boolean
Whether or not tax is included in the price of the item.
-
asSubItem boolean
Indicates whether or not this product is a sub-item that cannot be sold alone. Note - when the item is nested under a
menuDeal
this will always be false. -
productionInstructionList array[object]
Array of production instructions for this product
Hide productionInstructionList attributes Show productionInstructionList attributes object-
multiSelectionPermitted boolean
Specifies if more than one production instruction can be selected for this group.
-
The group name for this production instruction.
-
productionIntructionGroupId integer(int64)
The unique identifier for this production instruction group.
-
productionInstructionList array[object]
Array of production instructions for this group
Hide productionInstructionList attributes Show productionInstructionList attributes object-
instruction string
The name of the production instruction.
-
ikentooModifierId integer(int64)
The unique identifier of this production instruction.
-
-
Hide attributes Show attributes-
@type string Discriminator
Indicates the item is a Combo.
Value is
menuDeal
. -
items array[object]
List of items to select from.
Hide items attributes Show items attributes object-
@type string
Indicates this is an individual item.
Value is
menuItem
. -
productName string
The name of the item.
-
productPrice number
The price of the item.
-
color string
The color of the menu button for this item.
-
sku string
The SKU of the item.
-
customItemNameEnabled boolean
Whether the name of the item can be customized.
-
pricingStrategy string
The pricing type of the item.
Values are
CUSTOMIZED_ITEM_PRICE_WILL_BE_NEGATIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_POSTIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_A_PERCENTAGE_OF_TOTAL
, orPRICE_CANNOT_BE_CUSTOMIZED
. -
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
defaultTaxAmount number
The tax amount as calculated at the default tax rate.
-
defaultTaxPercentage number
The default tax percentage for this item.
-
taxIncludedInPrice boolean
Whether or not tax is included in the price of the item.
-
asSubItem boolean
Indicates whether or not this product is a sub-item that cannot be sold alone. Note - when the item is nested under a
menuDeal
this will always be false. -
productionInstructionList array[object]
Array of production instructions for this product
Hide productionInstructionList attributes Show productionInstructionList attributes object-
multiSelectionPermitted boolean
Specifies if more than one production instruction can be selected for this group.
-
The group name for this production instruction.
-
productionIntructionGroupId integer(int64)
The unique identifier for this production instruction group.
-
productionInstructionList array[object]
Array of production instructions for this group
Hide productionInstructionList attributes Show productionInstructionList attributes object-
instruction string
The name of the production instruction.
-
ikentooModifierId integer(int64)
The unique identifier of this production instruction.
-
-
-
-
menuDealGroups array[object]
Collections of item groups within the combo to select from.
Hide menuDealGroups attributes Show menuDealGroups attributes object-
description string
Description of the combo item grouping.
-
sku string
The SKU of the combo item grouping.
-
mustSelectAnItem boolean
Whether or not this is a required selection.
-
multiSelectionPermitted boolean
Whether or not multiple items can be selected from this item grouping.
-
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
items array[object]
List of items to select from.
Hide items attributes Show items attributes object-
@type string
Indicates this is an individual item.
Value is
menuItem
. -
productName string
The name of the item.
-
productPrice number
The price of the item.
-
color string
The color of the menu button for this item.
-
sku string
The SKU of the item.
-
customItemNameEnabled boolean
Whether the name of the item can be customized.
-
pricingStrategy string
The pricing type of the item.
Values are
CUSTOMIZED_ITEM_PRICE_WILL_BE_NEGATIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_POSTIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_A_PERCENTAGE_OF_TOTAL
, orPRICE_CANNOT_BE_CUSTOMIZED
. -
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
defaultTaxAmount number
The tax amount as calculated at the default tax rate.
-
defaultTaxPercentage number
The default tax percentage for this item.
-
taxIncludedInPrice boolean
Whether or not tax is included in the price of the item.
-
asSubItem boolean
Indicates whether or not this product is a sub-item that cannot be sold alone. Note - when the item is nested under a
menuDeal
this will always be false. -
productionInstructionList array[object]
Array of production instructions for this product
Hide productionInstructionList attributes Show productionInstructionList attributes object-
multiSelectionPermitted boolean
Specifies if more than one production instruction can be selected for this group.
-
The group name for this production instruction.
-
productionIntructionGroupId integer(int64)
The unique identifier for this production instruction group.
-
productionInstructionList array[object]
Array of production instructions for this group
Hide productionInstructionList attributes Show productionInstructionList attributes object-
instruction string
The name of the production instruction.
-
ikentooModifierId integer(int64)
The unique identifier of this production instruction.
-
-
-
-
-
productName string
The name of the item.
-
productPrice number
The price of the item.
-
color string
The color of the menu button for this item.
-
sku string
The SKU of the item.
-
customItemNameEnabled boolean
Whether the name of the item can be customized.
-
pricingStrategy string
The pricing type of the item.
Values are
CUSTOMIZED_ITEM_PRICE_WILL_BE_NEGATIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_POSTIVE
,CUSTOMIZED_ITEM_PRICE_WILL_BE_A_PERCENTAGE_OF_TOTAL
, orPRICE_CANNOT_BE_CUSTOMIZED
. -
itemRichData objectHide itemRichData attributes Show itemRichData attributes
-
squareImageUrl string
A download link for the image associated with this item, as formatted for display in the POS.
-
rawImageUrl string
A download link for the image associated with this item.
-
texts array[object]Hide texts attributes Show texts attributes object
-
locale string
The two letter language code associated with this item text.
-
friendlyDisplayName string
The display name for this item in the configured language.
-
description string
The descriptive text for this item in the configured language.
-
-
allergenCodes array[string]
The allergen codes associated with this item.
-
-
defaultTaxAmount number
The tax amount as calculated at the default tax rate.
-
defaultTaxPercentage number
The default tax percentage for this item.
-
taxIncludedInPrice boolean
Whether or not tax is included in the price of the item.
-
-
- A
-
richDataMissing boolean
Indicates whether or not rich item data is missing, if requested.
-
ikentooMenuId integer(int64)
The unique identifier for the menu.
-
-
• 503 */*
Service Unavailable
Hide response attributes Show response attributes object-
status string
Value is
503
. -
timestamp string(date-time)
-
message string
-
apiSubExceptions array[object]Hide apiSubExceptions attributes Show apiSubExceptions attributes object
-
field string
-
rejectedValue string
-
message string
-
-
curl \
-X GET https://api.trial.lsk.lightspeed.app/o/op/1/menu/load/141948669132851?businessLocationId=45454565682155 \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"menuName": "Main Menu",
"menuEntryGroups": [
{
"@type": "group",
"id": "141948669133028",
"name": "Mains",
"color": "blue",
"menuEntry": [
{
"@type": "menuItem",
"productName": "Burger",
"productPrice": 10.0,
"color": "blue",
"sku": "25",
"customItemNameEnabled": false,
"pricingStrategy": "PRICE_CANNOT_BE_CUSTOMIZED",
"itemRichData": {
"squareImageUrl": "http://s3-eu-west-1.amazonaws.com/com.ikentoo.trial.rich-content-store/8262_2f6c1716-0f06-488c-afc2-d888666d94fb.image/png",
"rawImageUrl": "http://s3-eu-west-1.amazonaws.com/com.ikentoo.trial.rich-content-store/8262_2f6c1716-0f06-488c-afc2-d888666d94fb_raw.image/png",
"texts": [
{
"locale": "en",
"friendlyDisplayName": "Burger - ENG",
"description": "<p>Burger in english</p>"
}
],
"allergenCodes": [
"mustard",
"cereals"
]
},
"defaultTaxAmount": 1.5,
"defaultTaxPercentage": 15.0,
"taxIncludedInPrice": false,
"asSubItem": true,
"productionInstructionList": [
{
"multiSelectionPermitted": false,
"productionInstructionGroupName": "Meat cooking",
"productionIntructionGroupId": 236025632784487,
"productionInstructionList": [
{
"instruction": "Bleu",
"ikentooModifierId": 236025632784488
},
{
"instruction": "Rare",
"ikentooModifierId": 236025632784490
},
{
"instruction": "Medium Rare",
"ikentooModifierId": 236025632784492
},
{
"instruction": "Medium",
"ikentooModifierId": 236025632784494
},
{
"instruction": "Medium well",
"ikentooModifierId": 236025632784496
},
{
"instruction": "Well done",
"ikentooModifierId": 236025632784498
}
]
}
]
}
]
}
],
"richDataMissing": false,
"ikentooMenuId": 141948669132851
}