Jump to

• Request
• Response
• Examples

Get a menu

get

/api/v1/menus/{menuId}

{basePath}/menus/1233

API returns menu. A menu describes the set of items that can be ordered from a revenue center. The menu includes the menu items, prices, and related information necessary to order an item.

Request

Supported Media Types

• application/json

Path Parameters

• menuId(required): string
  The identifier for an individual menu.

Header Parameters

• If-Modified-Since: string
  Standard http caching header (http caching link).
• If-None-Match: string
  Standard http caching header (http caching link).
• Simphony-LocRef(required): string
  The location identifier.
• Simphony-OrgShortName(required): string
  The organization identifier.
• Simphony-RvcRef(required): integer
  The revenue center identifier.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A Menu

Headers

• ETag: string
  The current entity-tag for the selected representation. See RFC 7232 Section 2.3
• Last-Modified: string
  A timestamp indicating the date and time at which the origin server believes the selected representation was last modified. See RFC 7232 Section 2.2

Body ()

Root Schema : Menu

Type: object

A menu is a collection of the Menu Items and Condiments that are used to create an order. The menu provides information about the price of the items and the rules to follow for applying condiments to menu items.

Show Source

• allergens: array allergens
  Array of allergens.
• comboMeals: array comboMeals
  Array of combo meals.
• condimentGroups: array condimentGroups
  Array of contiment groups.
• condimentItems: array condimentItems
  Array of condiment items.
• familyGroups: array familyGroups
  Array of family groups.
• menuItems: array menuItems
  Array of menu items.
• MenuSummaryProperties: object MenuSummaryProperties

{
    "description":"A menu is a collection of the Menu Items and Condiments that are used to create an order. The menu provides information about the price of the items and the rules to follow for applying condiments to menu items. \n",
    "type":"object",
    "properties":{
        "MenuSummaryProperties":{
            "$ref":"#/definitions/MenuSummaryProperties"
        },
        "menuItems":{
            "description":"Array of menu items.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/MenuItem"
            }
        },
        "comboMeals":{
            "description":"Array of combo meals.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ComboMealItem"
            }
        },
        "condimentItems":{
            "description":"Array of condiment items.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CondimentItem"
            }
        },
        "condimentGroups":{
            "description":"Array of contiment groups.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CondimentGroup"
            }
        },
        "familyGroups":{
            "description":"Array of family groups.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/FamilyGroupItem"
            }
        },
        "allergens":{
            "description":"Array of allergens.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Allergen"
            }
        }
    }
}

Nested Schema : allergens

Type: array

Array of allergens.

Show Source

• Array of: object Allergen
  Model for an allergen

{
    "description":"Array of allergens.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Allergen"
    }
}

Nested Schema : comboMeals

Type: array

Array of combo meals.

Show Source

• Array of: object ComboMealItem
  A Combo Meal that can be ordered.

{
    "description":"Array of combo meals.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ComboMealItem"
    }
}

Nested Schema : condimentGroups

Type: array

Array of contiment groups.

Show Source

• Array of: object CondimentGroup
  A group that references one-or-more condiment items.

{
    "description":"Array of contiment groups.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CondimentGroup"
    }
}

Nested Schema : condimentItems

Type: array

Array of condiment items.

Show Source

• Array of: object CondimentItem
  A Condiment Item is an item used to provide information about how a menu item is prepared. Condiments may have prices that add to price of the item it modifies. Condiments may also have default condiments and its condiment modifications, e.g., a Steak with Salad option that has a dressing option.

{
    "description":"Array of condiment items.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CondimentItem"
    }
}

Nested Schema : familyGroups

Type: array

Array of family groups.

Show Source

• Array of: object FamilyGroupItem
  Model for a Family Group

{
    "description":"Array of family groups.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/FamilyGroupItem"
    }
}

Nested Schema : menuItems

Type: array

Array of menu items.

Show Source

• Array of: object MenuItem
  A Menu Item is an item that is ordered.

{
    "description":"Array of menu items.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/MenuItem"
    }
}

Nested Schema : MenuSummaryProperties

Type: object

Show Source

• description: string
  A description of the menu
• menuId(required): string
  Menu Identifier

  Example: myb:store2:dining
• name(required): string
  Menu name

  Example: 1
• OrgLocRvcProperties: object OrgLocRvcProperties
  A collection of properties for orgShortName, locRef and rvcRef

{
    "type":"object",
    "required":[
        "menuId",
        "name"
    ],
    "properties":{
        "OrgLocRvcProperties":{
            "$ref":"#/definitions/OrgLocRvcProperties"
        },
        "menuId":{
            "description":"Menu Identifier",
            "type":"string",
            "example":"myb:store2:dining"
        },
        "name":{
            "description":"Menu name",
            "type":"string",
            "example":"1"
        },
        "description":{
            "description":"A description of the menu",
            "type":"string"
        }
    }
}

Nested Schema : Allergen

Type: object

Model for an allergen

Show Source

• allergenId(required): string
  Identifier for an allergen
• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`

{
    "description":"Model for an allergen",
    "type":"object",
    "required":[
        "allergenId"
    ],
    "properties":{
        "allergenId":{
            "description":"Identifier for an allergen",
            "type":"string"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        }
    }
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\nExample:n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\"}`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee"
}

