Orders models

Models of the table order endpoints.

Generated by python -m codegen from the iikoCloud OpenAPI specification. Do not edit by hand.

AddCustomerToTableOrderRequest

Bases: IikoModel

Request for adding customer to order.

customer instance-attribute

customer: TableOrderCustomer

Guest info.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

Can be obtained by /api/1/organizations operation.

AddItemsToTableOrderRequest

Bases: IikoModel

Request for add order items to table order.

add_order_items_settings class-attribute instance-attribute

add_order_items_settings: (
    AddTableOrderItemsSettings | None
) = None

Add order items parameters.

combos class-attribute instance-attribute

combos: list[Combo] | None = None

Combos.

Allowed from version 7.6.1.

items instance-attribute

items: list[OrderItem]

Order items (may include ProductOrderItem or CompoundOrderItem).

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

Can be obtained by /api/1/organizations operation.

AddTableOrderItemsSettings

Bases: IikoModel

Add table order items options.

service_print class-attribute instance-attribute

service_print: bool | None = None

Auto service print is needed.

CancelTableOrderRequest

Bases: IikoModel

Request to cancel a table order.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

Can be obtained by /api/1/organizations operation.

removal_comment class-attribute instance-attribute

removal_comment: str | None = Field(
    default=None, min_length=0, max_length=255
)

Comment to the charge-off.

removal_type_id class-attribute instance-attribute

removal_type_id: str | None = None

Removal type (used during deletion of printed order items).

user_id_for_writeoff class-attribute instance-attribute

user_id_for_writeoff: str | None = None

User for writeoff (used during deletion of printed order items).

CloseTableOrderRequest

Bases: IikoModel

Request for close table order.

cheque_additional_info class-attribute instance-attribute

cheque_additional_info: ChequeAdditionalInfo | None = None

Cheque additional information according to russian federal law #54.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

Can be obtained by /api/1/organizations operation.

CreateTableOrderRequest

Bases: IikoModel

Order creation model.

create_order_settings class-attribute instance-attribute

create_order_settings: CreateTableOrderSettings | None = (
    None
)

Order creation parameters.

order class-attribute instance-attribute

order: TableOrder | None = None

Order.

organization_id instance-attribute

organization_id: str

Organization ID.

Can be obtained by /api/1/organizations operation.

terminal_group_id instance-attribute

terminal_group_id: str

Front group ID an order must be sent to.

Can be obtained by /api/1/terminal_groups operation.

CreateTableOrderSettings

Bases: IikoModel

Table order creation options

check_stop_list class-attribute instance-attribute

check_stop_list: bool | None = None

Flag indicating whether there's need to check order items in out-of-stock list.

Unable if terminalGroupId is null.

service_print class-attribute instance-attribute

service_print: bool | None = None

Auto service print is needed.

transport_to_front_timeout class-attribute instance-attribute

transport_to_front_timeout: int | None = None

Timeout in seconds that specifies how much time is given for order to reach iikoFront. After this time, order is nullified if iikoFront doesn't take it. By default - 8 seconds.

GetTableOrdersByIdRequest

Bases: IikoModel

Request for information about orders using IDs.

order_ids class-attribute instance-attribute

order_ids: list[str] | None = None

Order IDs.

Required if "posOrderIds" is null. Must be null if "posOrderIds" is not null.

organization_ids instance-attribute

organization_ids: list[str]

Organization IDs.

Can be obtained by /api/1/organizations operation.

pos_order_ids class-attribute instance-attribute

pos_order_ids: list[str] | None = None

POS order IDs.

Required if "orderIds" is null. Must be null if "orderIds" is not null.

return_external_data_keys class-attribute instance-attribute

return_external_data_keys: list[str] | None = None

Keys for retrun external data information.

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Source keys.

GetTableOrdersByTableRequest

Bases: IikoModel

Request for information about orders using table IDs.

date_from class-attribute instance-attribute

date_from: IikoDateTime | None = None

Order creation date (terminal time zone). Lower limit.

Order details are stored for 90 days.

date_to class-attribute instance-attribute

date_to: IikoDateTime | None = None

Order creation date (terminal time zone). Upper limit.

organization_ids instance-attribute

organization_ids: list[str]

Organization ID.

Can be obtained by /api/1/organizations operation.

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Source keys.

statuses class-attribute instance-attribute

statuses: list[OrderStatus] | None = None

Order statuses.

table_ids instance-attribute

table_ids: list[str]

Table IDs.

Can be obtained by /api/1/reserve/available_restaurant_sections operation.

GuestsInfo

Bases: IikoModel

Table order guests information.

count instance-attribute

count: int

Guests count.

InitTableOrderByPosOrderRequest

Bases: IikoModel

Request for init orders on table by POS orders.

organization_id instance-attribute

organization_id: str

Organization ID.

Can be obtained by /api/1/organizations operation.

pos_order_ids instance-attribute

