Common models

Models shared by several API sections.

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

Address module-attribute

Address = Annotated[
    Annotated[AddressLegacy, Tag("legacy")]
    | Annotated[AddressCity, Tag("city")]
    | Annotated[AddressBase, Tag(UNKNOWN)],
    discriminator("type", "type", ("legacy", "city")),
]

Order delivery address

One of AddressLegacy, AddressCity, selected by type. Values unknown to this library are parsed as AddressBase.

Customer module-attribute

Customer = Annotated[
    Annotated[RegularCustomer, Tag("regular")]
    | Annotated[AnonymousCustomer, Tag("one-time")]
    | Annotated[CustomerBase, Tag(UNKNOWN)],
    discriminator("type", "type", ("regular", "one-time")),
]

Customer base info.

One of RegularCustomer, AnonymousCustomer, selected by type. Values unknown to this library are parsed as CustomerBase.

Discount module-attribute

Discount = Annotated[
    Annotated[RmsDiscount, Tag("RMS")]
    | Annotated[IikoCardDiscount, Tag("iikoCard")]
    | Annotated[DiscountBase, Tag(UNKNOWN)],
    discriminator("type", "type", ("RMS", "iikoCard")),
]

Discount/surcharge.

One of RmsDiscount, IikoCardDiscount, selected by type. Values unknown to this library are parsed as DiscountBase.

OrderItem module-attribute

OrderItem = Annotated[
    Annotated[ProductOrderItem, Tag("Product")]
    | Annotated[CompoundOrderItem, Tag("Compound")]
    | Annotated[OrderItemBase, Tag(UNKNOWN)],
    discriminator("type", "type", ("Product", "Compound")),
]

Order item.

One of ProductOrderItem, CompoundOrderItem, selected by type. Values unknown to this library are parsed as OrderItemBase.

OrganizationInfo module-attribute

OrganizationInfo = Annotated[
    Annotated[SimpleOrganizationInfo, Tag("Simple")]
    | Annotated[ExtendedOrganizationInfo, Tag("Extended")]
    | Annotated[OrganizationInfoBase, Tag(UNKNOWN)],
    discriminator(
        "responseType",
        "response_type",
        ("Simple", "Extended"),
    ),
]

Organization details.

One of SimpleOrganizationInfo, ExtendedOrganizationInfo, selected by response_type. Values unknown to this library are parsed as OrganizationInfoBase.

Payment module-attribute

Payment = Annotated[
    Annotated[CashPayment, Tag("Cash")]
    | Annotated[CardPayment, Tag("Card")]
    | Annotated[LoyaltyCardPayment, Tag("LoyaltyCard")]
    | Annotated[ExternalPayment, Tag("External")]
    | Annotated[PaymentBase, Tag(UNKNOWN)],
    discriminator(
        "paymentTypeKind",
        "payment_type_kind",
        ("Cash", "Card", "LoyaltyCard", "External"),
    ),
]

Base class of delivery order payment item.

One of CashPayment, CardPayment, LoyaltyCardPayment, ExternalPayment, selected by payment_type_kind. Values unknown to this library are parsed as PaymentBase.

PaymentAdditionalData module-attribute

PaymentAdditionalData = Annotated[
    Annotated[
        LoyaltyCardPaymentAdditionalData, Tag("LoyaltyCard")
    ]
    | Annotated[CardPaymentAdditionalData, Tag("Card")]
    | Annotated[
        ExternalPaymentAdditionalData, Tag("External")
    ]
    | Annotated[PaymentAdditionalDataBase, Tag(UNKNOWN)],
    discriminator(
        "type", "type", ("LoyaltyCard", "Card", "External")
    ),
]

Additional payment data.

One of LoyaltyCardPaymentAdditionalData, CardPaymentAdditionalData, ExternalPaymentAdditionalData, selected by type. Values unknown to this library are parsed as PaymentAdditionalDataBase.

RetrievedCustomer module-attribute

RetrievedCustomer = Annotated[
    Annotated[RetrievedRegularCustomer, Tag("regular")]
    | Annotated[RetrievedAnonymousCustomer, Tag("one-time")]
    | Annotated[RetrievedCustomerBase, Tag(UNKNOWN)],
    discriminator("type", "type", ("regular", "one-time")),
]

Delivery customer.

One of RetrievedRegularCustomer, RetrievedAnonymousCustomer, selected by type. Values unknown to this library are parsed as RetrievedCustomerBase.

RetrievedOrderItem module-attribute

RetrievedOrderItem = Annotated[
    Annotated[RetrievedProductOrderItem, Tag("Product")]
    | Annotated[RetrievedCompoundOrderItem, Tag("Compound")]
    | Annotated[ServiceOrderItem, Tag("Service")]
    | Annotated[RetrievedOrderItemBase, Tag(UNKNOWN)],
    discriminator(
        "type", "type", ("Product", "Compound", "Service")
    ),
]

Order item.

One of RetrievedProductOrderItem, RetrievedCompoundOrderItem, ServiceOrderItem, selected by type. Values unknown to this library are parsed as RetrievedOrderItemBase.

TipsPayment module-attribute

TipsPayment = Annotated[
    Annotated[CashTipsPayment, Tag("Cash")]
    | Annotated[CardTipsPayment, Tag("Card")]
    | Annotated[ExternalTipsPayment, Tag("External")]
    | Annotated[TipsPaymentBase, Tag(UNKNOWN)],
    discriminator(
        "paymentTypeKind",
        "payment_type_kind",
        ("Cash", "Card", "External"),
    ),
]

Base class of delivery order payment item.

One of CashTipsPayment, CardTipsPayment, ExternalTipsPayment, selected by payment_type_kind. Values unknown to this library are parsed as TipsPaymentBase.

AddOrderPaymentsRequest

Bases: IikoModel

Request for add order payments.

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.

payments instance-attribute

payments: list[Payment]

Order payments.

tips class-attribute instance-attribute

tips: list[TipsPayment] | None = None

Order tips.

AddressBase

Bases: IikoModel

Order delivery address

AddressCity

Bases: AddressBase

Order delivery address.

doorphone class-attribute instance-attribute

doorphone: str | None = None

Intercom.

entrance class-attribute instance-attribute

entrance: str | None = None

Entrance.

flat class-attribute instance-attribute

flat: str | None = None

Apartment.

floor class-attribute instance-attribute

floor: str | None = None

Floor.

line1 instance-attribute

line1: str

Address line 1. Contains the primary address information.

Allowed from version 8.7.6.

region_id class-attribute instance-attribute

region_id: str | None = None

Delivery area ID.

AddressFormatType

Bases: OpenStrEnum

Address format type.

AddressHintsServiceType

Bases: OpenStrEnum

Address hints service type.

AddressLegacy

Bases: AddressBase

Order delivery legacy address.

building class-attribute instance-attribute

building: str | None = None

Building.

doorphone class-attribute instance-attribute

doorphone: str | None = None

Intercom.

entrance class-attribute instance-attribute

entrance: str | None = None

Entrance.

flat class-attribute instance-attribute

flat: str | None = None

Apartment. In case useUaeAddressingSystem enabled max length - 100, otherwise - 10.

floor class-attribute instance-attribute

floor: str | None = None

Floor.

house instance-attribute

house: str

House.

index class-attribute instance-attribute

index: str | None = None

Postcode.

region_id class-attribute instance-attribute

region_id: str | None = None

Delivery area ID.

street instance-attribute

street: DeliveryStreet

Street. It's required specify only "classifierId" or "id" or "name" and "city".

AnonymousCustomer

Bases: CustomerBase

'One-time' customer: - should be used if a customer does not agree to take part in the store's loyalty programs or an aggregator (external system) does not provide customer details - customer details will NOT be added to the store's customer database and will be used ONLY to complete the current order

