Reserves¶

Endpoints of the Reserves section of the iikoCloud API documentation.

Banquets/reserves¶

Banquets/reserves API.

iiko.reserve.add_items() `async` ¶

add_items(
    *,
    reserve_id: str,
    organization_id: str,
    items: Sequence[OrderItem | Mapping[str, Any]],
    combos: Sequence[Combo | Mapping[str, Any]]
    | None = None,
    timeout: float | None = None,
) -> CorrelationIdResponse

Add order items.

POST /api/1/reserve/add_items

Available only for banquets.

Allowed from version 8.2.6.

Restriction group: Orders: changing.

Note

This method is a command: it only starts the operation. Pass the response to IikoCloud.wait() to wait for the result.

Parameters:

Name	Type	Description	Default
`reserve_id`	`str`	Banquet ID.	required
`organization_id`	`str`	Organization ID. Can be obtained by `/api/1/organizations` operation.	required
`items`	`Sequence[OrderItem \| Mapping[str, Any]]`	Order items (may include ProductOrderItem or CompoundOrderItem).	required
`combos`	`Sequence[Combo \| Mapping[str, Any]] \| None`	Combos. Allowed from version `7.6.1`.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CorrelationIdResponse`	The `CorrelationIdResponse` response.

iikoCloud API reference

iiko.reserve.add_payments() `async` ¶

add_payments(
    *,
    reserve_id: str,
    organization_id: str,
    payments: Sequence[Payment | Mapping[str, Any]],
    timeout: float | None = None,
) -> CorrelationIdResponse

Add order payments.

POST /api/1/reserve/add_payments

Available only for banquets.

Allowed from version 8.2.6.

Restriction group: Order payments: changing.

Note

This method is a command: it only starts the operation. Pass the response to IikoCloud.wait() to wait for the result.

Parameters:

Name	Type	Description	Default
`reserve_id`	`str`	Reserve ID.	required
`organization_id`	`str`	Organization ID. Can be obtained by `/api/1/organizations` operation.	required
`payments`	`Sequence[Payment \| Mapping[str, Any]]`	Order payments.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CorrelationIdResponse`	The `CorrelationIdResponse` response.

iikoCloud API reference

iiko.reserve.available_organizations() `async` ¶

available_organizations(
    *,
    organization_ids: Sequence[str] | None = None,
    return_additional_info: bool | None = None,
    include_disabled: bool | None = None,
    return_external_data: Sequence[str] | None = None,
    timeout: float | None = None,
) -> GetOrganizationsResponse

Returns all organizations of current account (determined by Authorization request header) for which banquet/reserve booking are available.

POST /api/1/reserve/available_organizations

Allowed from version 7.1.5.

Restriction group: Orders: preparing.

Parameters:

Name	Type	Description	Default
`organization_ids`	`Sequence[str] \| None`	Organizations IDs which have to be returned. By default - all organizations from apiLogin. Can be obtained by `/api/1/organizations` operation.	`None`
`return_additional_info`	`bool \| None`	A sign whether additional information about the organization should be returned (RMS version, country, restaurantAddress, etc.), or only minimal information should be returned (id and name).	`None`
`include_disabled`	`bool \| None`	Attribute that shows that response contains disabled organizations.	`None`
`return_external_data`	`Sequence[str] \| None`	External data keys that have to be returned.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`GetOrganizationsResponse`	The `GetOrganizationsResponse` response.

iikoCloud API reference

iiko.reserve.available_restaurant_sections() `async` ¶

available_restaurant_sections(
    *,
    terminal_group_ids: Sequence[str],
    return_schema: bool | None = None,
    revision: int | None = None,
    timeout: float | None = None,
) -> GetRestaurantSectionsResponse

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

POST /api/1/reserve/available_restaurant_sections

Allowed from version 7.1.5.

Restriction group: Orders: preparing.

Parameters:

Name	Type	Description	Default
`terminal_group_ids`	`Sequence[str]`	Collection of terminal group ID. Can be obtained by `/api/1/terminal_groups` operation.	required
`return_schema`	`bool \| None`	Indicates whether table layout information should be returned...	`None`
`revision`	`int \| None`	Last modified time after.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`GetRestaurantSectionsResponse`	The `GetRestaurantSectionsResponse` response.

iikoCloud API reference

iiko.reserve.available_terminal_groups() `async` ¶

available_terminal_groups(
    *,
    organization_ids: Sequence[str],
    timeout: float | None = None,
) -> TerminalGroupsResponse

Returns all terminal groups of specified organizations, for which banquet/reserve booking are available.

POST /api/1/reserve/available_terminal_groups

Allowed from version 7.1.5.

Restriction group: Orders: preparing.

Parameters:

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	Organizations IDs for which information is requested. Can be obtained by `/api/1/organizations` operation.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`TerminalGroupsResponse`	The `TerminalGroupsResponse` response.

iikoCloud API reference

