Reserves models

Models of the banquet/reserve endpoints.

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

AddOrderItemsToBanquetRequest

Bases: IikoModel

Request for add order items to banquet.

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).

organization_id instance-attribute

organization_id: str

Organization ID.

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

reserve_id instance-attribute

reserve_id: str

Banquet ID.

AddOrderPaymentsToBanquetRequest

Bases: IikoModel

Request for add order payments to banquet.

organization_id instance-attribute

organization_id: str

Organization ID.

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

payments instance-attribute

payments: list[Payment]

Order payments.

reserve_id instance-attribute

reserve_id: str

Reserve ID.

CancelReserveRequest

Bases: IikoModel

Request for canceling the reservation.

cancel_reason instance-attribute

cancel_reason: ReserveCancelReason

Reason to cancel planned event.

organization_id instance-attribute

organization_id: str

Organization ID of the reserve.

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

reserve_id instance-attribute

reserve_id: str

Reserve ID to cancel.

ChangeBanquetOrderItemsRequest

Bases: IikoModel

Request to change banquet order items.

combos class-attribute instance-attribute

combos: list[Combo] | None = None

Combos.

items class-attribute instance-attribute

items: list[OrderItem] | None = None

Order items (may include ProductOrderItem or CompoundOrderItem).

organization_id instance-attribute

organization_id: str

Organization ID.

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

reserve_id instance-attribute

reserve_id: str

Banquet ID.

ChangeReserveEstimatedStartTimeRequest

Bases: IikoModel

Request to change reserve/banquet estimated start time.

new_estimated_start_time instance-attribute

new_estimated_start_time: IikoDateTime

New estimated start time of reserve/banquet.

organization_id instance-attribute

organization_id: str

Organization ID.

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

reserve_id instance-attribute

reserve_id: str

Reserve/banquet ID.

ChangeReserveTablesRequest

Bases: IikoModel

Request to change reserve/banquet tables.

organization_id instance-attribute

organization_id: str

Organization ID.

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

reserve_id instance-attribute

reserve_id: str

Reserve ID.

table_ids instance-attribute

table_ids: list[str]

Table IDs.

Color

Bases: IikoModel

Color.

a instance-attribute

a: int

Alpha-component.

b instance-attribute

b: int

Blue-component.

g instance-attribute

g: int

Green-component.

r instance-attribute

r: int

Red-component.

CreateOrderSettingsBase

Bases: IikoModel

CreateOrderSettingsBase.

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.

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.

CreateReserveRequest

Bases: IikoModel

Banquet/reserve creation model.

comment class-attribute instance-attribute

comment: str | None = None

Banquet/reserve comment.

create_reserve_settings class-attribute instance-attribute

create_reserve_settings: CreateOrderSettingsBase | None = (
    None
)

Reserve creation parameters.

customer instance-attribute

customer: RegularCustomer

Customer.

duration_in_minutes instance-attribute

duration_in_minutes: int

Estimated banquet duration.

estimated_start_time instance-attribute

estimated_start_time: IikoDateTime

Estimated time when reserve will be closed or banquet will be started (Local for the terminal). Reservation can be made up to 90 days prior to the date.

event_type class-attribute instance-attribute

event_type: str | None = Field(
    default=None, min_length=0, max_length=160
)

Event type.

Allowed from version 8.5.6.

external_number class-attribute instance-attribute

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

Banquet/reserve external number.

Allowed from version 8.0.6.

guests class-attribute instance-attribute

guests: ReserveGuestsInfo | None = None

Guests information.

guests_count class-attribute instance-attribute

guests_count: int | None = None

Deprecated. Number of guests.

id class-attribute instance-attribute

id: str | None = None

Banquet/reserve ID. Must be unique.

order class-attribute instance-attribute

order: ReserveOrder | None = None

Order. Used only at a banquet.

organization_id instance-attribute

organization_id: str