name instance-attribute

name: str

Customer name.

CancelInfo

Bases: IikoModel

Order cancellation details

cause instance-attribute

cause: RetrievedCancelCause

Delivery cancellation reason.

comment class-attribute instance-attribute

comment: str | None = None

Delivery cancellation comment.

when_cancelled instance-attribute

when_cancelled: IikoDateTime

Cancellation time (Local for delivery terminal).

CardPayment

Bases: PaymentBase

Bank card payment.

number class-attribute instance-attribute

number: str | None = None

Deprecated. Card No. In iikoFront, it is possible to make card payment without card No.

CardPaymentAdditionalData

Bases: PaymentAdditionalDataBase

Additional data for Card payment item.

card_type class-attribute instance-attribute

card_type: str | None = None

Card type (VISA, MasterCard, etc...).

Allowed from version 9.3.6.

custom_data class-attribute instance-attribute

custom_data: str | None = None

Custom data.

Allowed from version 8.8.6.

number class-attribute instance-attribute

number: str | None = None

Card No. In iikoFront, it is possible to make card payment without card No. If this property is set, the above number property is ignored.

CardTipsPayment

Bases: TipsPaymentBase

Bank card tips payment.

number class-attribute instance-attribute

number: str | None = None

Card No. In iikoFront, it is possible to make card payment without card No.

CashPayment

Bases: PaymentBase

Cash payment.

No additional fields for base class.

CashTipsPayment

Bases: TipsPaymentBase

Cash tips payment.

No additional fields for base class.

ChangeExternalDataRequest

Bases: IikoModel

Request for change of delivery or table order external data.

external_data instance-attribute

external_data: list[ExternalData]

External data to change.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

ChangePaymentsRequest

Bases: IikoModel

Change order's payments request.

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.

payments instance-attribute

payments: list[Payment]

Order payments.

tips class-attribute instance-attribute

tips: list[TipsPayment] | None = None

Order tips.

ChequeAdditionalInfo

Bases: IikoModel

Cheque additional information according to russian federal law #54.

email class-attribute instance-attribute

email: str | None = None

Email to send cheque information or null if the cheque shouldn't be sent by email.

is_internet_payment class-attribute instance-attribute

is_internet_payment: bool | None = None

Whether the settlement is an internet payment transaction.

Allowed from version 9.4.6.

need_receipt instance-attribute

need_receipt: bool

Whether paper cheque should be printed.

phone class-attribute instance-attribute

phone: str | None = None

Phone to send cheque information (by sms) or null if the cheque shouldn't be sent by sms.

retail_address class-attribute instance-attribute

retail_address: str | None = None

Retail address.

Allowed from version 9.4.6.

settlement_place class-attribute instance-attribute

settlement_place: str | None = None

Settlement place.

Combo

Bases: IikoModel

Combo in order.

amount instance-attribute

amount: int

Quantity.

id instance-attribute

id: str

Combo ID. MUST be unique for the whole system. Therefore it must be generated with Guid.NewGuid().

name instance-attribute

name: str

Name of combo.

price instance-attribute

price: Decimal

Price of one combo.

program_id class-attribute instance-attribute

program_id: str | None = None

Card program ID.

Allowed from version 7.6.1.

size_id class-attribute instance-attribute

size_id: str | None = None

Size ID. Required if combo has a size scale.

Allowed from version 8.5.6.

source_id instance-attribute

source_id: str

Combo validity ID.

ComboItemInformation

Bases: IikoModel

Combo details if order item belongs to combo

combo_group_id instance-attribute

combo_group_id: str

Combo group ID to which item belongs.

combo_group_name class-attribute instance-attribute

combo_group_name: str | None = None

Combo group name to which item belongs.

combo_id instance-attribute

combo_id: str

Created combo ID. Must be one of combos.id generated values.

combo_source_id instance-attribute

combo_source_id: str

Action ID that defines combo.

CompoundItemTemplate

Bases: IikoModel

Modifier scheme information.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

CompoundOrderItem

Bases: OrderItemBase

Order item: composite item.

common_modifiers class-attribute instance-attribute

common_modifiers: list[Modifier] | None = None

Indivisible modifiers.

primary_component instance-attribute

primary_component: CompoundOrderItemComponent

Main component.

secondary_component class-attribute instance-attribute

secondary_component: CompoundOrderItemComponent | None = (
    None
)

Minor component.

CompoundOrderItemComponent

Bases: IikoModel

Item component

modifiers class-attribute instance-attribute

modifiers: list[Modifier] | None = None

Modifiers.

position_id class-attribute instance-attribute

position_id: str | None = None

Unique identifier of the item in the order. MUST be unique for the whole system. Therefore it must be generated with Guid.NewGuid(). If sent null, it generates automatically on iikoTransport side.

price class-attribute instance-attribute

price: Decimal | None = None

Price.

product_id instance-attribute

product_id: str

Item ID.

Coordinates

Bases: IikoModel

Coordinate details.

latitude instance-attribute

latitude: Decimal

Latitude.

longitude instance-attribute

longitude: Decimal

Longitude.

CorrelationIdResponse

Bases: IikoModel

Wrapping object (external) for CorrelationId return.

correlation_id instance-attribute

correlation_id: str

Operation ID.

CourierInfo

Bases: IikoModel

Driver information.

courier instance-attribute

courier: RetrievedEmployee

Order driver.

is_courier_selected_manually instance-attribute

is_courier_selected_manually: bool

Whether driver is selected manually.

CreationStatus

Bases: OpenStrEnum

Order creation status.

CustomerBase

Bases: IikoModel

Customer base info.

DeletionMethod

Bases: IikoModel

Deletion method.

comment class-attribute instance-attribute

comment: str | None = None

Comment.

id instance-attribute

id: str

ID.

removal_type instance-attribute

removal_type: RetrievedRemovalType

Write-off type.

DeliveriesResponseOrderPaymentType

Bases: IikoModel

Payment type.

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

id instance-attribute

id: str

ID.

kind instance-attribute

kind: PaymentTypeKind

Payment type classifier.

name instance-attribute

name: str

Name.

DeliveriesResponseOrderStreet

Bases: IikoModel

Street.

city instance-attribute

city: RetrievedCity

City.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

DeliveryOrderPaymentSettings

Bases: OpenStrEnum

Delivery payment time option.

DeliveryPoint

Bases: IikoModel

Delivery location details.

address class-attribute instance-attribute

address: Address | None = None

Order delivery address.

The use of type City is allowed if the parameter addressFormatType == City.

Can be obtained by /api/1/organizations or /api/1/organizations/settings operations (addressFormatType parameter).

comment class-attribute instance-attribute

comment: str | None = None

Additional information.

coordinates class-attribute instance-attribute

coordinates: Coordinates | None = None

Delivery address coordinates. Allowed from version 7.7.3.

external_cartography_id class-attribute instance-attribute

external_cartography_id: str | None = None

Delivery location custom code in customer's API system.

DeliveryServiceType

Bases: OpenStrEnum

Order type.

DeliverySettingsServiceType

Bases: OpenStrEnum

Delivery settings service type.

DeliveryStatus

Bases: OpenStrEnum

Delivery order statuses.

DeliveryStreet

Bases: IikoModel

Street.

city class-attribute instance-attribute

city: str | None = None

City name.

classifier_id class-attribute instance-attribute

classifier_id: str | None = None

Street ID in classifier, e.g., address database. \n > For using in the Russian Federation only.

id class-attribute instance-attribute

id: str | None = None

ID.

Can be obtained by /api/1/streets/by_city operation.

name class-attribute instance-attribute

name: str | None = None