iiko.reserve.cancel() `async` ¶

cancel(
    *,
    organization_id: str,
    reserve_id: str,
    cancel_reason: ReserveCancelReason,
    timeout: float | None = None,
) -> CorrelationIdResponse

Cancel reservation due to some reason.

POST /api/1/reserve/cancel

Available only for reserves with status 'New'.

Allowed from version 8.2.6.

Restriction group: Order status: changing.

Note

This method is a command: it only starts the operation. Pass the response to IikoCloud.wait() to wait for the result.

Parameters:

Name	Type	Description	Default
`organization_id`	`str`	Organization ID of the reserve. Can be obtained by `/api/1/organizations` operation.	required
`reserve_id`	`str`	Reserve ID to cancel.	required
`cancel_reason`	`ReserveCancelReason`	Reason to cancel planned event.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CorrelationIdResponse`	The `CorrelationIdResponse` response.

iikoCloud API reference

iiko.reserve.change_estimated_start_time() `async` ¶

change_estimated_start_time(
    *,
    organization_id: str,
    reserve_id: str,
    new_estimated_start_time: datetime | str,
    timeout: float | None = None,
) -> CorrelationIdResponse

Change reserve/banquet estimated start time.

POST /api/1/reserve/change_estimated_start_time

Allowed from version 9.0.5.

Restriction group: Orders: changing.

Note

This method is a command: it only starts the operation. Pass the response to IikoCloud.wait() to wait for the result.

Parameters:

Name	Type	Description	Default
`organization_id`	`str`	Organization ID. Can be obtained by `/api/1/organizations` operation.	required
`reserve_id`	`str`	Reserve/banquet ID.	required
`new_estimated_start_time`	`datetime \| str`	New estimated start time of reserve/banquet.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CorrelationIdResponse`	The `CorrelationIdResponse` response.

iikoCloud API reference

iiko.reserve.change_items() `async` ¶

change_items(
    *,
    organization_id: str,
    reserve_id: str,
    items: Sequence[OrderItem | Mapping[str, Any]]
    | None = None,
    combos: Sequence[Combo | Mapping[str, Any]]
    | None = None,
    timeout: float | None = None,
) -> CorrelationIdResponse

Change order items.

POST /api/1/reserve/change_items

Available only for banquets.

Allowed from version 9.0.5.

Restriction group: Orders: changing.

Note

This method is a command: it only starts the operation. Pass the response to IikoCloud.wait() to wait for the result.

Parameters:

Name	Type	Description	Default
`organization_id`	`str`	Organization ID. Can be obtained by `/api/1/organizations` operation.	required
`reserve_id`	`str`	Banquet ID.	required
`items`	`Sequence[OrderItem \| Mapping[str, Any]] \| None`	Order items (may include ProductOrderItem or CompoundOrderItem).	`None`
`combos`	`Sequence[Combo \| Mapping[str, Any]] \| None`	Combos.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CorrelationIdResponse`	The `CorrelationIdResponse` response.

iikoCloud API reference

iiko.reserve.change_tables() `async` ¶

change_tables(
    *,
    organization_id: str,
    reserve_id: str,
    table_ids: Sequence[str],
    timeout: float | None = None,
) -> CorrelationIdResponse

Change reserve/banquet tables.

POST /api/1/reserve/change_tables

Allowed from version 9.0.5.

Restriction group: Orders: changing.

Note

This method is a command: it only starts the operation. Pass the response to IikoCloud.wait() to wait for the result.

Parameters:

Name	Type	Description	Default
`organization_id`	`str`	Organization ID. Can be obtained by `/api/1/organizations` operation.	required
`reserve_id`	`str`	Reserve ID.	required
`table_ids`	`Sequence[str]`	Table IDs.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`CorrelationIdResponse`	The `CorrelationIdResponse` response.

iikoCloud API reference

iiko.reserve.create() `async` ¶

create(
    *,
    organization_id: str,
    customer: RegularCustomer | Mapping[str, Any],
    phone: str,
    duration_in_minutes: int,
    should_remind: bool,
    table_ids: Sequence[str],
    estimated_start_time: datetime | str,
    terminal_group_id: str | None = None,
    id: str | None = None,
    external_number: str | None = None,
    order: ReserveOrder | Mapping[str, Any] | None = None,
    guests_count: int | None = None,
    comment: str | None = None,
    transport_to_front_timeout: int | None = None,
    guests: ReserveGuestsInfo
    | Mapping[str, Any]
    | None = None,
    event_type: str | None = None,
    create_reserve_settings: CreateOrderSettingsBase
    | Mapping[str, Any]
    | None = None,
    timeout: float | None = None,
) -> ReserveResponse

Create banquet/reserve.

POST /api/1/reserve/create

Allowed from version 7.1.5.

Restriction group: Orders: creating.

Note

This method is a command: it only starts the operation. Pass the response to IikoCloud.wait() to wait for the result.

Parameters:

Name	Type	Description	Default
`organization_id`	`str`	Organization ID of a new banquet/reserve. Can be obtained by `/api/1/organizations` operation.	required
`customer`	`RegularCustomer \| Mapping[str, Any]`	Customer.	required
`phone`	`str`	Telephone number. Must begin with symbol "+" and must be at least 8 digits.	required
`duration_in_minutes`	`int`	Estimated banquet duration.	required
`should_remind`	`bool`	Whether to remind staff to prepare table beforehand.	required
`table_ids`	`Sequence[str]`	Reserved tables.	required
`estimated_start_time`	`datetime \| str`	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.	required
`terminal_group_id`	`str \| None`	Front group ID an banquet/reserve must be sent to. Can be obtained by `/api/1/terminal_groups` operation.	`None`
`id`	`str \| None`	Banquet/reserve ID. Must be unique.	`None`
`external_number`	`str \| None`	Banquet/reserve external number. Allowed from version `8.0.6`.	`None`
`order`	`ReserveOrder \| Mapping[str, Any] \| None`	Order. Used only at a banquet.	`None`
`guests_count`	`int \| None`	Deprecated. Number of guests.	`None`
`comment`	`str \| None`	Banquet/reserve comment.	`None`
`transport_to_front_timeout`	`int \| 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.	`None`
`guests`	`ReserveGuestsInfo \| Mapping[str, Any] \| None`	Guests information.	`None`
`event_type`	`str \| None`	Event type. Allowed from version `8.5.6`.	`None`
`create_reserve_settings`	`CreateOrderSettingsBase \| Mapping[str, Any] \| None`	Reserve creation parameters.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`ReserveResponse`	The `ReserveResponse` response.