pos_order_ids: list[str]

POS order IDs.

terminal_group_id instance-attribute

terminal_group_id: str

Terminal group ID.

Can be obtained by /api/1/terminal_groups operation.

InitTableOrderRequest

Bases: IikoModel

Request for init orders on table.

organization_id instance-attribute

organization_id: str

Organization ID.

Can be obtained by /api/1/organizations operation.

table_ids instance-attribute

table_ids: list[str]

Table IDs.

Can be obtained by /api/1/reserve/available_restaurant_sections operation.

terminal_group_id instance-attribute

terminal_group_id: str

Terminal group ID.

Can be obtained by /api/1/terminal_groups operation.

TableOrder

Bases: IikoModel

TableOrder.

cheque_additional_info class-attribute instance-attribute

cheque_additional_info: ChequeAdditionalInfo | None = None

Cheque additional information.

combos class-attribute instance-attribute

combos: list[Combo] | None = None

Combos included in order.

customer class-attribute instance-attribute

customer: RegularCustomer | None = None

Guest.

Allowed from version 7.5.2.

discounts_info class-attribute instance-attribute

discounts_info: DiscountsInfo | None = None

Discounts/surcharges.

external_data class-attribute instance-attribute

external_data: list[ExternalData] | None = None

Order external data.

Allowed from version 8.0.6.

external_number class-attribute instance-attribute

external_number: str | None = Field(
    default=None, min_length=0, max_length=50
)

Order external number.

Allowed from version 8.0.6.

guest_count class-attribute instance-attribute

guest_count: int | None = None

Deprecated. Amount of guests in the order.

Allowed from version 7.6.1.

guests class-attribute instance-attribute

guests: GuestsInfo | None = None

Guests information.

Allowed from version 7.6.1.

id class-attribute instance-attribute

id: str | None = None

Order ID.

items instance-attribute

items: list[OrderItem]

Order items.

loyalty_info class-attribute instance-attribute

loyalty_info: LoyaltyInfo | None = None

Information about Loyalty app.

menu_id class-attribute instance-attribute

menu_id: str | None = None

External menu ID.

order_type_id class-attribute instance-attribute

order_type_id: str | None = None

Order type ID.

Can be obtained by /api/1/deliveries/order_types operation

payments class-attribute instance-attribute

payments: list[Payment] | None = None

Order payment components.

Type LoyaltyCard allowed from version 7.1.5.

phone class-attribute instance-attribute

phone: str | None = None

Guest phone.

Allowed from version 7.5.2.

price_category_id class-attribute instance-attribute

price_category_id: str | None = None

Price category id of the order.

Can be obtained by /api/2/menu operation.

Allowed from version 9.0.5.

source_key class-attribute instance-attribute

source_key: str | None = None

The string key (marker) of the source (partner - api user) that created the order. Needed to limit the visibility of orders for external integration.

tab_name class-attribute instance-attribute

tab_name: str | None = None

Tab name (only for fastfood terminals group in tab mode).

Allowed from version 7.6.1.

table_ids class-attribute instance-attribute

table_ids: list[str] | None = None

Table IDs.

Can be obtained by /api/1/reserve/available_restaurant_sections operation.

tips class-attribute instance-attribute

tips: list[TipsPayment] | None = None

Order tips components.

TableOrderCustomer

Bases: IikoModel

TableOrderCustomer.

birthdate class-attribute instance-attribute

birthdate: IikoDateTime | None = None

Date of birth.

comment class-attribute instance-attribute

comment: str | None = Field(
    default=None, min_length=0, max_length=60
)

Comment.

email class-attribute instance-attribute

email: str | None = None

Email.

gender class-attribute instance-attribute

gender: Gender | None = None

Gender.

id class-attribute instance-attribute

id: str | None = None

Existing customer ID in RMS. If null - the phone number and name is searched in database, otherwise the new customer is created in RMS.

name class-attribute instance-attribute

name: str | None = Field(
    default=None, min_length=0, max_length=60
)

Name of customer. Required if "id" == null. Not required if "id" specified.

phone class-attribute instance-attribute

phone: str | None = None

Customer phone. Required if "id" == null. Not required if "id" specified.

should_receive_order_status_notifications class-attribute instance-attribute

should_receive_order_status_notifications: bool | None = (
    None
)

Whether customer receives order status notification messages.

surname class-attribute instance-attribute

surname: str | None = Field(
    default=None, min_length=0, max_length=60
)

Last name.

TableOrderResponse

Bases: IikoModel

Wrapping object (external) for a delivery order return.

correlation_id instance-attribute

correlation_id: str

Operation ID.

order_info instance-attribute

order_info: TableOrderInfo

Order.

TableOrdersResponse

Bases: IikoModel

Wrapping object (external) for return of orders.

correlation_id instance-attribute

correlation_id: str

Operation ID.

orders instance-attribute

orders: list[TableOrderInfo]

Orders.