Name.

DiscountBase

Bases: IikoModel

Discount/surcharge.

DiscountCard

Bases: IikoModel

Discount card.

track instance-attribute

track: str

Track of discount card to be applied to order.

DiscountItem

Bases: IikoModel

Discount.

discount_type instance-attribute

discount_type: DiscountType

Discount type.

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

selective_positions class-attribute instance-attribute

selective_positions: list[str] | None = None

Order item positions.

selective_positions_with_sum class-attribute instance-attribute

selective_positions_with_sum: (
    list[PositionWithSum] | None
) = None

Order item positions with position discount sum.

Allowed from version 8.5.6.

sum instance-attribute

sum: Decimal

Total.

DiscountType

Bases: IikoModel

Discount type.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

DiscountsInfo

Bases: IikoModel

Information on discounts/surcharges to be applied to order.

Whether map or non-blank list of discounts must be set.

card class-attribute instance-attribute

card: DiscountCard | None = None

Track of discount card to be applied to order.

discounts class-attribute instance-attribute

discounts: list[Discount] | None = None

Discounts/surcharges.

Type iikoCard allowed from version 7.4.4.

fixed_loyalty_discounts class-attribute instance-attribute

fixed_loyalty_discounts: bool | None = None

Whether loyalty discounts should be fixed.

DynamicDiscount

Bases: IikoModel

Dynamic discount.

manual_condition_id instance-attribute

manual_condition_id: str

Applied manual condition ID.

sum instance-attribute

sum: Decimal

Discount sum.

ErrorCode

Bases: OpenStrEnum

ErrorCode values.

ErrorInfo

Bases: IikoModel

DTO for error details transfer.

additional_data class-attribute instance-attribute

additional_data: Any | None = None

Additional information.

code instance-attribute

code: ErrorCode

Error code.

description class-attribute instance-attribute

description: str | None = None

Deprecated. Localized message.

error_reason class-attribute instance-attribute

error_reason: str | None = None

Error reason.

message class-attribute instance-attribute

message: str | None = None

Localized message.

ExtendedOrganizationInfo

Bases: OrganizationInfoBase

Organization details.

address_format_type instance-attribute

address_format_type: AddressFormatType

Address format type.

address_lookup instance-attribute

address_lookup: list[AddressHintsServiceType]

Available address lookup services.

confirm_allowed_interval_in_minutes class-attribute instance-attribute

confirm_allowed_interval_in_minutes: int | None = None

Confirm orders time interval.

country class-attribute instance-attribute

country: str | None = None

Country.

country_phone_code class-attribute instance-attribute

country_phone_code: str | None = None

Country dialing code.

currency_iso_name class-attribute instance-attribute

currency_iso_name: str | None = None

ISO currency code (for example: RUB, USD, EUR).

currency_minimum_denomination class-attribute instance-attribute

currency_minimum_denomination: Decimal | None = None

Value rounding of position.

default_call_center_payment_type_id class-attribute instance-attribute

default_call_center_payment_type_id: str | None = None

Default payment type for CallCenter.

default_delivery_city_id class-attribute instance-attribute

default_delivery_city_id: str | None = None

Default delivery city.

delivery_city_ids class-attribute instance-attribute

delivery_city_ids: list[str] | None = None

Delivery cities.

delivery_order_payment_settings class-attribute instance-attribute

delivery_order_payment_settings: (
    DeliveryOrderPaymentSettings | None
) = None

Delivery order payment settings.

delivery_service_type class-attribute instance-attribute

delivery_service_type: (
    DeliverySettingsServiceType | None
) = None

Delivery type.

inn class-attribute instance-attribute

inn: str | None = None

