Recipe Venue

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

query

$top

integer

No

The maximum documents to return. For example, if top is 100, and skip is 0, the system returns documents 1 to 100.

query

$skip

integer

No

The documents to skip before returning. For example, if top is 100, and skip is 100, the system returns documents 101 to 200.

query

$filter

string

No

A filter expression in OData v4 format

query

$orderby

string

No

An order by expression in OData v4 format

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_mappings

boolean

No

Include the mappings for the document in the response

query

include_entities

[ string ]

No

Specify entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_inactive

boolean

No

Includes documents that are inactive for current sites

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

query

$filter

string

No

A filter expression in OData v4 format

query

$top

integer

No

The maximum documents to return. For example, if top is 100, and skip is 0, the system returns documents 1 to 100.

query

$skip

integer

No

The documents to skip before returning. For example, if top is 100, and skip is 100, the system returns documents 101 to 200.

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against. If the entity is updated on a specific date, then specifying an effective_date prior to that date returns a previous version of the entity.

query

entity_ids

[ string ]

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_mappings

boolean

No

Include the mappings for the document in the response

query

include_mappings_for_entities

[ string ]

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param='product','product-price', etc).

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_audit

boolean

No

Adds audit fields to each document when returning a result (is_active, is_master, created_at, created_by, updated_at, updated_by)

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

query

$filter

string

No

A filter expression in OData v4 format

query

$top

integer

No

The maximum documents to return. For example, if top is 100, and skip is 0, the system returns documents 1 to 100.

query

$skip

integer

No

The documents to skip before returning. For example, if top is 100, and skip is 100, the system returns documents 101 to 200.

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against. If the entity is updated on a specific date, then specifying an effective_date prior to that date returns a previous version of the entity.

query

entity_ids

[ string ]

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_audit

boolean

No

Adds audit fields to each document when returning a result (is_active, is_master, created_at, created_by, updated_at, updated_by)

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

query

include_mappings_for_entities

[ string ]

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param='product','product-price', etc).

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

body

body

recipe_venue_create

Yes

The JSON formatted request

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

body

body

[ recipe_venue_create ]

Yes

The JSON formatted request

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

body

body

[ recipe_venue_create ]

Yes

Supports the mappings field (array/boolean) for each document. With mappings: True mappings are created for the current date and sites from the X-SITE-IDs header.

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_mappings_for_entities

[ string ]

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param='product','product-price', etc).

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

body

body

recipe_venue_edit

No

The JSON of the category being patched

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

body

body

[ recipe_venue ]

Yes

The JSON formatted request

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

path

entity_id

string

Yes

The identifier of the entity

query

$top

integer

No

The maximum documents to return. For example, if top is 100, and skip is 0, the system returns documents 1 to 100.

query

$skip

integer

No

The documents to skip before returning; for example, if top is 100, and skip is 100, the system returns documents 101 to 200.

query

$filter

string

No

A filter expression in OData v4 format

query

$orderby

string

No

An order by expression in OData v4 format

query

include_inactive

boolean

No

Includes the documents that inactive for the current sites

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

path

entity_id

string

Yes

The identifier of the entity

body

body

mappings_update-request

Yes

The array of the inventory item venue mappings being added

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

body

body

[ mapping_create_request ]

Yes

The JSON of the recipe venue mapping being added

name

string

Yes

code

string

Yes

description

string

No

used_as_child

boolean

No

recipes

[ object ]

No

ingredients

[ object ]

No

child_recipes

[ object_id ]

No

child_ingredients

[ object ]

No

product

object

No

chargeable_item_entity_id

string, object

No

The inventory item that users count during stand worksheet operations

entity_id

entity_id

No

external_id

external_id

No

name

string

code

string

description

string

used_as_child

boolean

recipes

[ object ]

ingredients

[ object ]

child_recipes

[ object_id ]

child_ingredients

[ object ]

product

object

chargeable_item_entity_id

string,object

The inventory item that users count during stand worksheet operations

external_id

external_id

total

integer

items

[ recipe_venue ]

name

string

code

string

Select the international code of the currency according to ISO 4217

name

string

Yes

The default name of the product

product_id

string

Yes

The unique identifier (UID) of the product

caption

string

No

The caption that is displayed on the button in the menu. A maximum of five (5) lines with 255 characters is allowed.

product_type

string

Yes

The type of product.

The possible values are "standard," "modifier," "comment," "placeholder," "modifier_placeholder," "gift_card," "gift_certificate," "fee," or "retail_item."

item_type

string

No

The product type.

The possible values are "product," "modifier," "comment," "placeholder," "modifier_placeholder," "gift_card," "gift_certificate," "fee," or "retail_item."

revenue_class

string

No

include_on_item_count

boolean

No

Decides if the product affects the item count

include_on_item_count_value

integer

No

Determines the value that the item will be counted when added to an order

guest_count

integer

No

Defines the number of guests that are associated with an order when the product has been added

reporting_category

object

No

alt_item_name

string

No

item_description

string

No

item_description_short

string

No

is_open_price

boolean

Yes

Determines if the user is prompted for a price when adding to the order

is_bundle

boolean

No

Enables the product to be a bundle

bundle_components_entity_ids

[ string, object ]

No

An array of bundle_component entity_ids

kitchen_routing_category_entity_ids

[ string, object ]

No

The categories that the product is routed to

modifier_collection_entity_id

string, object

No

The selection of the base modifier collection for the product