Nested Schema : ComboMealItem

Type: object

A Combo Meal that can be ordered.

Show Source

• comboGroups(required): array comboGroups
  Array of Combo Group items from which user will make selections to complete definition of the combo.
• comboMealId(required): integer
  The combo meal identifier.
• menuItemRef(required): integer
  A reference to the main item used when ordering a combo meal.
• name(required): string
  Name of the combo meal item.

{
    "description":"A Combo Meal that can be ordered.\n",
    "type":"object",
    "required":[
        "comboMealId",
        "name",
        "menuItemRef",
        "comboGroups"
    ],
    "properties":{
        "comboMealId":{
            "description":"The combo meal identifier.\n",
            "type":"integer"
        },
        "name":{
            "description":"Name of the combo meal item.\n",
            "type":"string"
        },
        "menuItemRef":{
            "description":"A reference to the main item used when ordering a combo meal.\n",
            "type":"integer"
        },
        "comboGroups":{
            "description":"Array of Combo Group items from which user will make selections to complete definition of the combo.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ComboGroupItem"
            }
        }
    }
}

Nested Schema : comboGroups

Type: array

Array of Combo Group items from which user will make selections to complete definition of the combo.

Show Source

• Array of: object ComboGroupItem
  A Combo Group.

{
    "description":"Array of Combo Group items from which user will make selections to complete definition of the combo.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ComboGroupItem"
    }
}

Nested Schema : ComboGroupItem

Type: object

A Combo Group.

Show Source

• comboGroupId(required): integer
  The combo group identifier.
• count: integer
  The number of items to select from the group when adding the combo meal to a check.
• isMainGroup: boolean
  When true, indicates this group is the "main group". Options: true or false.
• menuItems(required): array menuItems
  The collection of menu items that are selected when picking items from this combo group. Array of Combo Menu Items.
• name(required): string
  The name of the combo group.
• prices(required): array prices
  An array of zero or more prices for the combo menu item.

{
    "description":"A Combo Group.\n",
    "type":"object",
    "required":[
        "comboGroupId",
        "name",
        "prices",
        "menuItems"
    ],
    "properties":{
        "comboGroupId":{
            "description":"The combo group identifier.\n",
            "type":"integer"
        },
        "name":{
            "description":"The name of the combo group.\n",
            "type":"string"
        },
        "count":{
            "description":"The number of items to select from the group when adding the combo meal to a check.\n",
            "type":"integer"
        },
        "isMainGroup":{
            "description":"When true, indicates this group is the \"main group\". Options: true or false.\n",
            "type":"boolean"
        },
        "prices":{
            "description":"An array of zero or more prices for the combo menu item.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ComboMenuItemPrice"
            }
        },
        "menuItems":{
            "description":"The collection of menu items that are selected when picking items from this combo group. Array of Combo Menu Items.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ComboMenuItem"
            }
        }
    }
}

Nested Schema : menuItems

Type: array

The collection of menu items that are selected when picking items from this combo group. Array of Combo Menu Items.

Show Source

• Array of: object ComboMenuItem
  A menu item which is part of a combo meal.

{
    "description":"The collection of menu items that are selected when picking items from this combo group. Array of Combo Menu Items.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ComboMenuItem"
    }
}

Nested Schema : prices

Type: array

An array of zero or more prices for the combo menu item.

Show Source

• Array of: array ComboMenuItemPrice
  Combo menu item price is the amount charged for the sale of a combo menu item.

{
    "description":"An array of zero or more prices for the combo menu item.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ComboMenuItemPrice"
    }
}

Nested Schema : ComboMenuItem

Type: object

A menu item which is part of a combo meal.

Show Source

• count: integer
  The number of items to select from the group when adding the combo meal to a check.
• menuItemRef(required): integer
  The identifier of the menu item that represents this side item.
• prices(required): array prices
  An array of zero or more prices for the combo menu item.

{
    "description":"A menu item which is part of a combo meal.\n",
    "type":"object",
    "required":[
        "menuItemRef",
        "prices"
    ],
    "properties":{
        "menuItemRef":{
            "description":"The identifier of the menu item that represents this side item.\n",
            "type":"integer"
        },
        "count":{
            "description":"The number of items to select from the group when adding the combo meal to a check.\n",
            "type":"integer"
        },
        "prices":{
            "description":"An array of zero or more prices for the combo menu item.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ComboMenuItemPrice"
            }
        }
    }
}

Nested Schema : prices

Type: array

An array of zero or more prices for the combo menu item.

Show Source

• Array of: array ComboMenuItemPrice
  Combo menu item price is the amount charged for the sale of a combo menu item.

{
    "description":"An array of zero or more prices for the combo menu item.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ComboMenuItemPrice"
    }
}

Nested Schema : ComboMenuItemPrice

Type: array

Combo menu item price is the amount charged for the sale of a combo menu item.

Show Source

• price(required): number
  The price that can be used when a adding the menu item to a check.
• priceSequence(required): integer
  The price sequence number.

