Order Destination

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ csv of 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

int32

No

The maximum documents to return

query

$skip

int32

No

The documents to skip before returning

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against

query

entity_ids

[ string ]

No

An array of entity identifiers

query

include_entities

[ csv of 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

array, csv of 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

int32

No

The maximum documents to return

query

$skip

int32

No

The documents to skip before returning

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against

query

entity_ids

string

No

An array of entity identifiers

query

include_entities

array, csv of 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

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

[ csv of 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

[ csv of 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.

order_destination_entity_id

string, object

An array of the order_destination entity_ids

name

string

Yes

The name of the destination (For example, Carry Out)

short_name

string

Yes

The short name of the destination (For example, CAOU)

id

string

Yes

The user defined identifier of the destination (For example, carry-out)

background_color

string (hex)

No

The hexadecimal value of color

text_color

string (hex)

No

The hexadecimal value of color

required_customer_info

[ string ]

No

The required customer fields to capture for the order destination

optional_customer_info

[ string ]

No

The optional customer fields to capture for the order destination

segment_name

string

No

The name of the order segment.

The possible values are "tray," "seat," or "bag."

guest_count_calculation_method

string

No

Chooses how the guest count is calculated for an order.

The possible values are  "by_segment" or "by_product."

consumption_type

string

No

The consumption type.

The possible values are "OnPremises" or "OffPremises."

default_taxable_destination

boolean

No

Configures the default taxable destination

time_based_customer_fields

[ object ]

No

The customer fields to capture for the specific time periods

external_id

external_id

No

_id

_id

No

company_id

company_id

No

entity_id

entity_id

No

is_master

is_master

No

is_active

is_active

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 destination (For example, Carry Out)

short_name

string

Yes

The short name of the destination (For example, CAOU)

id

string

Yes

The user defined identifier of the destination (For example, carry-out)

background_color

string (hex)

No

The hexadecimal value of color

text_color

string (hex)

No

The hexadecimal value of color

required_customer_info

[ string ]

No

The required customer fields to capture for the order destination

optional_customer_info

[ string ]

No

The optional customer fields to capture for the order destination

segment_name

string

No

The name of the order segment.

The possible values are "tray," "seat," or "bag."

guest_count_calculation_method

string

No

Chooses how the guest count is calculated for an order.

The possible values are "by_segment" or "by_product."

consumption_type

string

No

The consumption type.

The possible values are "OnPremises"or "OffPremises."

default_taxable_destination

boolean

No

Configures the default taxable destination

time_based_customer_fields

[ object ]

No

The customer fields to capture for the specific time periods

external_id

external_id

No

entity_id

entity_id

No

name

string

The name of the destination (For example, Carry Out)

short_name

string

The short name of the destination (For example, CAOU)

id

string

The user defined identifier of the destination (For example, carry-out)

background_color

string (hex)

The hexadecimal value of color

text_color

string (hex)

The hexadecimal value of color

required_customer_info

[ string ]

The required customer fields to capture for the order destination

optional_customer_info

[ string ]

The optional customer fields to capture for the order destination

segment_name

string

The name of the order segment.

The possible values are "tray," "seat," or "bag."

guest_count_calculation_method

string

Chooses how the guest count is calculated for an order.

The possible values are "by_segment" or "by_product."

consumption_type

string

The consumption type.

The possible values are "OnPremises" or "OffPremises."

default_taxable_destination

boolean

Configures the default taxable destination

time_based_customer_fields

[ object ]

The customer fields to capture for the specific time periods

external_id

external_id

total

integer

items

[order_destination ]

name

string

external_id

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.

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