Restaurant`s INN (Taxpayer Identification Number).

is_anonymous_guests_allowed class-attribute instance-attribute

is_anonymous_guests_allowed: bool | None = None

If the store allows orders for anonymous guests, then it is not necessary to transfer information about the guest as part of the delivery order. You can only transfer the phone number and optionally name of the guest, which will not be stored in the guest base and will only be used for the delivery of a current delivery order.

is_cloud instance-attribute

is_cloud: bool

Determines whether organization is hosted in iikoCloud.

is_confirmation_enabled class-attribute instance-attribute

is_confirmation_enabled: bool | None = None

Determines whether to use delivery confirmation.

latitude instance-attribute

latitude: Decimal

Latitude.

longitude instance-attribute

longitude: Decimal

Longitude.

marketing_source_required_in_delivery class-attribute instance-attribute

marketing_source_required_in_delivery: bool | None = None

Require mandatory marketing source input when creating a delivery.

order_item_comment_enabled class-attribute instance-attribute

order_item_comment_enabled: bool | None = None

Allow text comments for order items (in all restaurant sections).

restaurant_address class-attribute instance-attribute

restaurant_address: str | None = None

Restaurant address.

use_uae_addressing_system instance-attribute

use_uae_addressing_system: bool

Regional setting "Use the UAE Addressing System".

version instance-attribute

version: str

RMS version.

ExternalCourierService

Bases: IikoModel

ECS info (external courier service).

id instance-attribute

id: str

ECS setting record id. Unique through all organizations.

name instance-attribute

name: str

ECS name.

ExternalData

Bases: IikoModel

Order external data.

is_public class-attribute instance-attribute

is_public: bool | None = None

The transmitted data may contain both technical identifiers and information useful for the restaurant employee. If it is necessary for the data to be included in the sales report, then this parameter must be set to TRUE, otherwise to FALSE.

key instance-attribute

key: str

Key.

value instance-attribute

value: str

Value.

ExternalDataEntry

Bases: IikoModel

External data key and value pair.

key instance-attribute

key: str

External data key.

value instance-attribute

value: str

External data value.

ExternalPayment

Bases: PaymentBase

External payment type

ExternalPaymentAdditionalData

Bases: PaymentAdditionalDataBase

Additional data for external payment item.

custom_data instance-attribute

custom_data: str

Payment custom data.

ExternalTipsPayment

Bases: TipsPaymentBase

External tips payment type

FilterCondition

Bases: IikoModel

FilterCondition.

field class-attribute instance-attribute

field: str | None = None

Field name for filtering

op class-attribute instance-attribute

op: str | None = None

Operation ("eq", "ne", "gt", "gte", "lt", "lte", "in", "nin", "like", "blank", "notblank")

value class-attribute instance-attribute

value: Any | None = None

Value for filtering by the field

Gender

Bases: OpenStrEnum

Sex.

GetByIDRequest

Bases: IikoModel

GetByIDRequest.

document_id instance-attribute

document_id: str

Document identifier (GUID)

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

GetOrganizationsRequest

Bases: IikoModel

Request for organizations.

include_disabled class-attribute instance-attribute

include_disabled: bool | None = None

Attribute that shows that response contains disabled organizations.

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

Organizations IDs which have to be returned. By default - all organizations from apiLogin.

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

return_additional_info class-attribute instance-attribute

return_additional_info: bool | None = 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).

return_external_data class-attribute instance-attribute

return_external_data: list[str] | None = None

External data keys that have to be returned.

GetOrganizationsResponse

Bases: IikoModel

Response to request for organizations.

correlation_id instance-attribute

correlation_id: str

Operation ID.

organizations instance-attribute

organizations: list[OrganizationInfo]

List of organizations.

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

Guests

Bases: IikoModel

Information on guests.

count instance-attribute

count: int

Number of persons in order. This field defines the number of cutlery sets

split_between_persons class-attribute instance-attribute

split_between_persons: bool | None = None

Attribute that shows whether order must be split among guests.

IdentifierCode

Bases: IikoModel

Product code.

value class-attribute instance-attribute

value: str | None = None

Product code value.

IikoCardDiscount

Bases: DiscountBase

Card discount/surcharge.

discount_items instance-attribute

discount_items: list[IikoCardDiscountItem]

Discount information for order items.

program_id instance-attribute

program_id: str

Card program ID.

program_name instance-attribute

program_name: str

Card program name.

IikoCardDiscountItem

Bases: IikoModel

Card discount/surcharge item.

amount instance-attribute

amount: Decimal

Amount.

position_id instance-attribute

position_id: str

Position ID of order item.

sum instance-attribute

sum: Decimal

Discount/surcharge sum.

IikoCardSearchScope

Bases: OpenStrEnum

IikoCardSearchScope values.

ItemDeletedInfo

Bases: IikoModel

Order cancellation details.

deletion_method instance-attribute

deletion_method: DeletionMethod

Deletion method.

ListRequest

Bases: IikoModel

ListRequest.

from_ class-attribute instance-attribute

from_: str = Field(alias='from')

Period start date (YYYY-MM-DD format)

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

to instance-attribute

to: str

Period end date (YYYY-MM-DD format)

LoyaltyCardPayment

Bases: PaymentBase

Payment with Card loyalty system.

LoyaltyCardPaymentAdditionalData

Bases: PaymentAdditionalDataBase

Additional data for LoyaltyApp payment item.

credential instance-attribute

credential: str

Guest credential, authorizing payment.

search_scope instance-attribute

search_scope: IikoCardSearchScope

Guest credential search scope.

LoyaltyInfo

Bases: IikoModel

Information about Loyalty app.

applicable_manual_conditions class-attribute instance-attribute

applicable_manual_conditions: list[str] | None = None

Information about applied manual conditions.

coupon class-attribute instance-attribute

coupon: str | None = None

Coupon No. that was considered when calculating loyalty program.

dynamic_discounts class-attribute instance-attribute

dynamic_discounts: list[DynamicDiscount] | None = None

Dynamic discounts.

Allowed from version 9.4.6.

Modifier

Bases: IikoModel

Modifier.

amount instance-attribute

amount: Decimal

Quantity.

position_id class-attribute instance-attribute

position_id: str | None = None

Unique identifier of the item in the order. MUST be unique for the whole system. Therefore it must be generated with Guid.NewGuid(). If sent null, it generates automatically on iikoTransport side.

price class-attribute instance-attribute

price: Decimal | None = None

Unit price.

product_group_id class-attribute instance-attribute

product_group_id: str | None = None

Modifiers group ID (for group modifier). Required for a group modifier.

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

product_id instance-attribute

product_id: str

Modifier item ID.

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

OrderCombo

Bases: IikoModel

Combo in order.

amount instance-attribute

amount: int

Number of combos.

id instance-attribute

id: str

Combo ID.

name instance-attribute

name: str

Name of combo.

price instance-attribute

price: Decimal

Price of combo. Given for 1 combo, without regard to amount.

size class-attribute instance-attribute

size: RetrievedProductSize | None = None

Size.

source_id instance-attribute

source_id: str

Combo action ID.

OrderInfo

Bases: IikoModel

Order.

creation_status instance-attribute

creation_status: CreationStatus

Order creation status. In case of asynchronous creation, it allows to track the instance an order was validated/created in iikoFront.

error_info class-attribute instance-attribute

error_info: ErrorInfo | None = None

Order creation error details. Required only if "creationStatus"="Error".

external_number class-attribute instance-attribute

external_number: str | None = None

Order external number.

id instance-attribute

id: str

Delivery order ID.

order class-attribute instance-attribute

order: RetrievedOrder | None = None

Order creation details. Field is filled up if "creationStatus"="Success".

organization_id instance-attribute

organization_id: str

Organization ID.

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

pos_id class-attribute instance-attribute

pos_id: str | None = None

POS delivery order ID.

timestamp instance-attribute

timestamp: int

Timestamp of most recent order change that took place on iikoTransport server.

OrderItemBase

Bases: IikoModel

Order item.

amount instance-attribute

amount: Decimal

Quantity.

combo_information class-attribute instance-attribute

combo_information: ComboItemInformation | None = None

Combo details if combo includes order item.

comment class-attribute instance-attribute

comment: str | None = None

Comment.

product_size_id class-attribute instance-attribute

product_size_id: str | None = None

Size ID. Required if a stock list item has a size scale.

OrderItemIdentifierCode

Bases: IikoModel

OrderItem's IdentifierCode.

code instance-attribute

code: IdentifierCode

Product code.

flags instance-attribute

flags: list[str]

Application flags.

id instance-attribute

id: str

Id of order's position.

OrderItemModifier

Bases: IikoModel

Order item modifier.

amount instance-attribute

amount: Decimal

Quantity.

amount_independent_of_parent_amount instance-attribute

amount_independent_of_parent_amount: bool

Whether quantity of modifier depends on quantity of item.

codes class-attribute instance-attribute

codes: list[list[OrderItemIdentifierCode]] | None = None

List of product codes. Each outer list item represents a separate product unit; each inner list contains codes associated with that unit.

Allowed from version 9.3.6.

default_amount class-attribute instance-attribute

default_amount: int | None = None

Default amount.

deleted class-attribute instance-attribute

deleted: ItemDeletedInfo | None = None

Item deletion details. If specified, the item is deleted.

free_of_charge_amount class-attribute instance-attribute

free_of_charge_amount: int | None = None

Free of charge amount.

hide_if_default_amount class-attribute instance-attribute

hide_if_default_amount: bool | None = None

Hide modifier in UI if "amount" equals "defaultAmount".

position_id class-attribute instance-attribute

position_id: str | None = None

Unique identifier of the item in the order and for the whole system.

price instance-attribute

price: Decimal

Price per item unit. Can be sent different from the price in RMS.

price_predefined instance-attribute

price_predefined: bool

Whether price is predefined.

product instance-attribute

product: RetrievedProduct

Item.

product_group class-attribute instance-attribute

product_group: ProductGroup | None = None

Group of modifiers (in case of a group modifier).

result_sum instance-attribute

result_sum: Decimal

Total amount per item including tax, discounts/surcharges.

tax_percent class-attribute instance-attribute

tax_percent: Decimal | None = None

Tax rate.

OrderItemStatus

Bases: OpenStrEnum

Order item status.

OrderServiceType

Bases: OpenStrEnum

Order type.

OrderStatus

Bases: OpenStrEnum

Describes the status of an order.

OrganizationInfoBase

Bases: IikoModel

Organization details.

code class-attribute instance-attribute

code: str | None = None

Organization`s code.

external_data class-attribute instance-attribute

external_data: list[ExternalDataEntry] | None = None