Organization ID of a new banquet/reserve.

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

phone instance-attribute

phone: str

Telephone number. Must begin with symbol "+" and must be at least 8 digits.

should_remind instance-attribute

should_remind: bool

Whether to remind staff to prepare table beforehand.

table_ids instance-attribute

table_ids: list[str]

Reserved tables.

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Front group ID an banquet/reserve must be sent to.

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

transport_to_front_timeout class-attribute instance-attribute

transport_to_front_timeout: int | None = None

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

Font

Bases: IikoModel

Font.

font_family instance-attribute

font_family: str

Font family.

font_style instance-attribute

font_style: FontStyle

Font style. May be multiple values.

size instance-attribute

size: Decimal

Font size.

FontStyle

Bases: OpenStrEnum

Font style.

GetRestaurantSectionsRequest

Bases: IikoModel

Request for get all restaurant sections of specified terminal groups, for which banquet/reserve booking are available.

return_schema class-attribute instance-attribute

return_schema: bool | None = None

Indicates whether table layout information should be returned...

revision class-attribute instance-attribute

revision: int | None = None

Last modified time after.

terminal_group_ids instance-attribute

terminal_group_ids: list[str]

Collection of terminal group ID.

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

GetRestaurantSectionsResponse

Bases: IikoModel

Response which contains all restaurant sections of specified terminal groups for which banquet/reserve booking are available.

correlation_id instance-attribute

correlation_id: str

Operation ID.

restaurant_sections instance-attribute

restaurant_sections: list[RestaurantSection]

Restaurant sections.

revision instance-attribute

revision: int

Items list revision.

GetRestaurantSectionsWorkloadRequest

Bases: IikoModel

Request for check restaurant sections workload.

date_from instance-attribute

date_from: IikoDateTime

Estimated start time (Local for the terminal). Lower limit.

Order details are stored for 90 days.

date_to class-attribute instance-attribute

date_to: IikoDateTime | None = None

Estimated start time (Local for the terminal). Upper limit.

restaurant_section_ids instance-attribute

restaurant_section_ids: list[str]

Collection of restaurant section ID.

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

GetRestaurantSectionsWorkloadResponse

Bases: IikoModel

Response for check restaurant sections workload.

correlation_id instance-attribute

correlation_id: str

Operation ID.

reserves instance-attribute

reserves: list[ReserveInWorkload]

Banquets/reserves.

GetTerminalGroupsByOrganizationsRequest

Bases: IikoModel

Request for list of terminal groups.

organization_ids instance-attribute

organization_ids: list[str]

Organizations IDs for which information is requested.

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

ReserveGuestsInfo

Bases: IikoModel

Reserve guests information.

count instance-attribute

count: int

Guests count.

ReserveInWorkload

Bases: IikoModel

Banquet/reserve.

duration_in_minutes instance-attribute

duration_in_minutes: int

Estimated banquet duration.

estimated_start_time instance-attribute

estimated_start_time: IikoDateTime

Estimated time when reserve will be closed or banquet will be started (Local for the terminal).

guests_count instance-attribute

guests_count: int

Number of guests.

id instance-attribute

id: str

Banquet/reserve ID.

table_ids instance-attribute

table_ids: list[str]

Reserved tables.

ReserveOrder

Bases: IikoModel

Order.

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.

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.

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.

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.

tips class-attribute instance-attribute

tips: list[TipsPayment] | None = None

Order tips components.

ReserveResponse

Bases: IikoModel

Wrapping object (external) for return of banquets/reserves.

reserve_info instance-attribute

reserve_info: ReserveInfo

Banquet/reserve.

ReservesByIdRequest

Bases: IikoModel

Request for information about banquets/reserves using IDs.

organization_id instance-attribute

organization_id: str

Organization ID for which an order search will be performed.

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

reserve_ids instance-attribute

reserve_ids: list[str]