{
    "description":"Combo menu item price is the amount charged for the sale of a combo menu item.\n",
    "type":"array",
    "required":[
        "priceSequence",
        "price"
    ],
    "properties":{
        "priceSequence":{
            "description":"The price sequence number.\n",
            "type":"integer"
        },
        "price":{
            "description":"The price that can be used when a adding the menu item to a check.\n",
            "type":"number"
        }
    }
}

Nested Schema : CondimentGroup

Type: object

A group that references one-or-more condiment items.

Show Source

• condimentGroupId(required): integer
  Condiment Group Identifier.

  Example: 32
• condimentItemRefs(required): array condimentItemRefs
  An array of references to items in the `Menu.condimentItems` collection.
• ConsumerContentProperties: object ConsumerContentProperties
  A collection of consumer based content
• name(required): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`

{
    "description":"A group that references one-or-more condiment items.\n",
    "type":"object",
    "required":[
        "condimentGroupId",
        "name",
        "condimentItemRefs"
    ],
    "properties":{
        "condimentGroupId":{
            "description":"Condiment Group Identifier.\n",
            "type":"integer",
            "example":"32"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "condimentItemRefs":{
            "description":"An array of references to items in the `Menu.condimentItems` collection.\n",
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "ConsumerContentProperties":{
            "$ref":"#/definitions/ConsumerContentProperties"
        }
    }
}

Nested Schema : condimentItemRefs

Type: array

An array of references to items in the `Menu.condimentItems` collection.

Show Source

• Array of: integer

{
    "description":"An array of references to items in the `Menu.condimentItems` collection.\n",
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Nested Schema : ConsumerContentProperties

Type: object

A collection of consumer based content

Show Source

• consumerDescription: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• consumerName: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• images: array images
  Array of images.

{
    "description":"A collection of consumer based content\n",
    "type":"object",
    "properties":{
        "consumerName":{
            "$ref":"#/definitions/TranslatedString"
        },
        "consumerDescription":{
            "$ref":"#/definitions/TranslatedString"
        },
        "images":{
            "description":"Array of images.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ImageLink"
            }
        }
    }
}

Nested Schema : images

Type: array

Array of images.

Show Source

• Array of: object ImageLink
  Represents a link to an image

{
    "description":"Array of images.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ImageLink"
    }
}

Nested Schema : ImageLink

Type: object

Represents a link to an image

Show Source

• altText: string
  Alt text for the image

  Example: pizza
• description: string
  Description text for the image
• index: string
  Unique identifier for the image
• isCloudImage: boolean
• size: string
  Image size
• url(required): string
  URL for the image.

  Example: https://oracleObjectStore.com/images/coffee822815.jpg

{
    "description":"Represents a link to an image",
    "type":"object",
    "required":[
        "url",
        "tags"
    ],
    "properties":{
        "index":{
            "description":"Unique identifier for the image",
            "type":"string"
        },
        "url":{
            "description":"URL for the image.\n",
            "type":"string",
            "example":"https://oracleObjectStore.com/images/coffee822815.jpg"
        },
        "altText":{
            "description":"Alt text for the image",
            "type":"string",
            "example":"pizza"
        },
        "description":{
            "description":"Description text for the image",
            "type":"string"
        },
        "isCloudImage":{
            "type":"boolean"
        },
        "size":{
            "description":"Image size",
            "type":"string"
        }
    }
}

Nested Schema : CondimentItem

Type: object

A Condiment Item is an item used to provide information about how a menu item is prepared. Condiments may have prices that add to price of the item it modifies. Condiments may also have default condiments and its condiment modifications, e.g., a Steak with Salad option that has a dressing option.

Show Source

• condimentId(required): integer
  Condiment Item Identifier

  Example: 32
• definitions(required): array definitions
• dietaryInformation: array dietaryInformation
  Dietary information for this condiment item
• familyGroupRef(required): integer
  Reference to a family group item in menu.familyGroups
• NamedObject: object NamedObject
• tagGroups: array tagGroups
• tags: array tags

{
    "description":"A Condiment Item is an item used to provide information about how a menu item is prepared. Condiments may have prices that add to price of the item it modifies. Condiments may also have default condiments and its condiment modifications, e.g., a Steak with Salad option that has a dressing option.\n",
    "required":[
        "name",
        "condimentId",
        "familyGroupRef",
        "definitions"
    ],
    "type":"object",
    "properties":{
        "NamedObject":{
            "$ref":"#/definitions/NamedObject"
        },
        "condimentId":{
            "description":"Condiment Item Identifier",
            "type":"integer",
            "example":"32"
        },
        "familyGroupRef":{
            "description":"Reference to a family group item in menu.familyGroups\n",
            "type":"integer"
        },
        "definitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CondimentItemDefinition"
            }
        },
        "dietaryInformation":{
            "description":"Dietary information for this condiment item\n",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tagGroups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TagGroup"
            }
        }
    }
}

Nested Schema : definitions

Type: array

Show Source

• Array of: object CondimentItemDefinition
  A condiment item definition contains operational attributes of a condiment item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CondimentItemDefinition"
    }
}

Nested Schema : dietaryInformation

Type: array

Dietary information for this condiment item

Show Source

• Array of: string

{
    "description":"Dietary information for this condiment item\n",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : NamedObject

Type: object

Show Source

• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`