display_modifier_selection_screen

string

No

Allows overriding the "Display Modifier Menu on Item Add" option in the preferences for the current product.

The possible values are "use_company_preference," "when_product_is_added_to_order," or "do_not_display_automatically."

builds

[ object ]

No

tax_group_entity_id

string, object

No

The group of tax rates to be applied on an order

default_cost

number (currency)

No

The default cost of the product

unit_size

integer

No

Allows the user to set the size for each unit for the price that will be configured

unit_type

string

No

Allows the user to select the type of the unit that makes up the item.

The possible values are "none," "pack," "each," "case," "bottle," "can," "gallon," "quart," "milliliter," "liter," "pound", "ounce," "gram," or "kilograms."

always_print_in_red

boolean

No

Whether or not this modifier always prints in red (overrides the modifier group setting)

include_in_plain_builds

boolean

No

Whether or not this modifier is included by default in a build

allow_quantity

boolean

No

Whether or not this modifier allows changing quantities

increment_modifier_quantity_by

number

No

The possible values are 1, 0.5, 0.33333, or 0.25

fractional_increment_modifier_quantity_by

object

No

fractional_secondary_increment_modifier_quantity_by

object

No

variation_info

object

No

bundle_type_entity_id

string, object

No

The preferred term used by the system when referencing the bundle item.

Default is "Combo."

The maximum is 20 characters.

show_confirmaion_prompt

boolean

No

Decides if the user will be prompted to confirm combining order item components into a bundle, when the bundle components are added to the order separately

advance_on_component_fulfillment

string

No

Allows overriding the "Advance on Component Fulfillment" option in the preferences for the current product.

The possible values are "use_company_preference," "on_final_component_choice," "do_not_automatically_advance."

prompt_item_conversio_on_change

boolean

No

Determines if the bundle will get changed based on the size of the components added

allow_plain_builds

boolean

No

external_category_ids

[ string ]

No

Category identifiers provided by IRIS/EDM that are not exposed to the Data Management (DM) user interface (UI)

external_tag_ids

[ string ]

No

The external tag identifiers

images

[ object ]

No

An array of product related images

nutritional_data

[ object ]

No

The nutrition values for the product

allergens

[ object ]

No

The allergens presence information

product_category_entity_ids

[ string, object ]

No

An array of product category entity identifiers

product_tag_entity_ids

[ string, object ]

No

The tags that are currently added to the product

prompt_for_quantity

boolean

No

Determines if the user is prompted to enter the quantity when adding to the order

kitchen_routing_type

string

No

Determines how the product is routed to the kitchen.

The possible values are "by_category" or "by_destination"

order_destination_entity_id

string, object

No

The order destination entity identifier

kitchen_routing_categories_by_destination

[ object ]

No

An array of objects with kitchen_routing_category_entity_ids by order_destination_entity_id

alternate_kitchen_name

string

No

The optimized shorter name for kitchen printing and video

display_modifier_priority_entity_id

string, object

No

The priority in which this modifier displays in relation to other modifiers in the kitchen displays

preparation_instructions

string

No

The preparation instructions field

prep_instruction_images

[ string ]

No

The images for preparation Instruction

tag_entity_ids

[ string, object ]

No

An array of tag entity identifiers

alternate_plu_codes

[ string ]

No

Allows the user to add the product to an order using the added price look ups (PLUs)

is_liability_item

boolean

No

Flags if the product is a liability item such as a gift card

liability_info

object

No

forbid_adding_via_lookup

boolean

No

Prevents the product from being added to an order through product look up in the ordering application

restricted_order_source_entity_ids

[ string, object ]

No

An array of restricted order source entity identifiers

restricted_order_source_ids

[ string ]

No

An array of restricted Order Source identifiers

allowed_order_source_entity_ids

[ string, object ]

No

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

No

An array of allowed Order Source identifiers

restrict_availability_order_source

boolean

No

Flags if the product "Is Restrict Availability by Order Source" or not

voice_name

string

No

The primary product name for use with voice ordering

voice_description

string

No

Defines a detailed description of the voice ordering for the product

voice_synonyms

string

No

The typical pronunciations of the product name or alternate names for the product (comma separated)

enable_time_based_pricing

boolean

No

Enables time-based pricing logic

external_identifiers

[ string ]

No

Identifiers that are used to reference the product from the external systems

tax_inclusive

boolean

No

Defines whether new prices for the item are tax inclusive or not

roll_up_price

string

No

Defines whether the price for the item should be rolled up to a parent product price after tax calculation, before tax calculation, or should not be rolled up.

The possible values are "do_not_roll_up," "after_tax," or "before_tax."

field_data_kit_values

[ object ]

No

Contains names and identifiers for every changed section in a site specific document

weight_config

object

No

product_ingredients

[ object ]

No

The list of product ingredients

gl_account_entity_id

string, object

No

The Revenue General Ledger Account (GLA) for the product.

menu_image_display_type

string

No

Determine how the product is displayed on the menu in suite catering.

The possible values are "half_size" or "full_size"

alternate_modifier_collections

[ object ]

No

_id

_id

No

company_id

company_id

No

entity_id

entity_id

No

is_master

is_master

No

is_active

is_active

No

external_id

external_id

No

created_by

created_by

No

updated_by

updated_by

No

created_at

created_at

No

updated_at

updated_at

No

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time the document was updated

updated_at

string

The last date and time the document was updated