Bundle Component

name

string

Yes

The name of the bundle component

description

string

No

The description of the bundle component

is_enabled

boolean

No

Decides if the component is available for the bundle

main_item

boolean

No

Decides if the component is the main item for the bundle

component_type

string

No

The type of bundle component. The possible values are "group" (default) or "item."

offer_question

string

No

The message that displays on Ordering application

sort_order

integer

No

The order the component appears in

minimum_quantity

integer

No

The minimum quantity of the component. Default is 1

default_quantity

integer

No

The default quantity of this component. Default is 1

maximum_quantity

integer

No

The maximum quantity of the component. Default is 1

choice_label

string

No

An optional label for the on-screen product choices

product_choices_entity_ids

[ string, object ]

No

The available choices for the component

product_choices_entity_ids_info

object

No

Additional information about added products. The keys are Product Entity IDs.

disabled_product_choices_entity_ids

[ string, object ]

No

The available disabled choices for the component

default_products

[ object ]

No

The products to be used as defaults

pricing_change_action

string

Yes

The type of price change to apply. The possible values are "off" (default), "replace", or "adjust."

allowed_destination_entity_ids

[ string, object ]

Yes

Choose the destinations where the component is available.

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

is_template

boolean

No

Identifies if the current document is the Bundle Template

template_entity_id

string, object

No

A reference by the entity identifier to the template from which the current bundle component was created

select_items_using

string

No

The possible values are "items," "tags," "both," or "menu_category"

menu_category_entity_id

string, object

No

The unique identifier of the menu category

tag_entity_ids

[ string, object ]

No

An array of allowed tag entity identifiers

_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

name

string

Yes

The name of the bundle component

description

string

No

The description of the bundle component

is_enabled

boolean

No

Decides if the component is available for the bundle

main_item

boolean

No

Decides if the component is main item for the bundle

component_type

string

No

The type of bundle component. The possible values are "group" (default) or "item."

offer_question

string

No

The message that displays on the Ordering application

sort_order

integer

No

The order the component appears in

minimum_quantity

integer

No

The minimum quantity of the component. Default is 1

default_quantity

integer

No

The default quantity of the component. Default is 1

maximum_quantity

integer

No

The maximum quantity of the component. Default is 1

choice_label

string

No

An optional label for the on-screen product choices

product_choices_entity_ids

[ string, object ]

No

The available choices for the component

product_choices_entity_ids_info

object

No

Additional information about added products. The keys are product entity identifiers.

disabled_product_choices_entity_ids

[ string, object ]

No

The available disabled choices for the component

default_products

[ object ]

No

The products to be used as defaults

pricing_change_action

string

Yes

The type of price change to apply. The possible values are "off" (default), "replace," or "adjust."

allowed_destination_entity_ids

[ string, object ]

Yes

Choose the destinations where the component is available.

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

is_template

boolean

No

Identifies if the current document is the Bundle Template

template_entity_id

string, object

No

A reference by the entity identifier to the template from which the current bundle component was created

select_items_using

string

No

The possible values are "items," "tags," "both," or "menu_category"

menu_category_entity_id

string, object

No

The unique identifier of the menu category

tag_entity_ids

[ string, object ]

No

An array of allowed tag entity identifiers

external_id

external_id

No

name

string

The name of the bundle component

description

string

The description of the bundle component

is_enabled

boolean

Decides if the component is available for the bundle

main_item

boolean

Decides if the component is the main for the bundle

component_type

string

The type of bundle component. The possible values are "group" (default) or "item."

offer_question

string

This is the message that displays on Ordering application

sort_order

integer

The order the component appears in

minimum_quantity

integer

The minimum quantity of the component. Default is 1

default_quantity

integer

The default quantity of the component. Default is 1

maximum_quantity

integer

The maximum quantity of the component. Default is 1

choice_label

string

An optional label for the on-screen product choices

product_choices_entity_ids

[ string, object ]

The available choices for the component

product_choices_entity_ids_info

object

Additional information about added products. The keys are product entity identifiers

disabled_product_choices_entity_ids

[ string, object ]

The available disabled choices for this component

default_products

[ object ]

The products to be used as defaults

pricing_change_action

string

The type of price change to apply. The possible values are "off" (default), "replace," or "adjust."

allowed_destination_entity_ids

[ string, object ]

Choose the destinations where the component is available

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

An array of allowed Order Source identifiers

is_template

boolean

Identifies if current document is the Bundle Template

template_entity_id

string, object

A reference by the entity identifier to the template from which current the bundle component was created

select_items_using

string

The possible values are "items," "tags," "both," or "menu_category"

menu_category_entity_id

string, object

The unique entity identifier (UID) of the menu category

tag_entity_ids

[ string, object ]

An array of allowed tag entity identifiers

external_id

external_id

total

integer

items

 bundle_component

bundle_component_entity_id

string, object

unit_price

number (currency)

tags

[ string ]

time_period_entity_ids

[ string, object ]

external_id

external_id

total

integer

items

 bundle_component_price

bundle_components_entity_ids

array

An array of bundle_component entity_ids

name

string

_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 unique ID of this entity, set on creation. All future versions of this entity will 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 date and time (date-time) the document was created

updated_at

string

The last date and time (date-time) the document was updated