{
    "type":"object",
    "properties":{
        "name":{
            "$ref":"#/definitions/TranslatedString"
        }
    }
}

Nested Schema : tagGroups

Type: array

Show Source

• Array of: object TagGroup
  A group of tags

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TagGroup"
    }
}

Nested Schema : tags

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : CondimentItemDefinition

Type: object

A condiment item definition contains operational attributes of a condiment item.

Show Source

• allergens: array allergens
  List of identifiers that references allergens that apply to this condiment item.
• ConsumerContentProperties: object ConsumerContentProperties
  A collection of consumer based content
• extensions: object ExtensionData
  Additional Properties Allowed: additionalProperties

  Container for extension data
• name2(required): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• NamedObject: object NamedObject
• number(required): integer
  The number of the definition. This value is used when ordering the item.
• nutritionalData: array nutritionalData
  List of nutritional Data that apply to this condiment item.
• options: array options
  A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.)
• prices: array prices
  Collection of prices that can be used when ordering a condiment item.
• slus: array slus
  A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.
• tagGroups: array tagGroups
• tags: array tags
  List of tags that apply to this condiment item.

{
    "description":"A condiment item definition contains operational attributes of a condiment item.\n",
    "required":[
        "number",
        "name",
        "name2"
    ],
    "type":"object",
    "properties":{
        "number":{
            "description":"The number of the definition. This value is used when ordering the item.\n",
            "type":"integer"
        },
        "NamedObject":{
            "$ref":"#/definitions/NamedObject"
        },
        "name2":{
            "$ref":"#/definitions/TranslatedString"
        },
        "slus":{
            "description":"A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScreenLookup"
            }
        },
        "prices":{
            "description":"Collection of prices that can be used when ordering a condiment item.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/MenuItemPrice"
            }
        },
        "ConsumerContentProperties":{
            "$ref":"#/definitions/ConsumerContentProperties"
        },
        "allergens":{
            "description":"List of identifiers that references allergens that apply to this condiment item.\n",
            "example":[
                "milk",
                "peanut"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "nutritionalData":{
            "description":"List of nutritional Data that apply to this condiment item.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/NutritionalData"
            }
        },
        "options":{
            "description":"A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.)\n",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "containsAlcohol"
                ]
            }
        },
        "tags":{
            "description":"List of tags that apply to this condiment item.\n",
            "example":[
                "hot",
                "cold"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tagGroups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TagGroup"
            }
        },
        "extensions":{
            "$ref":"#/definitions/ExtensionData"
        }
    }
}

Nested Schema : allergens

Type: array

List of identifiers that references allergens that apply to this condiment item.

Show Source

• Array of: string

{
    "description":"List of identifiers that references allergens that apply to this condiment item.\n",
    "example":[
        "milk",
        "peanut"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example:

[
    "milk",
    "peanut"
]

Nested Schema : ExtensionData

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"Container for extension data",
    "additionalProperties":{
        "type":"object"
    }
}

Container for extension data

Nested Schema : nutritionalData

Type: array

List of nutritional Data that apply to this condiment item.

Show Source

• Array of: object NutritionalData
  Nutritional data for a menu item. It is assumed that nutritional items are defined where the serving size is one of the menu item.

{
    "description":"List of nutritional Data that apply to this condiment item.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/NutritionalData"
    }
}

Nested Schema : options

Type: array

A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.)

Show Source

• Array of: string
  Allowed Values: [ "containsAlcohol" ]

{
    "description":"A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.)\n",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "containsAlcohol"
        ]
    }
}

Nested Schema : prices

Type: array

Collection of prices that can be used when ordering a condiment item.

Show Source

• Array of: object MenuItemPrice
  Represents a price for a menu item.

{
    "description":"Collection of prices that can be used when ordering a condiment item.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/MenuItemPrice"
    }
}

Nested Schema : slus

Type: array

A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.

Show Source

• Array of: object ScreenLookup
  Information about a Screen Lookup (SLU)

{
    "description":"A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScreenLookup"
    }
}

Nested Schema : tagGroups

Type: array

Show Source

• Array of: object TagGroup
  A group of tags

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TagGroup"
    }
}

Nested Schema : tags

Type: array

List of tags that apply to this condiment item.

Show Source

• Array of: string