IDs of banquets/reserves information on which is required.

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Source keys.

ReservesResponse

Bases: IikoModel

Wrapping object (external) for return of banquets/reserves.

reserves instance-attribute

reserves: list[ReserveInfo]

Banquets/reserves.

RestaurantSection

Bases: IikoModel

Restaurant section.

id instance-attribute

id: str

Restaurant section ID.

name instance-attribute

name: str

Name.

schema_ class-attribute instance-attribute

schema_: SectionSchema | None = Field(
    default=None, alias="schema"
)

Table layout.

tables instance-attribute

tables: list[Table]

Tables.

terminal_group_id instance-attribute

terminal_group_id: str

Terminal group ID.

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

RestaurantSectionEllipse

Bases: IikoModel

Restaurant section ellipse.

angle instance-attribute

angle: Decimal

Item's angle of slope.

color instance-attribute

color: Color

Color.

height instance-attribute

height: int

Item's height in px.

width instance-attribute

width: int

Item's width in px.

x instance-attribute

x: int

X coordinate of left point of item.

y instance-attribute

y: int

Y coordinate of top point of item.

z instance-attribute

z: int

Z-index of item.

RestaurantSectionMark

Bases: IikoModel

Restaurant section mark.

angle instance-attribute

angle: Decimal

Item's angle of slope.

color instance-attribute

color: Color

Color.

font instance-attribute

font: Font

Font.

height instance-attribute

height: int

Item's height in px.

text instance-attribute

text: str

Text.

width instance-attribute

width: int

Item's width in px.

x instance-attribute

x: int

X coordinate of left point of item.

y instance-attribute

y: int

Y coordinate of top point of item.

z instance-attribute

z: int

Z-index of item.

RestaurantSectionRectangle

Bases: IikoModel

Restaurant section rectangle.

angle instance-attribute

angle: Decimal

Item's angle of slope.

color instance-attribute

color: Color

Color.

height instance-attribute

height: int

Item's height in px.

width instance-attribute

width: int

Item's width in px.

x instance-attribute

x: int

X coordinate of left point of item.

y instance-attribute

y: int

Y coordinate of top point of item.

z instance-attribute

z: int

Z-index of item.

RestaurantSectionTable

Bases: IikoModel

Restaurant section table.

angle instance-attribute

angle: Decimal

Item's angle of slope.

height instance-attribute

height: int

Item's height in px.

table_id instance-attribute

table_id: str

Table ID.

width instance-attribute

width: int

Item's width in px.

x instance-attribute

x: int

X coordinate of left point of item.

y instance-attribute

y: int

Y coordinate of top point of item.

z instance-attribute

z: int

Z-index of item.

SectionSchema

Bases: IikoModel

Table layout.

ellipse_elements instance-attribute

ellipse_elements: list[RestaurantSectionEllipse]

Collection of restaurant section ellipses.

height instance-attribute

height: int

Layout height in px.

is_deleted instance-attribute

is_deleted: bool

Is schema deleted.

mark_elements instance-attribute

mark_elements: list[RestaurantSectionMark]

Collection of restaurant section marks.

rectangle_elements instance-attribute

rectangle_elements: list[RestaurantSectionRectangle]

Collection of restaurant section rectangles.

revision instance-attribute

revision: int

Last modified time.

table_elements instance-attribute

table_elements: list[RestaurantSectionTable]

Collection of restaurant section tables.

width instance-attribute

width: int

Layout width in px.

Table

Bases: IikoModel

Table.

id instance-attribute

id: str

Table ID.

is_deleted instance-attribute

is_deleted: bool

Is table deleted.

name instance-attribute

name: str

Table name specified in the organization settings.

number instance-attribute

number: int

Number of table.

pos_id instance-attribute

pos_id: str

POS table Id.

revision instance-attribute

revision: int

Last modified time.

seating_capacity instance-attribute

seating_capacity: int

Seating capacity of the table.