iikoCloud API reference

iiko.reserve.restaurant_sections_workload() `async` ¶

restaurant_sections_workload(
    *,
    restaurant_section_ids: Sequence[str],
    date_from: datetime | str,
    date_to: datetime | str | None = None,
    timeout: float | None = None,
) -> GetRestaurantSectionsWorkloadResponse

Returns all banquets/reserves for passed restaurant sections.

POST /api/1/reserve/restaurant_sections_workload

Allowed from version 7.1.5.

Restriction group: Data: dictionaries.

Parameters:

Name	Type	Description	Default
`restaurant_section_ids`	`Sequence[str]`	Collection of restaurant section ID. Can be obtained by `/api/1/reserve/available_restaurant_sections` operation.	required
`date_from`	`datetime \| str`	Estimated start time (Local for the terminal). Lower limit. Order details are stored for 90 days.	required
`date_to`	`datetime \| str \| None`	Estimated start time (Local for the terminal). Upper limit.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`GetRestaurantSectionsWorkloadResponse`	The `GetRestaurantSectionsWorkloadResponse` response.

iikoCloud API reference

iiko.reserve.status_by_id() `async` ¶

status_by_id(
    *,
    organization_id: str,
    reserve_ids: Sequence[str],
    source_keys: Sequence[str] | None = None,
    timeout: float | None = None,
) -> ReservesResponse

Retrieve banquets/reserves statuses by IDs.

POST /api/1/reserve/status_by_id

Allowed from version 7.1.5.

Restriction group: Orders: receiving.

Parameters:

Name	Type	Description	Default
`organization_id`	`str`	Organization ID for which an order search will be performed. Can be obtained by `/api/1/organizations` operation.	required
`reserve_ids`	`Sequence[str]`	IDs of banquets/reserves information on which is required.	required
`source_keys`	`Sequence[str] \| None`	Source keys.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`ReservesResponse`	The `ReservesResponse` response.

iikoCloud API reference

Reserves¶

Banquets/reserves¶

iiko.reserve.add_items() async ¶

iiko.reserve.add_payments() async ¶

iiko.reserve.available_organizations() async ¶

iiko.reserve.available_restaurant_sections() async ¶

iiko.reserve.available_terminal_groups() async ¶

iiko.reserve.cancel() async ¶

iiko.reserve.change_estimated_start_time() async ¶

iiko.reserve.change_items() async ¶

iiko.reserve.change_tables() async ¶

iiko.reserve.create() async ¶

iiko.reserve.restaurant_sections_workload() async ¶

iiko.reserve.status_by_id() async ¶

iiko.reserve.add_items() `async` ¶

iiko.reserve.add_payments() `async` ¶

iiko.reserve.available_organizations() `async` ¶

iiko.reserve.available_restaurant_sections() `async` ¶

iiko.reserve.available_terminal_groups() `async` ¶

iiko.reserve.cancel() `async` ¶

iiko.reserve.change_estimated_start_time() `async` ¶

iiko.reserve.change_items() `async` ¶

iiko.reserve.change_tables() `async` ¶

iiko.reserve.create() `async` ¶

iiko.reserve.restaurant_sections_workload() `async` ¶

iiko.reserve.status_by_id() `async` ¶