{
    "description":"List of tags that apply to this condiment item.\n",
    "example":[
        "hot",
        "cold"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example:

[
    "hot",
    "cold"
]

Nested Schema : additionalProperties

Type: object

Nested Schema : NutritionalData

Type: object

Nutritional data for a menu item. It is assumed that nutritional items are defined where the serving size is one of the menu item.

Show Source

• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• nutritionalItemId: string
  Identifier for the nutritional item

  Example: fat, sodium
• unitOfMeasure: string
  unit of measure for the nutritional item

  Example: grams, milligrams, calorie
• value: number
  The amount of the nutritional item associated with the menu item.

  Example: 475

{
    "description":"Nutritional data for a menu item. It is assumed that nutritional items are defined where the serving size is one of the menu item.\n",
    "type":"object",
    "properties":{
        "nutritionalItemId":{
            "description":"Identifier for the nutritional item",
            "type":"string",
            "example":"fat, sodium"
        },
        "value":{
            "description":"The amount of the nutritional item associated with the menu item.\n",
            "type":"number",
            "example":"475"
        },
        "unitOfMeasure":{
            "description":"unit of measure for the nutritional item",
            "type":"string",
            "example":"grams, milligrams, calorie"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        }
    }
}

Nested Schema : MenuItemPrice

Type: object

Represents a price for a menu item.

Show Source

• name: string
  Describes some facet of the price; an example might be a size.
• price(required): number
  The price that can be used when a adding the menu item to a check.
• priceSequence(required): integer
  The price sequence

{
    "description":"Represents a price for a menu item.\n",
    "type":"object",
    "required":[
        "priceSequence",
        "price"
    ],
    "properties":{
        "priceSequence":{
            "description":"The price sequence",
            "type":"integer"
        },
        "price":{
            "description":"The price that can be used when a adding the menu item to a check.\n",
            "type":"number"
        },
        "name":{
            "description":"Describes some facet of the price; an example might be a size.\n",
            "type":"string"
        }
    }
}

Nested Schema : ScreenLookup

Type: object

Information about a Screen Lookup (SLU)

Show Source

• images: array images
  Array of images.
• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• sluId(required): integer
  The identifier (SluIndex) of the SLU
• sluNumber(required): integer
  Represents the SLUn property name of the POS menu item definition. SLU2 is sluNumber = 2, SLU8 is sluNumber = 8 etc. SLU is sluNumber = 1.

{
    "description":"Information about a Screen Lookup (SLU)",
    "type":"object",
    "required":[
        "sluNumber",
        "sluId"
    ],
    "properties":{
        "sluNumber":{
            "description":"Represents the SLUn property name of the POS menu item definition. SLU2 is sluNumber = 2, SLU8 is sluNumber = 8 etc. SLU is sluNumber = 1.\n",
            "type":"integer"
        },
        "sluId":{
            "description":"The identifier (SluIndex) of the SLU",
            "type":"integer"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "images":{
            "description":"Array of images.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ImageLink"
            }
        }
    }
}

Nested Schema : images

Type: array

Array of images.

Show Source

• Array of: object ImageLink
  Represents a link to an image

{
    "description":"Array of images.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ImageLink"
    }
}

Nested Schema : TagGroup

Type: object

A group of tags

Show Source

• id(required): string
  Unique identifier for the tag group
• tags(required): array tags
  The tags in this tag group, can be empty

{
    "description":"A group of tags",
    "type":"object",
    "required":[
        "id",
        "tags"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier for the tag group",
            "type":"string"
        },
        "tags":{
            "description":"The tags in this tag group, can be empty",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "spicy",
                "lo-carb"
            ]
        }
    }
}

Nested Schema : tags

Type: array

The tags in this tag group, can be empty

Show Source

• Array of: string

{
    "description":"The tags in this tag group, can be empty",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "spicy",
        "lo-carb"
    ]
}

Example:

[
    "spicy",
    "lo-carb"
]

Nested Schema : FamilyGroupItem

Type: object

Model for a Family Group

Show Source

• consumerDescription: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• consumerName: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• familyGroupItemId(required): integer
• images: array images
  Array of images.
• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`

{
    "description":"Model for a Family Group",
    "type":"object",
    "required":[
        "familyGroupItemId"
    ],
    "properties":{
        "familyGroupItemId":{
            "type":"integer"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "consumerName":{
            "$ref":"#/definitions/TranslatedString"
        },
        "consumerDescription":{
            "$ref":"#/definitions/TranslatedString"
        },
        "images":{
            "description":"Array of images.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ImageLink"
            }
        }
    }
}

Nested Schema : images

Type: array

Array of images.

Show Source

• Array of: object ImageLink
  Represents a link to an image

{
    "description":"Array of images.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ImageLink"
    }
}

Nested Schema : MenuItem

Type: object

A Menu Item is an item that is ordered.

Show Source

• definitions(required): array definitions
• dietaryInformation: array dietaryInformation
  Dietary information for this menu item
• familyGroupRef(required): integer
  Reference to a family group item in menu.familyGroups
• menuItemId(required): integer
  Menu Item Identifier

  Example: 32
• NamedObject: object NamedObject
• tagGroups: array tagGroups
  Array of tag groups.
• tags: array tags
  Array of tags.

{
    "description":"A Menu Item is an item that is ordered.\n",
    "required":[
        "name",
        "menuItemId",
        "familyGroupRef",
        "definitions"
    ],
    "type":"object",
    "properties":{
        "NamedObject":{
            "$ref":"#/definitions/NamedObject"
        },
        "menuItemId":{
            "description":"Menu Item Identifier",
            "type":"integer",
            "example":"32"
        },
        "familyGroupRef":{
            "description":"Reference to a family group item in menu.familyGroups\n",
            "type":"integer"
        },
        "definitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MenuItemDefinition"
            }
        },
        "dietaryInformation":{
            "description":"Dietary information for this menu item",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tags":{
            "description":"Array of tags.\n",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tagGroups":{
            "description":"Array of tag groups.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TagGroup"
            }
        }
    }
}

Nested Schema : definitions

Type: array

Show Source

• Array of: object MenuItemDefinition
  A menu item definition contains operational attributes of a menu item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MenuItemDefinition"
    }
}

Nested Schema : dietaryInformation

Type: array

Dietary information for this menu item

Show Source

• Array of: string

{
    "description":"Dietary information for this menu item",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : tagGroups

Type: array

Array of tag groups.

Show Source

• Array of: object TagGroup
  A group of tags

{
    "description":"Array of tag groups.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TagGroup"
    }
}

Nested Schema : tags

Type: array

Array of tags.

Show Source

• Array of: string

{
    "description":"Array of tags.\n",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : MenuItemDefinition

Type: object

A menu item definition contains operational attributes of a menu item.

Show Source

• allergens: array allergens
  List of identifiers that references allergens that apply to this menu item.
• condimentGroupRules: array condimentGroupRules
  Defines a set of condiment groups from which items are selected when adding an the menu item to a guest check.
• consumerAdvisoryText: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• ConsumerContentProperties: object ConsumerContentProperties
  A collection of consumer based content
• defaultCondiments: array defaultCondiments
  The collection of condiments associated with the menu item by default.
• definitionSequence(required): integer
  The number of the definition. This value is used when ordering the item.
• extensions: object ExtensionData
  Additional Properties Allowed: additionalProperties

  Container for extension data
• name2(required): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• NamedObject: object NamedObject
• nutritionalData: array nutritionalData
  A list of nutritional data for the menu item. It is assumed that nutritional items are defined where the serving size is one of the menu item.
• options: array options
  A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.)
• prices: array prices
  Collection of prices that can be uses when ordering a menu item.
• slus: array slus
  A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.
• tagGroups: array tagGroups
• tags: array tags
  List of tags that apply to this menu item.
• taxClassRef: integer
  Reference to tax class definition.

{
    "description":"A menu item definition contains operational attributes of a menu item.\n",
    "required":[
        "definitionSequence",
        "name",
        "name2"
    ],
    "type":"object",
    "properties":{
        "definitionSequence":{
            "description":"The number of the definition. This value is used when ordering the item.\n",
            "type":"integer"
        },
        "NamedObject":{
            "$ref":"#/definitions/NamedObject"
        },
        "name2":{
            "$ref":"#/definitions/TranslatedString"
        },
        "slus":{
            "description":"A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScreenLookup"
            }
        },
        "taxClassRef":{
            "description":"Reference to tax class definition.\n",
            "type":"integer"
        },
        "prices":{
            "description":"Collection of prices that can be uses when ordering a menu item.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/MenuItemPrice"
            }
        },
        "defaultCondiments":{
            "description":"The collection of condiments associated with the menu item by default.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DefaultCondiment"
            }
        },
        "condimentGroupRules":{
            "description":"Defines a set of condiment groups from which items are selected when adding an the menu item to a guest check.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CondimentGroupRule"
            }
        },
        "ConsumerContentProperties":{
            "$ref":"#/definitions/ConsumerContentProperties"
        },
        "consumerAdvisoryText":{
            "$ref":"#/definitions/TranslatedString"
        },
        "allergens":{
            "description":"List of identifiers that references allergens that apply to this menu item.\n",
            "example":[
                "milk",
                "peanut"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "nutritionalData":{
            "description":"A list of nutritional data for the menu item. It is assumed that nutritional items are defined where the serving size is one of the menu item.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/NutritionalData"
            }
        },
        "options":{
            "description":"A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.)\n",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "containsAlcohol"
                ]
            }
        },
        "tags":{
            "description":"List of tags that apply to this menu item.\n",
            "example":[
                "hot",
                "cold"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tagGroups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TagGroup"
            }
        },
        "extensions":{
            "$ref":"#/definitions/ExtensionData"
        }
    }
}

Nested Schema : allergens

Type: array

List of identifiers that references allergens that apply to this menu item.

Show Source

• Array of: string

{
    "description":"List of identifiers that references allergens that apply to this menu item.\n",
    "example":[
        "milk",
        "peanut"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example:

[
    "milk",
    "peanut"
]

Nested Schema : condimentGroupRules

Type: array

Defines a set of condiment groups from which items are selected when adding an the menu item to a guest check.

Show Source

• Array of: object CondimentGroupRule
  Represents a rule for condiment group that describes condiment selection rules used when adding an menu item to a check.

{
    "description":"Defines a set of condiment groups from which items are selected when adding an the menu item to a guest check.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CondimentGroupRule"
    }
}

Nested Schema : defaultCondiments

Type: array

The collection of condiments associated with the menu item by default.

Show Source

• Array of: object DefaultCondiment
  Represents a default condiment for a menu item.

{
    "description":"The collection of condiments associated with the menu item by default.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DefaultCondiment"
    }
}

Nested Schema : nutritionalData

Type: array

A list of nutritional data for the menu item. It is assumed that nutritional items are defined where the serving size is one of the menu item.

Show Source

• Array of: object NutritionalData
  Nutritional data for a menu item. It is assumed that nutritional items are defined where the serving size is one of the menu item.

{
    "description":"A list of nutritional data for the menu item. It is assumed that nutritional items are defined where the serving size is one of the menu item.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/NutritionalData"
    }
}

Nested Schema : options

Type: array

A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.)

Show Source

• Array of: string
  Allowed Values: [ "containsAlcohol" ]

{
    "description":"A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.)\n",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "containsAlcohol"
        ]
    }
}

Nested Schema : prices

Type: array

Collection of prices that can be uses when ordering a menu item.

Show Source

• Array of: object MenuItemPrice
  Represents a price for a menu item.

{
    "description":"Collection of prices that can be uses when ordering a menu item.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/MenuItemPrice"
    }
}

Nested Schema : slus

Type: array

A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.

Show Source

• Array of: object ScreenLookup
  Information about a Screen Lookup (SLU)

{
    "description":"A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScreenLookup"
    }
}

Nested Schema : tagGroups

Type: array

Show Source

• Array of: object TagGroup
  A group of tags

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TagGroup"
    }
}

Nested Schema : tags

Type: array

List of tags that apply to this menu item.

Show Source

• Array of: string

{
    "description":"List of tags that apply to this menu item.\n",
    "example":[
        "hot",
        "cold"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example:

[
    "hot",
    "cold"
]

Nested Schema : CondimentGroupRule

Type: object

Represents a rule for condiment group that describes condiment selection rules used when adding an menu item to a check.

Show Source

• condimentGroupRef(required): integer
  Reference to an item in the `Menu.condimentGroups` collection.

  Example: 5802109
• maximumCount: integer
  The maximum number of items to select from this group when adding the menu item to a check. A value of zero indicates no maximum.

  Example: 0
• minimumCount: integer
  The minimum number of items to select from this group when adding the menu item to a check. A value of zero indicates no minimum and that selection of an item from this group is optional.

  Example: 1

{
    "description":"Represents a rule for condiment group that describes condiment selection rules used when adding an menu item to a check.\n",
    "type":"object",
    "required":[
        "condimentGroupRef"
    ],
    "properties":{
        "condimentGroupRef":{
            "description":"Reference to an item in the `Menu.condimentGroups` collection.\n",
            "type":"integer",
            "example":"5802109"
        },
        "minimumCount":{
            "description":"The minimum number of items to select from this group when adding the menu item to a check. A value of zero indicates no minimum and that selection of an item from this group is optional.\n",
            "type":"integer",
            "example":"1"
        },
        "maximumCount":{
            "description":"The maximum number of items to select from this group when adding the menu item to a check. A value of zero indicates no maximum.\n",
            "type":"integer",
            "example":"0"
        }
    }
}

Nested Schema : DefaultCondiment

Type: object

Represents a default condiment for a menu item.

Show Source

• condimentRef(required): integer
  A reference to the condiment that is a default. This is `condimentId` of an item from the `menu.condimentItems` collection.
• quantity(required): integer
  Minimum Value: 1

  The quantity of condiment applied by default.

{
    "description":"Represents a default condiment for a menu item.\n",
    "type":"object",
    "required":[
        "condimentRef",
        "quantity"
    ],
    "properties":{
        "condimentRef":{
            "description":"A reference to the condiment that is a default. This is `condimentId` of an item from the `menu.condimentItems` collection.\n",
            "type":"integer"
        },
        "quantity":{
            "description":"The quantity of condiment applied by default.\n",
            "type":"integer",
            "minimum":"1"
        }
    }
}

Nested Schema : OrgLocRvcProperties

Type: object

A collection of properties for orgShortName, locRef and rvcRef

Show Source

• locRef(required): string
  Location identifier

  Example: store66
• orgShortName(required): string
  Organization identifier

  Example: mymeal
• rvcRef(required): integer
  Revenue Center identifier

  Example: 2

{
    "description":"A collection of properties for orgShortName, locRef and rvcRef\n",
    "type":"object",
    "required":[
        "orgShortName",
        "locRef",
        "rvcRef"
    ],
    "properties":{
        "orgShortName":{
            "description":"Organization identifier",
            "type":"string",
            "example":"mymeal"
        },
        "locRef":{
            "description":"Location identifier",
            "type":"string",
            "example":"store66"
        },
        "rvcRef":{
            "description":"Revenue Center identifier",
            "type":"integer",
            "example":"2"
        }
    }
}

304 Response

304 Not Modified

400 Response

400 Bad Request

Body ()

Root Schema : ConfigurationApiProblemDetails

Type: object

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). The content type for this response is `application/problem+json`

Show Source

• details: string
  A human-readable explanation specific to this occurrence of the problem.

  Example: The OrgShortName value is required.
• instance: string
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  Example: required_value_missing
• title: string
  A short, human-readable summary of the problem type.

  Example: Required value not specified.
• type: string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: error:validation

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).\n\nThe content type for this response is `application/problem+json`\n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Required value not specified.",
        "details":"The OrgShortName value is required.",
        "instance":"required_value_missing"
    },
    "properties":{
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n",
            "type":"string",
            "example":"error:validation"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.\n",
            "type":"string",
            "example":"Required value not specified.\n"
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.\n",
            "type":"string",
            "example":"The OrgShortName value is required.\n"
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n",
            "type":"string",
            "example":"required_value_missing"
        }
    }
}

Example:

{
    "type":"error:validation",
    "title":"Required value not specified.",
    "details":"The OrgShortName value is required.",
    "instance":"required_value_missing"
}

404 Response

404 Requested resource not found

Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

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

{
  "menuItems": [
    {
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "menuItemId": 32,
      "familyGroupRef": 0,
      "definitions": [
        {
          "definitionSequence": 0,
          "name": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "name2": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "slus": [
            {
              "sluNumber": 0,
              "sluId": 0,
              "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
              },
              "images": [
                {
                  "index": "string",
                  "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                  "altText": "pizza",
                  "description": "string",
                  "isCloudImage": true,
                  "size": "string"
                }
              ]
            }
          ],
          "taxClassRef": 0,
          "prices": [
            {
              "priceSequence": 0,
              "price": 0,
              "name": "string"
            }
          ],
          "defaultCondiments": [
            {
              "condimentRef": 0,
              "quantity": 1
            }
          ],
          "condimentGroupRules": [
            {
              "condimentGroupRef": 5802109,
              "minimumCount": 1,
              "maximumCount": 0
            }
          ],
          "consumerName": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "consumerDescription": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "images": [
            {
              "index": "string",
              "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
              "altText": "pizza",
              "description": "string",
              "isCloudImage": true,
              "size": "string"
            }
          ],
          "consumerAdvisoryText": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "allergens": [
            "milk",
            "peanut"
          ],
          "nutritionalData": [
            {
              "nutritionalItemId": "fat, sodium",
              "value": 475,
              "unitOfMeasure": "grams, milligrams, calorie",
              "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
              }
            }
          ],
          "options": [
            "containsAlcohol"
          ],
          "tags": [
            "hot",
            "cold"
          ],
          "tagGroups": [
            {
              "id": "string",
              "tags": [
                "spicy",
                "lo-carb"
              ]
            }
          ],
          "extensions": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      ],
      "dietaryInformation": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "tagGroups": [
        {
          "id": "string",
          "tags": [
            "spicy",
            "lo-carb"
          ]
        }
      ]
    }
  ],
  "comboMeals": [
    {
      "comboMealId": 0,
      "name": "string",
      "menuItemRef": 0,
      "comboGroups": [
        {
          "comboGroupId": 0,
          "name": "string",
          "count": 0,
          "isMainGroup": true,
          "prices": [
            {
              "priceSequence": 0,
              "price": 0
            }
          ],
          "menuItems": [
            {
              "menuItemRef": 0,
              "count": 0,
              "prices": [
                {
                  "priceSequence": 0,
                  "price": 0
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "condimentItems": [
    {
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "condimentId": 32,
      "familyGroupRef": 0,
      "definitions": [
        {
          "number": 0,
          "name": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "name2": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "slus": [
            {
              "sluNumber": 0,
              "sluId": 0,
              "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
              },
              "images": [
                {
                  "index": "string",
                  "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                  "altText": "pizza",
                  "description": "string",
                  "isCloudImage": true,
                  "size": "string"
                }
              ]
            }
          ],
          "prices": [
            {
              "priceSequence": 0,
              "price": 0,
              "name": "string"
            }
          ],
          "consumerName": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "consumerDescription": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "images": [
            {
              "index": "string",
              "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
              "altText": "pizza",
              "description": "string",
              "isCloudImage": true,
              "size": "string"
            }
          ],
          "allergens": [
            "milk",
            "peanut"
          ],
          "nutritionalData": [
            {
              "nutritionalItemId": "fat, sodium",
              "value": 475,
              "unitOfMeasure": "grams, milligrams, calorie",
              "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
              }
            }
          ],
          "options": [
            "containsAlcohol"
          ],
          "tags": [
            "hot",
            "cold"
          ],
          "tagGroups": [
            {
              "id": "string",
              "tags": [
                "spicy",
                "lo-carb"
              ]
            }
          ],
          "extensions": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      ],
      "dietaryInformation": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "tagGroups": [
        {
          "id": "string",
          "tags": [
            "spicy",
            "lo-carb"
          ]
        }
      ]
    }
  ],
  "condimentGroups": [
    {
      "condimentGroupId": 32,
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "condimentItemRefs": [
        0
      ],
      "consumerName": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "consumerDescription": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "images": [
        {
          "index": "string",
          "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
          "altText": "pizza",
          "description": "string",
          "isCloudImage": true,
          "size": "string"
        }
      ]
    }
  ],
  "familyGroups": [
    {
      "familyGroupItemId": 0,
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "consumerName": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "consumerDescription": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "images": [
        {
          "index": "string",
          "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
          "altText": "pizza",
          "description": "string",
          "isCloudImage": true,
          "size": "string"
        }
      ]
    }
  ],
  "allergens": [
    {
      "allergenId": "string",
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      }
    }
  ]
}

Back to Top