Organization`s external data.

id instance-attribute

id: str

Organization ID.

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

name class-attribute instance-attribute

name: str | None = None

Organization name.

OrganizationItems

Bases: IikoModel, Generic[T]

Items that belong to a single organization.

items instance-attribute

items: list[T]

Items of the organization.

organization_id instance-attribute

organization_id: str

Organization ID.

PaymentAdditionalDataBase

Bases: IikoModel

Additional payment data.

PaymentBase

Bases: IikoModel

Base class of delivery order payment item.

is_fiscalized_externally class-attribute instance-attribute

is_fiscalized_externally: bool | None = None

Whether the payment item is externally fiscalized.

Allowed from version 7.6.3.

is_prepay class-attribute instance-attribute

is_prepay: bool | None = None

Deprecated. Whether the payment item is prepay. Unavailable for paymentKindType.LoyaltyCard.

Allowed from version 8.2.6.

is_processed_externally class-attribute instance-attribute

is_processed_externally: bool | None = None

Whether payment item is processed by external payment system (made from outside).

payment_additional_data class-attribute instance-attribute

payment_additional_data: PaymentAdditionalData | None = None

Additional payment parameters.

payment_type_id instance-attribute

payment_type_id: str

Payment type.

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

sum instance-attribute

sum: Decimal

Amount due.

PaymentItem

Bases: IikoModel

Delivery order payment component.

is_external instance-attribute

is_external: bool

Payment item is external (created via biz.API).

is_fiscalized_externally class-attribute instance-attribute

is_fiscalized_externally: bool | None = None

Whether the payment item is externally fiscalized.

Allowed from version 7.6.3.

is_preliminary instance-attribute

is_preliminary: bool

Whether payment item is preliminary.

is_prepay instance-attribute

is_prepay: bool

Whether the payment item is prepay.

Allowed from version 7.7.6.

is_processed_externally instance-attribute

is_processed_externally: bool

Payment item is processed by external payment system.

payment_type instance-attribute

payment_type: DeliveriesResponseOrderPaymentType

Payment type.

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

sum instance-attribute

sum: Decimal

Amount due.

PaymentTypeKind

Bases: OpenStrEnum

Payment type kind.

PositionWithSum

Bases: IikoModel

Order item positions with position discount sum.

position_id instance-attribute

position_id: str

Order item position ID.

sum instance-attribute

sum: Decimal

Position discount sum.

PriceCategory

Bases: IikoModel

Price category of the order.

id instance-attribute

id: str

Id of price category.

name class-attribute instance-attribute

name: str | None = None

Name of price category.

Problem

Bases: IikoModel

Order problem details.

description class-attribute instance-attribute

description: str | None = None

Problem description.

has_problem instance-attribute

has_problem: bool

Has problem.

ProductGroup

Bases: IikoModel

Item category.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

ProductOrderItem

Bases: OrderItemBase

Order item: item.

modifiers class-attribute instance-attribute

modifiers: list[Modifier] | None = None

Modifiers.

position_id class-attribute instance-attribute

position_id: str | None = None

Unique identifier of the item in the order. MUST be unique for the whole system. Therefore it must be generated with Guid.NewGuid(). If sent null, it generates automatically on iikoTransport side.

price instance-attribute

price: Decimal

Price per item unit. Can be sent different from the price in the base menu.

product_id instance-attribute

product_id: str

ID of menu item.

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

RegularCustomer

Bases: CustomerBase

'Regular' customer: - can be used only if a customer agrees to take part in the store's loyalty programs - customer details will be added (updated) to the store's customer database - benefits (accumulation of rewards, etc.) of active loyalty programs will be made available to the customer

birthdate class-attribute instance-attribute

birthdate: IikoDateTime | None = None

Date of birth.

comment class-attribute instance-attribute

comment: str | None = None

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 is searched in database, otherwise the new customer is created in RMS.

name class-attribute instance-attribute

name: str | None = None

Name of customer. Required for new customers (i.e. 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.

should_receive_promo_actions_info class-attribute instance-attribute

should_receive_promo_actions_info: bool | None = None

Deprecated. Deprecated, use "shouldReceiveOrderStatusNotifications" instead.

surname class-attribute instance-attribute

surname: str | None = None

Last name.

Reserve

Bases: IikoModel

Banquet/reserve.

cancel_reason class-attribute instance-attribute

cancel_reason: ReserveCancelReason | None = None

The reserve cancellation reason or null if the reserve hasn't been canceled.

comment class-attribute instance-attribute

comment: str | None = None

Optional comment for reserve or banquet.

customer instance-attribute

customer: RetrievedCustomer

Client that placed the 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.

event_type class-attribute instance-attribute

event_type: str | None = None

Event type.

Allowed from version 8.5.6.

guests_coming_time class-attribute instance-attribute

guests_coming_time: IikoDateTime | None = None

Time when guests came and reserve was closed or banquet was started.

guests_count instance-attribute

guests_count: int

Estimated guests count.

order class-attribute instance-attribute

order: RetrievedReserveOrder | None = None

Order. Used only at a banquet.

phone class-attribute instance-attribute

phone: str | None = None

Telephone number.

should_remind instance-attribute

should_remind: bool

Whether to remind staff to prepare table beforehand.

status instance-attribute

status: ReserveStatus

Status of the reserve or banquet.

table_ids instance-attribute

table_ids: list[str]

Reserved table IDs.

ReserveCancelReason

Bases: OpenStrEnum

Reason why planned event failed.

ReserveInfo

Bases: IikoModel

Banquet/reserve.

creation_status instance-attribute

creation_status: CreationStatus

Banquet/reserve creation status. In case of asynchronous creation, it allows to track the instance an banquet/reserve was validated/created in iikoFront.

error_info class-attribute instance-attribute

error_info: ErrorInfo | None = None

Banquet/reserve creation error details. Required only if "creationStatus"="Error".

external_number class-attribute instance-attribute

external_number: str | None = None

Banquet/reserve external number.

id instance-attribute

id: str

Banquet/reserve ID.

is_deleted instance-attribute

is_deleted: bool

Banquet/reserve is deleted.

organization_id instance-attribute

organization_id: str

Organization ID.

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

reserve class-attribute instance-attribute

reserve: Reserve | None = None

Banquet/reserve.

timestamp instance-attribute

timestamp: int

Timestamp of most recent banquet/reserve change that took place on iikoTransport server.

ReserveStatus

Bases: OpenStrEnum

Describes the status of a reserve or a banquet.

RetrievedAddress

Bases: IikoModel

Address details.

building class-attribute instance-attribute

building: str | None = None

Building.

doorphone class-attribute instance-attribute

doorphone: str | None = None

Intercom.

entrance class-attribute instance-attribute

entrance: str | None = None

Entrance.

flat class-attribute instance-attribute

flat: str | None = None

Apartment.

floor class-attribute instance-attribute

floor: str | None = None

Floor.

house class-attribute instance-attribute

house: str | None = None

House.

index class-attribute instance-attribute

index: str | None = None

Postcode.

line1 class-attribute instance-attribute

line1: str | None = None

Address line 1. Contains the primary address information.

region class-attribute instance-attribute

region: RetrievedRegion | None = None

Region

street class-attribute instance-attribute

street: DeliveriesResponseOrderStreet | None = None

Street.

RetrievedAnonymousCustomer

Bases: RetrievedCustomerBase

'One-time' customer: - should be used if a customer does not agree to take part in the store's loyalty programs or an aggregator (external system) does not provide customer details - customer details will NOT be added to the store's customer database and will be used ONLY to complete the current order

name instance-attribute

name: str

Customer name.

RetrievedCancelCause

Bases: IikoModel

Delivery cancellation reason.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Description.

RetrievedCity

Bases: IikoModel

City.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

RetrievedComboItemInformation

Bases: IikoModel

Information on order item to combo relation.

combo_id instance-attribute

combo_id: str

New combo ID.

combo_source_id instance-attribute

combo_source_id: str

Action ID that defines combo.

group_id instance-attribute

group_id: str

Combo group ID to which item belongs.

group_name class-attribute instance-attribute

group_name: str | None = None

Combo group name to which item belongs.

RetrievedCompoundOrderItem

Bases: RetrievedOrderItemBase

Order item: composite item.

common_modifiers class-attribute instance-attribute

common_modifiers: list[OrderItemModifier] | None = None

Indivisible modifiers.

primary_component instance-attribute

primary_component: RetrievedCompoundOrderItemComponent

Main component.

secondary_component class-attribute instance-attribute

secondary_component: (
    RetrievedCompoundOrderItemComponent | None
) = None

Additional component.

template class-attribute instance-attribute

template: CompoundItemTemplate | None = None

Modifier scheme.

RetrievedCompoundOrderItemComponent

Bases: IikoModel

Part of composite item.

cost instance-attribute

cost: Decimal

Item total including tax, discounts/surcharges.

modifiers class-attribute instance-attribute

modifiers: list[OrderItemModifier] | None = None

Modifiers.

position_id class-attribute instance-attribute

position_id: str | None = None

Unique identifier of the item in the order and for the whole system.

price instance-attribute

price: Decimal

Price per item unit. Can be sent different from the price in the base menu.

price_predefined instance-attribute

price_predefined: bool

Whether price is predefined.

product instance-attribute

product: RetrievedProduct

Item.

result_sum class-attribute instance-attribute

result_sum: Decimal | None = None

Total amount per item including tax, discounts/surcharges.

tax_percent class-attribute instance-attribute

tax_percent: Decimal | None = None

Tax rate.

RetrievedConception

Bases: IikoModel

Concept.

code instance-attribute

code: str

Code.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

RetrievedCustomerBase

Bases: IikoModel

Delivery customer.

RetrievedDeliveryPoint

Bases: IikoModel

Delivery address coordinates.

address class-attribute instance-attribute

address: RetrievedAddress | None = None

Delivery address details.

comment class-attribute instance-attribute

comment: str | None = None

Comment.

coordinates class-attribute instance-attribute

coordinates: Coordinates | None = None

Delivery address coordinates.

external_cartography_id class-attribute instance-attribute

external_cartography_id: str | None = None

Address ID in external mapping system.

RetrievedDynamicDiscount

Bases: IikoModel

Dynamic discount.

manual_condition_id instance-attribute

manual_condition_id: str

Applied manual condition ID.

sum instance-attribute

sum: Decimal

Discount sum.

RetrievedEmployee

Bases: IikoModel

Employee.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

phone class-attribute instance-attribute

phone: str | None = None

Phone.

RetrievedExternalData

Bases: IikoModel

Order external data.

key instance-attribute

key: str

Key.

value instance-attribute

value: str

Public.

RetrievedGuestsInfo

Bases: IikoModel

Information about order guests.

count instance-attribute

count: int

Number of persons.

split_between_persons instance-attribute

split_between_persons: bool

Attribute that shows whether order must be split among guests.

RetrievedLoyaltyInfo

Bases: IikoModel

Information about Loyalty app.

applied_manual_conditions class-attribute instance-attribute

applied_manual_conditions: list[str] | None = None

Information about applied manual conditions.

coupon class-attribute instance-attribute

coupon: str | None = None

Coupon No. that was considered when calculating loyalty program.

dynamic_discounts class-attribute instance-attribute

dynamic_discounts: list[RetrievedDynamicDiscount] | None = (
    None
)

Dynamic discounts.

Allowed from version 9.4.6.

RetrievedMarketingSource

Bases: IikoModel

Marketing source.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

RetrievedOrder

Bases: IikoModel

Order details.

cancel_info class-attribute instance-attribute

cancel_info: CancelInfo | None = None

Delivery cancellation details.

Required only if delivery is canceled, i.e. status=Canceled.

combos class-attribute instance-attribute

combos: list[OrderCombo] | None = None

Combo.

comment class-attribute instance-attribute

comment: str | None = None

Order comment.

complete_before instance-attribute

complete_before: IikoDateTime

Order fulfillment time (Local for the terminal).

conception class-attribute instance-attribute

conception: RetrievedConception | None = None

Concept.

cooking_start_time instance-attribute

cooking_start_time: IikoDateTime

The time when you need to start cooking an order (Local for the terminal).

courier_info class-attribute instance-attribute

courier_info: CourierInfo | None = None

Driver information.

customer class-attribute instance-attribute

customer: RetrievedCustomer | None = None

Delivery customer.

delivery_duration class-attribute instance-attribute

delivery_duration: int | None = None

Duration of delivery (in minutes).

delivery_point class-attribute instance-attribute

delivery_point: RetrievedDeliveryPoint | None = None

Delivery point details.

Not required if order type is customer pickup. Otherwise, required.

delivery_zone class-attribute instance-attribute

delivery_zone: str | None = None

Name of delivery zone.

discounts class-attribute instance-attribute

discounts: list[DiscountItem] | None = None

Discounts.

estimated_time class-attribute instance-attribute

estimated_time: IikoDateTime | None = None

Delivery estimated time.

external_courier_service class-attribute instance-attribute

external_courier_service: ExternalCourierService | None = (
    None
)

ECS info.

Allowed from version 7.7.7.

external_data class-attribute instance-attribute

external_data: list[RetrievedExternalData] | None = None

Order external data.

Allowed from version 8.0.6.

guests_info class-attribute instance-attribute

guests_info: RetrievedGuestsInfo | None = None

Information about order guests.

index_in_courier_route class-attribute instance-attribute

index_in_courier_route: int | None = None

Ordinal number in route list.

Field is filled up at the time of delivery allocation by logistics in iikoFront. If logistics is not in use, the field is not filled up.

is_asap class-attribute instance-attribute

is_asap: bool | None = None

Whether to deliver as soon as possible.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Deprecated. Order is deleted.

items instance-attribute

items: list[RetrievedOrderItem]

Order items.

locked_at class-attribute instance-attribute

locked_at: IikoDateTime | None = None

Timestamp of when the order was taken for editing (lock).

loyalty_info class-attribute instance-attribute

loyalty_info: RetrievedLoyaltyInfo | None = None

Information about Loyalty app.

null - only for unsupported POS versions.

marketing_source class-attribute instance-attribute

marketing_source: RetrievedMarketingSource | None = None

Marketing source.

menu_id class-attribute instance-attribute

menu_id: str | None = None

External menu ID.

moved_from_delivery_id class-attribute instance-attribute

moved_from_delivery_id: str | None = None

Tells that this delivery has been moved from terminal group with id MovedFromTerminalGroupId by cancelling delivery with deliveryId MovedFromDeliveryId.

Allowed from version 7.5.4.

moved_from_organization_id class-attribute instance-attribute

moved_from_organization_id: str | None = None

Tells that this delivery has been moved from terminal group with id MovedFromTerminalGroupId by cancelling delivery with deliveryId MovedFromDeliveryId.

Allowed from version 7.5.4.

moved_from_terminal_group_id class-attribute instance-attribute

moved_from_terminal_group_id: str | None = None

Tells that this delivery has been moved from terminal group with id MovedFromTerminalGroupId by cancelling delivery with deliveryId MovedFromDeliveryId.

Allowed from version 7.5.4.

moved_to_delivery_id class-attribute instance-attribute

moved_to_delivery_id: str | None = None

Tells that this delivery has been canceled and moved to terminal group with id MovedToTerminalGroupId.

number instance-attribute

number: int

Delivery No.

operator class-attribute instance-attribute

operator: RetrievedEmployee | None = None

Operator that took order.

order_type class-attribute instance-attribute

order_type: RetrievedOrderType | None = None

Order type.

parent_delivery_id class-attribute instance-attribute

parent_delivery_id: str | None = None

ID of delivery serving as source for splitting by FCRs.

payments class-attribute instance-attribute

payments: list[PaymentItem] | None = None

Payments.

phone instance-attribute

phone: str

Delivery phone number.

phone_extension class-attribute instance-attribute

phone_extension: str | None = None

Extension delivery phone number.

price_category class-attribute instance-attribute

price_category: PriceCategory | None = None

Price category of the order.

Allowed from version 9.0.5.

problem class-attribute instance-attribute

problem: Problem | None = None

Problem flag.

processed_payments_sum class-attribute instance-attribute

processed_payments_sum: Decimal | None = None

The amount of processed payments.

null - only for unsupported POS versions.

Allowed from version 7.6.0.

source_key class-attribute instance-attribute

source_key: str | None = None

Delivery source.

status instance-attribute

status: DeliveryStatus

Delivery status.

Delivery status ReadyForCooking is deprecated from version 9.0.6.

sum instance-attribute

sum: Decimal

Order amount (after discount or surcharge).

terminal_group_id instance-attribute

terminal_group_id: str

ID of the terminal group where the order is located.

tips class-attribute instance-attribute

tips: list[TipsPaymentItem] | None = None

Tips.

tracking_link class-attribute instance-attribute

tracking_link: str | None = None

Order's tracking link.

when_bill_printed class-attribute instance-attribute

when_bill_printed: IikoDateTime | None = None

Invoice printing time (guest bill time).

when_closed class-attribute instance-attribute

when_closed: IikoDateTime | None = None

Delivery closing time (Local for delivery terminal).

when_confirmed class-attribute instance-attribute

when_confirmed: IikoDateTime | None = None

Delivery confirmation time (Local for the terminal).

when_cooking_completed class-attribute instance-attribute

when_cooking_completed: IikoDateTime | None = None

Cooking completion time (Local for the terminal).

when_created instance-attribute

when_created: IikoDateTime

Delivery creation time in iikoFront (Local for the terminal).

when_delivered class-attribute instance-attribute

when_delivered: IikoDateTime | None = None

Actual delivery time (Local for delivery terminal).

when_packed class-attribute instance-attribute

when_packed: IikoDateTime | None = None

Delivery packing time (Local for the terminal).

when_printed class-attribute instance-attribute

when_printed: IikoDateTime | None = None

Service printing time (Local for the terminal).

when_received_by_api class-attribute instance-attribute

when_received_by_api: IikoDateTime | None = None

Deprecated. Moment of time when CloudAPI received the request to create the order (UTC).

when_received_from_front class-attribute instance-attribute

when_received_from_front: IikoDateTime | None = None

Deprecated. Moment of time when the order first received and saved from iikoFront (UTC).

when_sended class-attribute instance-attribute

when_sended: IikoDateTime | None = None

Delivery dispatch time (Local for the terminal).

RetrievedOrderItemBase

Bases: IikoModel

Order item.

amount instance-attribute

amount: Decimal

Quantity.

combo_information class-attribute instance-attribute

combo_information: RetrievedComboItemInformation | None = (
    None
)

Combo details, if order item is part of combo.

comment class-attribute instance-attribute

comment: str | None = None

Comment.

deleted class-attribute instance-attribute

deleted: ItemDeletedInfo | None = None

Item deletion details. If filled up, item is deleted.

size class-attribute instance-attribute

size: RetrievedProductSize | None = None

Size.

status instance-attribute

status: OrderItemStatus

Item cooking status.

when_printed class-attribute instance-attribute

when_printed: IikoDateTime | None = None

Printing time (Local for the terminal).

RetrievedOrderStatus

Bases: OpenStrEnum

Describes the status of an order.

RetrievedOrderType

Bases: IikoModel

Order type.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

order_service_type instance-attribute

order_service_type: OrderServiceType

Order type.

RetrievedProduct

Bases: IikoModel

Item.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

RetrievedProductOrderItem

Bases: RetrievedOrderItemBase

Order item: item.

codes class-attribute instance-attribute

codes: list[list[OrderItemIdentifierCode]] | None = None

List of product codes. Each outer list item represents a separate product unit; each inner list contains codes associated with that unit.

Allowed from version 9.2.6.

cost instance-attribute

cost: Decimal

Total cost per item without tax, discounts/surcharges.

modifiers class-attribute instance-attribute

modifiers: list[OrderItemModifier] | None = None

Modifiers.

position_id class-attribute instance-attribute

position_id: str | None = None

Unique identifier of the item in the order and for the whole system.

price instance-attribute

price: Decimal

Price per item unit. Can be sent different from the price in the base menu.

price_predefined instance-attribute

price_predefined: bool

Whether price is predefined.

product instance-attribute

product: RetrievedProduct

Item.

result_sum class-attribute instance-attribute

result_sum: Decimal | None = None

Total amount per item including tax, discounts/surcharges.

tax_percent class-attribute instance-attribute

tax_percent: Decimal | None = None

Tax rate.

RetrievedProductSize

Bases: IikoModel

Item size.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

RetrievedRegion

Bases: IikoModel

Delivery district (part of delivery address).

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

RetrievedRegularCustomer

Bases: RetrievedCustomerBase

RetrievedRegularCustomer.

birthdate class-attribute instance-attribute

birthdate: IikoDateTime | None = None

Date of birth.

Allowed from version 7.6.1.

blacklist_reason class-attribute instance-attribute

blacklist_reason: str | None = None

Reason why client was added to blacklist.

comment class-attribute instance-attribute

comment: str | None = None

Comment.

gender class-attribute instance-attribute

gender: Gender | None = None

Sex.

id instance-attribute

id: str

Customer ID.

in_blacklist class-attribute instance-attribute

in_blacklist: bool | None = None

Is client in blacklist.

name instance-attribute

name: str

Name.

surname class-attribute instance-attribute

surname: str | None = None

Last name.

RetrievedRemovalType

Bases: IikoModel

Write-off type.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

RetrievedReserveOrder

Bases: IikoModel

Order.

combos class-attribute instance-attribute

combos: list[OrderCombo] | None = None

Combo.

conception class-attribute instance-attribute

conception: RetrievedConception | None = None

Concept.

discounts class-attribute instance-attribute

discounts: list[DiscountItem] | None = None

Discounts.

external_data class-attribute instance-attribute

external_data: list[RetrievedExternalData] | None = None

Order external data.

Allowed from version 8.0.6.

guests_info class-attribute instance-attribute

guests_info: RetrievedGuestsInfo | None = None

Information about order guests.

items instance-attribute

items: list[RetrievedOrderItem]

Order items.

loyalty_info class-attribute instance-attribute

loyalty_info: RetrievedLoyaltyInfo | None = None

Information about Loyalty app.

null - only for unsupported POS versions.

menu_id class-attribute instance-attribute

menu_id: str | None = None

External menu ID.

number instance-attribute

number: int

Delivery No.

order_type class-attribute instance-attribute

order_type: RetrievedOrderType | None = None

Order type.

payments class-attribute instance-attribute

payments: list[PaymentItem] | None = None

Payments.

processed_payments_sum class-attribute instance-attribute

processed_payments_sum: Decimal | None = None

The amount of processed payments.

null - only for unsupported POS versions.

Allowed from version 7.6.0.

source_key class-attribute instance-attribute

source_key: str | None = None

Delivery source.

sum instance-attribute

sum: Decimal

Order amount (after discount or surcharge).

terminal_group_id instance-attribute

terminal_group_id: str

ID of the terminal group where the order is located.

tips class-attribute instance-attribute

tips: list[TipsPaymentItem] | None = None

Tips.

when_bill_printed class-attribute instance-attribute

when_bill_printed: IikoDateTime | None = None

Invoice printing time (guest bill time).

when_closed class-attribute instance-attribute

when_closed: IikoDateTime | None = None

Delivery closing time (Local for delivery terminal).

RetrievedTableOrder

Bases: IikoModel

Order.

combos class-attribute instance-attribute

combos: list[OrderCombo] | None = None

Combo.

conception class-attribute instance-attribute

conception: RetrievedConception | None = None

Concept.

customer class-attribute instance-attribute

customer: RetrievedRegularCustomer | None = None

Guest.

Allowed from version 7.5.2.

discounts class-attribute instance-attribute

discounts: list[DiscountItem] | None = None

Discounts.

external_data class-attribute instance-attribute

external_data: list[RetrievedExternalData] | None = None

Order external data.

Allowed from version 8.0.6.

guests_info class-attribute instance-attribute

guests_info: RetrievedGuestsInfo | None = None

Information about order guests.

items instance-attribute

items: list[RetrievedOrderItem]

Order items.

loyalty_info class-attribute instance-attribute

loyalty_info: RetrievedLoyaltyInfo | None = None

Information about Loyalty app.

null - only for unsupported POS versions.

menu_id class-attribute instance-attribute

menu_id: str | None = None

External menu ID.

number instance-attribute

number: int

Delivery No.

order_type class-attribute instance-attribute

order_type: RetrievedOrderType | None = None

Order type.

payments class-attribute instance-attribute

payments: list[PaymentItem] | None = None

Payments.

phone class-attribute instance-attribute

phone: str | None = None

Guest phone.

Allowed from version 7.5.2.

price_category class-attribute instance-attribute

price_category: PriceCategory | None = None

Price Category of the order.

Allowed from version 9.0.5.

processed_payments_sum class-attribute instance-attribute

processed_payments_sum: Decimal | None = None

The amount of processed payments.

null - only for unsupported POS versions.

Allowed from version 7.6.0.

source_key class-attribute instance-attribute

source_key: str | None = None

Delivery source.

split_order_between_cash_registers class-attribute instance-attribute

split_order_between_cash_registers: (
    SplitOrderBetweenCashRegisters | None
) = None

Need to split order between cash registers.

Not empty for orders in statuses New or Bill.

status instance-attribute

status: RetrievedOrderStatus

Order status.

sum instance-attribute

sum: Decimal

Order amount (after discount or surcharge).

tab_name class-attribute instance-attribute

tab_name: str | None = None

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

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

ID of the terminal group where the order is located.

tips class-attribute instance-attribute

tips: list[TipsPaymentItem] | None = None

Tips.

waiter class-attribute instance-attribute

waiter: RetrievedEmployee | None = None

Order waiter.

when_bill_printed class-attribute instance-attribute

when_bill_printed: IikoDateTime | None = None

Invoice printing time (guest bill time).

when_closed class-attribute instance-attribute

when_closed: IikoDateTime | None = None

Delivery closing time (Local for delivery terminal).

when_created class-attribute instance-attribute

when_created: IikoDateTime | None = None

Order creation date (terminal time zone).

RetrievedTipsType

Bases: IikoModel

The tips type.

id instance-attribute

id: str

Tips type ID.

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

name instance-attribute

name: str

Tips type name.

RmsDiscount

Bases: DiscountBase

RMS discount/surcharge.

Amount must be specified only if discount has "assign amount" setting enabled. In any other case, amount must not be specified.

discount_type_id instance-attribute

discount_type_id: str

Discount type.

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

selective_positions class-attribute instance-attribute

selective_positions: list[str] | None = None

Order item positions.

sum class-attribute instance-attribute

sum: Decimal | None = None

Discount/surcharge sum.

ServiceOrderItem

Bases: RetrievedOrderItemBase

Order item: service.

cost instance-attribute

cost: Decimal

Total cost per item without tax, discounts/surcharges.

service instance-attribute

service: RetrievedProduct

Item.

SimpleOrganizationInfo

Bases: OrganizationInfoBase

Organization details.

SplitOrderBetweenCashRegisters

Bases: OpenStrEnum

Need to split order between cash registers.

TableOrderInfo

Bases: IikoModel

Order.

creation_status instance-attribute

creation_status: CreationStatus

Order creation status. In case of asynchronous creation, it allows to track the instance an order was validated/created in iikoFront.

error_info class-attribute instance-attribute

error_info: ErrorInfo | None = None

Order creation error details. Required only if "creationStatus"="Error".

external_number class-attribute instance-attribute

external_number: str | None = None

Order external number.

id instance-attribute

id: str

Order ID.

order class-attribute instance-attribute

order: RetrievedTableOrder | None = None

Order creation details. Field is filled up if "creationStatus"="Success".

organization_id instance-attribute

organization_id: str

Organization ID.

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

pos_id class-attribute instance-attribute

pos_id: str | None = None

POS order ID.

timestamp instance-attribute

timestamp: int

Timestamp of most recent order change that took place on iikoTransport server.

TerminalGroup

Bases: IikoModel

DTO containing terminal groups details

address class-attribute instance-attribute

address: str | None = None

Deprecated. Group address. Not used.

external_data class-attribute instance-attribute

external_data: list[ExternalDataEntry] | None = None

Terminal group external data.

id instance-attribute

id: str

Delivery group ID.

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

name instance-attribute

name: str

Terminal group name.

organization_id instance-attribute

organization_id: str

Organization ID to which delivery group belongs.

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

pos_version class-attribute instance-attribute

pos_version: str | None = None

Version of the iikoFront.

time_zone instance-attribute

time_zone: str

Terminal group time zone.

TerminalGroupsResponse

Bases: IikoModel

DTO containing terminal groups details.

correlation_id instance-attribute

correlation_id: str

Operation ID.

terminal_groups instance-attribute

terminal_groups: list[OrganizationItems[TerminalGroup]]

List of terminal groups broken down by organizations.

terminal_groups_in_sleep instance-attribute

terminal_groups_in_sleep: list[
    OrganizationItems[TerminalGroup]
]

Terminal groups are in sleep mode because they are not active.

Can be awakened by /api/1/terminal_groups/awake operation.

TipsPaymentBase

Bases: IikoModel

Base class of delivery order payment item.

is_fiscalized_externally class-attribute instance-attribute

is_fiscalized_externally: bool | None = None

Whether the payment item is externally fiscalized.

Allowed from version 7.6.3.

is_prepay class-attribute instance-attribute

is_prepay: bool | None = None

Deprecated. Whether the payment item is prepay. Unavailable for paymentKindType.LoyaltyCard.

Allowed from version 8.2.6.

is_processed_externally class-attribute instance-attribute

is_processed_externally: bool | None = None

Whether payment item is processed by external payment system (made from outside).

payment_additional_data class-attribute instance-attribute

payment_additional_data: PaymentAdditionalData | None = None

Additional payment parameters.

payment_type_id instance-attribute

payment_type_id: str

Payment type.

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

sum instance-attribute

sum: Decimal

Amount due.

tips_type_id class-attribute instance-attribute

tips_type_id: str | None = None

Tips type ID.

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

TipsPaymentItem

Bases: IikoModel

Delivery order tips payment component.

is_external instance-attribute

is_external: bool

Payment item is external (created via biz.API).

is_fiscalized_externally class-attribute instance-attribute

is_fiscalized_externally: bool | None = None

Whether the payment item is externally fiscalized.

Allowed from version 7.6.3.

is_preliminary instance-attribute

is_preliminary: bool

Whether payment item is preliminary.

is_prepay instance-attribute

is_prepay: bool

Whether the payment item is prepay.

Allowed from version 7.7.6.

is_processed_externally instance-attribute

is_processed_externally: bool

Payment item is processed by external payment system.

payment_type instance-attribute

payment_type: DeliveriesResponseOrderPaymentType

Payment type.

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

sum instance-attribute

sum: Decimal

Amount due.

tips_type class-attribute instance-attribute

tips_type: RetrievedTipsType | None = None

Tips type.

WarningInfo

Bases: IikoModel

Warning info.

code class-attribute instance-attribute

code: str | None = Field(default=None, alias='Code')

Code of an error. Can be null.

error_code class-attribute instance-attribute

error_code: str | None = Field(
    default=None, alias="ErrorCode"
)

Error code. Can be null.

message class-attribute instance-attribute

message: str | None = Field(default=None, alias='Message')

Description of an error. Can be null.