General models

Models of the general endpoints: organizations, terminal groups, dictionaries, menu, notifications...

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

GetCommandStatusResponse module-attribute

GetCommandStatusResponse = Annotated[
    Annotated[InProgressCommandStatus, Tag("InProgress")]
    | Annotated[SuccessCommandStatus, Tag("Success")]
    | Annotated[ErrorCommandStatus, Tag("Error")]
    | Annotated[GetCommandStatusResponseBase, Tag(UNKNOWN)],
    discriminator(
        "state", "state", ("InProgress", "Success", "Error")
    ),
]

Class containing information about command status.

One of InProgressCommandStatus, SuccessCommandStatus, ErrorCommandStatus, selected by state. Values unknown to this library are parsed as GetCommandStatusResponseBase.

SendNotificationRequest module-attribute

SendNotificationRequest = Annotated[
    Annotated[
        OrderAttentionNotificationRequest,
        Tag("order_attention"),
    ]
    | Annotated[SendNotificationRequestBase, Tag(UNKNOWN)],
    discriminator(
        "messageType", "message_type", ("order_attention",)
    ),
]

Request to notify external systems (iikoFront and iikoWeb).

One of OrderAttentionNotificationRequest, selected by message_type. Values unknown to this library are parsed as SendNotificationRequestBase.

ActiveCourierLocation

Bases: IikoModel

Courier's location.

courier_id class-attribute instance-attribute

courier_id: str | None = None

Employee ID.

last_active_client_date class-attribute instance-attribute

last_active_client_date: IikoDateTime | None = None

Client date and time.

last_active_latitude class-attribute instance-attribute

last_active_latitude: Decimal | None = None

Latitude.

last_active_longitude class-attribute instance-attribute

last_active_longitude: Decimal | None = None

Longitude.

ActiveCourierLocationsByTerminalGroupRequest

Bases: IikoModel

Request for list of active drivers for front group with ID = TerminalGroupId.

organization_id instance-attribute

organization_id: str

Organization ID.

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

terminal_group_id instance-attribute

terminal_group_id: str

iikoFront terminals group ID.

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

ActiveCourierLocationsResponse

Bases: IikoModel

Wrapping object to retrieve list of active courier locations.

active_courier_locations instance-attribute

active_courier_locations: list[
    OrganizationItems[ActiveCourierLocation]
]

List of courier's locations.

correlation_id instance-attribute

correlation_id: str

Operation ID.

AddProductsToStopListItem

Bases: IikoModel

Item for add to out-of-stock list.

balance instance-attribute

balance: Decimal

Product balance.

product_id instance-attribute

product_id: str

Out-of-stock list product ID.

size_id class-attribute instance-attribute

size_id: str | None = None

Out-of-stock list product size ID.

AddProductsToStopListRequest

Bases: IikoModel

Request for add items to out-of-stock list.

items instance-attribute

items: list[AddProductsToStopListItem]

Items for adding to out-of-stock list.

organization_id instance-attribute

organization_id: str

Organization ID.

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

terminal_group_id instance-attribute

terminal_group_id: str

Terminal group ID.

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

AwakeTerminalGroupsRequest

Bases: IikoModel

Request to awake terminal groups from sleep mode.

organization_ids instance-attribute

organization_ids: list[str]

Organization IDs.

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

terminal_group_ids instance-attribute

terminal_group_ids: list[str]

List of terminal groups IDs.

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

AwakeTerminalGroupsResponse

Bases: IikoModel

Response for request to awake terminal groups from sleep mode.

failed_processed class-attribute instance-attribute

failed_processed: list[str] | None = None

Identifiers of terminal groups whose processing failed.

successfully_processed class-attribute instance-attribute

successfully_processed: list[str] | None = None

Identifiers of successfully processed terminal groups.

BarcodeInfo

Bases: IikoModel

Barcode.

barcode instance-attribute

barcode: str

Barcode.

container class-attribute instance-attribute

container: str | None = None

Container.

product_fiscal_code class-attribute instance-attribute

product_fiscal_code: str | None = None

Product fiscal code.

CalculateComboPriceRequest

Bases: IikoModel

Calculate combo price request.

items instance-attribute

items: list[OrderItem]

Items with modifiers included in combo.

organization_id instance-attribute

organization_id: str

Organization id.

CalculateComboPriceResponse

Bases: IikoModel

Calculate combo price response.

incorrectly_filled_groups class-attribute instance-attribute

incorrectly_filled_groups: list[str] | None = None

Ids of incorrectly filled groups. If not empty - price will be 0.

price class-attribute instance-attribute

price: Decimal | None = None

Calculated price of combo item.

CancelCause

Bases: IikoModel

Delivery cancel cause.

id instance-attribute

id: str

Identifier.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Is deleted sign.

name instance-attribute

name: str

Name.

CancelCausesRequest

Bases: IikoModel

Request for organization's delivery cancel causes.

organization_ids instance-attribute

organization_ids: list[str]

Organizations ids which delivery cancel causes needs to be returned.

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

CancelCausesResponse

Bases: IikoModel

Response with delivery cancel causes (reasons for deletion) list.

cancel_causes instance-attribute

cancel_causes: list[CancelCause]

List of delivery cancel causes.

correlation_id instance-attribute

correlation_id: str

Operation ID.

ChangePersonalSessionResponse

Bases: IikoModel

Personal session change response.

correlation_id instance-attribute

correlation_id: str

Operation ID.

error class-attribute instance-attribute

error: str | None = None

Error details.

CheckStopListRequest

Bases: IikoModel

Request for check items in out-of-stock list.

items instance-attribute

items: list[OrderItem]

Order items.

organization_id instance-attribute

organization_id: str

Organization ID.

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

terminal_group_id instance-attribute

terminal_group_id: str

Front group ID the order must be sent to.

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

CheckStopListResponse

Bases: IikoModel

Response for check items in out-of-stock list.

correlation_id instance-attribute

correlation_id: str

Operation ID.

rejected_items class-attribute instance-attribute

rejected_items: list[StopListItem] | None = None

Set of items in out-of-stock list.

If null, none of requested items are in out-of-stock list. Present in response only if not null.

ChildModifierInfo

Bases: IikoModel

Child modifier details.

default_amount class-attribute instance-attribute

default_amount: int | None = None

Default quantity.

free_of_charge_amount class-attribute instance-attribute

free_of_charge_amount: int | None = None

Free of charge amount. This field is supported since 7.2.4 iikoRMS version.

hide_if_default_amount class-attribute instance-attribute

hide_if_default_amount: bool | None = None

Hide if default amount applied. This field is supported since 7.2.4 iikoRMS version.

id instance-attribute

id: str

ID.

max_amount instance-attribute

max_amount: int

Maximum quantity.

min_amount instance-attribute

min_amount: int

Minimum quantity.

required class-attribute instance-attribute

required: bool | None = None

Required availability.

splittable class-attribute instance-attribute

splittable: bool | None = None

Modifier can be split. This field is supported since 7.2.4 iikoRMS version.

ClearStopListRequest

Bases: IikoModel

Request to clear out-of-stock list.

organization_id instance-attribute

organization_id: str

Organization ID.

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

terminal_group_id instance-attribute

terminal_group_id: str

Terminal group ID.

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

ClosePersonalSessionRequest

Bases: IikoModel

Close personal session request.

employee_id instance-attribute

employee_id: str

Employee ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

terminal_group_id instance-attribute

terminal_group_id: str

Delivery group ID.

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

ComboCategory

Bases: IikoModel

Information about combos of organization.

id class-attribute instance-attribute

id: str | None = None

Category id.

name class-attribute instance-attribute

name: str | None = None

Category name.

ComboComponentGroup

Bases: IikoModel

Combo meal component group (e.g. "Burger", "Drink", "Fries"). Stored inline with original UUIDs for compatibility with external systems.

id instance-attribute

id: str

Unique group ID (original UUID).

is_main_group class-attribute instance-attribute

is_main_group: bool | None = None

Whether the group is the main one (primary combo product). The main group usually determines the combo name.

name instance-attribute

name: str

Group name (e.g. "Drink").

products class-attribute instance-attribute

products: list[ComboComponentProduct] | None = None

List of products available for selection in this group. Contains combo-specific prices (different from retail prices).

skip_step class-attribute instance-attribute

skip_step: bool | None = None

Skip selection step in UI (auto-select the only/default product). Used for mandatory components without choice.

ComboComponentProduct

Bases: IikoModel

Product available for selection in a combo meal component group.

forbidden_modifiers class-attribute instance-attribute

forbidden_modifiers: list[str] | None = None

List of modifier IDs that cannot be applied to this product in a combo.

price_modification_amount class-attribute instance-attribute

price_modification_amount: Decimal | None = None

Extra charge or discount for this product within the combo (in rubles). Positive = extra charge, negative = discount. Depends on PriceStrategy: always 0 for BY_COMPONENT.

product_id instance-attribute

product_id: str

Reference to a product from the Menu.products[] catalog.

size_prices class-attribute instance-attribute

size_prices: list[ComboSizePrice] | None = None

Product prices in combo for different sizes. If absent or empty — the product is not available for sale in the combo. CRITICAL: prices differ from retail by 8-39%.

ComboGroup

Bases: IikoModel

Information about combos group.

id class-attribute instance-attribute

id: str | None = None

Id.

is_main_group class-attribute instance-attribute

is_main_group: bool | None = None

Is main group.

name class-attribute instance-attribute

name: str | None = None

Name.

products class-attribute instance-attribute

products: list[ComboProduct] | None = None

Products.

skip_step class-attribute instance-attribute

skip_step: bool | None = None

Skip step.

ComboPriceModificationType

Bases: OpenIntEnum

ComboPriceModificationType values.

CHEAPEST_POSITION_DISCOUNT class-attribute instance-attribute

CHEAPEST_POSITION_DISCOUNT = 2

Cheapest position discount.

FIXED_COMBO_PRICE class-attribute instance-attribute

FIXED_COMBO_PRICE = 0

Fixed combo price.

FIXED_POSITION_PRICE class-attribute instance-attribute

FIXED_POSITION_PRICE = 1

Fixed position price.

MOST_EXPENSIVE_POSITION_DISCOUNT class-attribute instance-attribute

MOST_EXPENSIVE_POSITION_DISCOUNT = 3

Most expensive position discount.

PERCENTAGE_DISCOUNT_FOR_EACH_POSITION class-attribute instance-attribute

PERCENTAGE_DISCOUNT_FOR_EACH_POSITION = 4

Percentage discount for each position.

ComboProduct

Bases: IikoModel

Combo product.

forbidden_modifiers class-attribute instance-attribute

forbidden_modifiers: list[str] | None = None

Forbidden modifiers.

position class-attribute instance-attribute

position: int | None = None

Position.

price_modification_amount class-attribute instance-attribute

price_modification_amount: Decimal | None = None

Price modification amount.

product_id class-attribute instance-attribute

product_id: str | None = None

Product id.

size_id class-attribute instance-attribute

size_id: str | None = None

Size id.

size_name class-attribute instance-attribute

size_name: str | None = None

Size name. Can be null.

ComboSize

Bases: IikoModel

Combo size with visualization info. Used in Item.sizes[] for COMBO elements. Contains data specific to placement in a group.

button_image_url class-attribute instance-attribute

button_image_url: str | None = None

Deprecated. Button image URL.

image class-attribute instance-attribute

image: Image | None = None

Combo size image (placement-specific). Replaces ButtonImageUrl.

is_hidden class-attribute instance-attribute

is_hidden: bool | None = None

Whether this size is hidden.

name instance-attribute

name: str

Size name. IMPORTANT: may be an empty string "" — this is a valid value.

short_name class-attribute instance-attribute

short_name: str | None = None

Short name (e.g. "L").

size_id instance-attribute

size_id: str

Combo size ID. Corresponds to product size IDs (Product.sizePrices[].sizeId).

ComboSizePrice

Bases: IikoModel

Product price within a combo meal for a specific size combination.

combo_size_id instance-attribute

combo_size_id: str

Combo size ID (from ComboSize.sizeId).

price class-attribute instance-attribute

price: Decimal | None = None

Product price in combo for this size combination. Can be null — the product/size is not available for sale. Can be 0 — the component is included in the combo at no extra charge. This is NOT a retail price (8-39% lower).

product_size_id class-attribute instance-attribute

product_size_id: str | None = None

Product size ID (from Product.sizePrices[].sizeId). Can be null for products without a size.

ComboSpecification

Bases: IikoModel

Information about combos of organization.

category_id class-attribute instance-attribute

category_id: str | None = None

Combo's category id.

expiration_date class-attribute instance-attribute

expiration_date: IikoDateTime | None = None

Expiration date.

groups class-attribute instance-attribute

groups: list[ComboGroup] | None = None

Groups.

include_modifiers class-attribute instance-attribute

include_modifiers: bool | None = None

Include modifiers.

is_active class-attribute instance-attribute

is_active: bool | None = None

Is active.

lacking_groups_to_suggest class-attribute instance-attribute

lacking_groups_to_suggest: int | None = None

Lacking groups to suggest.

name class-attribute instance-attribute

name: str | None = None

Name. Can be null.

price_modification class-attribute instance-attribute

price_modification: Decimal | None = None

Price modification.

price_modification_type class-attribute instance-attribute

price_modification_type: (
    ComboPriceModificationType | None
) = None

Price modification type.

0 - fixed combo price, 1 - fixed position price, 2 - cheapest position discount, 3 - most expensive position discount, 4 - percentage discount for each position.

sort_order class-attribute instance-attribute

sort_order: int | None = None

Sort order.

source_action_id class-attribute instance-attribute

source_action_id: str | None = None

Id of action that added the combo.

start_date class-attribute instance-attribute

start_date: IikoDateTime | None = None

Start date.

CoordinateInfo

Bases: IikoModel

DTO of map coordinates.

latitude instance-attribute

latitude: Decimal

Latitude.

longitude instance-attribute

longitude: Decimal

Longitude.

server_timestamp instance-attribute

server_timestamp: int

Time of coordinate saving on server in the Unix timestamp format.

CourierLocations

Bases: IikoModel

Driver location details.

courier_id instance-attribute

courier_id: str

Driver ID.

locations instance-attribute

locations: list[CoordinateInfo]

List of locations.

CourierLocationsByTimeOffsetRequest

Bases: IikoModel

Request for coordinates history of drivers in OrganizationIds organizations. If driver coordinates were recorded in server storage within interval: ["current server time" - OffsetInSeconds, "current server time"), driver and their coordinates will be retrieved.

offset_in_seconds class-attribute instance-attribute

offset_in_seconds: int | None = None

Interval in seconds from current server time. If driver coordinates were recorded in server storage within interval: ("current server time" - OffsetInSeconds, "current server time"], driver and their coordinates will be retrieved.

organization_ids instance-attribute

organization_ids: list[str]

List of organizations for drivers coordinates of which will be retrieved.

CourierLocationsByTimeOffsetResponse

Bases: IikoModel

DTO containing driver coordinates details for the last N seconds.

correlation_id instance-attribute

correlation_id: str

Operation ID.

courier_locations instance-attribute

courier_locations: list[OrganizationItems[CourierLocations]]

List of drivers' coordinates broken down by organizations.

CouriersAndCheckRoleRequest

Bases: IikoModel

Request for list of drivers for organizations in OrganizationIds.

organization_ids instance-attribute

organization_ids: list[str]

List of organizations.

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

roles_to_check instance-attribute

roles_to_check: list[str]

Employee's roles for check. The short name of employee's position.

CouriersRequest

Bases: IikoModel

Request for list of drivers for organizations in OrganizationIds.

organization_ids instance-attribute

organization_ids: list[str]

List of organizations.

CustomerTagGroup

Bases: IikoModel

Customer tag group.

id instance-attribute

id: str

Tag group ID.

items class-attribute instance-attribute

items: list[TagItem] | None = None

List of tags.

name instance-attribute

name: str

Tag group name.

select_several_tags class-attribute instance-attribute

select_several_tags: bool | None = None

Flag indicating whether multiple tags can be selected.

CustomerTagGroupItem

Bases: IikoModel

Represents a set of selected tags for a specific customer tag group.

customer_tag_group_id instance-attribute

customer_tag_group_id: str

Customer tag group ID.

selected_tag_ids instance-attribute

selected_tag_ids: list[str]

Set of selected tag IDs within the group.

DiscountCardMode

Bases: OpenStrEnum

Discount type.

DiscountCardTypeInfo

Bases: IikoModel

Discount/surcharge DTO.

can_apply_by_card_number instance-attribute

can_apply_by_card_number: bool

Can be applied by card No. If true, it's enough to enter discount card No. (card swiping not required)

can_be_applied_selectively instance-attribute

can_be_applied_selectively: bool

Whether discount allows for selected application to individual items at user's discretion.

comment class-attribute instance-attribute

comment: str | None = None

Comment.

id instance-attribute

id: str

Discount ID in RMS.

is_automatic instance-attribute

is_automatic: bool

Created automatically.

is_card instance-attribute

is_card: bool

Executed by card.

is_categorised_discount instance-attribute

is_categorised_discount: bool

Whether it is category discount or not. If true, "productCategoryDiscounts" discounts will apply.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

IsDeleted.

is_manual instance-attribute

is_manual: bool

Created manually.

min_order_sum class-attribute instance-attribute

min_order_sum: Decimal | None = None

Minimum order amount required for discount application. If order amount is less than specified threshold, discount does not apply.

mode instance-attribute

mode: DiscountCardMode

Discount type.

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

name class-attribute instance-attribute

name: str | None = None

Discount name.

percent instance-attribute

percent: Decimal

Total discount rate. Ignored if "isCategorisedDiscount" specified.

product_category_discounts instance-attribute

product_category_discounts: list[ProductCategoryDiscount]

Category discount.

sum instance-attribute

sum: Decimal

Fixed amount. Triggers if fixed amount has been specified.

DiscountsRequest

Bases: IikoModel

Request of discounts/surcharges.

organization_ids instance-attribute

organization_ids: list[str]

Organization IDs that require discounts return.

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

DiscountsResponse

Bases: IikoModel

Response with list of discounts/surcharges.

correlation_id instance-attribute

correlation_id: str

Operation ID.

discounts instance-attribute

discounts: list[OrganizationItems[DiscountCardTypeInfo]]

List of discounts/surcharges.

Employee

Bases: IikoModel

Employee DTO.

code class-attribute instance-attribute

code: str | None = None

Code.

display_name class-attribute instance-attribute

display_name: str | None = None

Displayed name (system name).

first_name class-attribute instance-attribute

first_name: str | None = None

Name of user.

id instance-attribute

id: str

Employee ID.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

User deletion flag.

last_name class-attribute instance-attribute

last_name: str | None = None

Last name.

middle_name class-attribute instance-attribute

middle_name: str | None = None

Second name.

EmployeeInfo

Bases: IikoModel

Employee info.

cell_phone class-attribute instance-attribute

cell_phone: str | None = None

Cell phone.

display_name class-attribute instance-attribute

display_name: str | None = None

Display name.

email class-attribute instance-attribute

email: str | None = None

Email.

first_name class-attribute instance-attribute

first_name: str | None = None

Name of employee.

id instance-attribute

id: str

Employee ID.

last_name class-attribute instance-attribute

last_name: str | None = None

Last name.

middle_name class-attribute instance-attribute

middle_name: str | None = None

Second name.

phone class-attribute instance-attribute

phone: str | None = None

Phone.

EmployeeInfoRequest

Bases: IikoModel

Request for employee info.

id instance-attribute

id: str

Employee ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

EmployeeInfoResponse

Bases: IikoModel

Response for employee info.

correlation_id instance-attribute

correlation_id: str

Operation ID.

employee_info instance-attribute

employee_info: EmployeeInfo

Employee info.

EmployeeWithCheckedRole

Bases: IikoModel

Employee DTO.

check_roles_result class-attribute instance-attribute

check_roles_result: list[RoleCheckResult] | None = None

Result of check employee's roles.

code class-attribute instance-attribute

code: str | None = None

Code.

display_name class-attribute instance-attribute

display_name: str | None = None

Displayed name (system name).

first_name class-attribute instance-attribute

first_name: str | None = None

Name of user.

id instance-attribute

id: str

Employee ID.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

User deletion flag.

last_name class-attribute instance-attribute

last_name: str | None = None

Last name.

middle_name class-attribute instance-attribute

middle_name: str | None = None

Second name.

EmployeesResponse

Bases: IikoModel

Wrapping object to retrieve list of drivers from iikoRMS.

correlation_id instance-attribute

correlation_id: str

Operation ID.

employees instance-attribute

employees: list[OrganizationItems[Employee]]

List of drivers.

EmployeesWithRoleSignResponse

Bases: IikoModel

Wrapping object to retrieve list of drivers from iikoRMS with checked role.

correlation_id instance-attribute

correlation_id: str

Operation ID.

employees_with_check_roles instance-attribute

employees_with_check_roles: list[
    OrganizationItems[EmployeeWithCheckedRole]
]

List of drivers.

ErrorCommandStatus

Bases: GetCommandStatusResponseBase

Command completed with error.

error_reason class-attribute instance-attribute

error_reason: str | None = None

Error reason.

exception class-attribute instance-attribute

exception: Any | None = None

Occured exception details.

ExternalMenu

Bases: IikoModel

External menu, related to ApiLogin.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

GetAccessTokenV2Request

Bases: IikoModel

Authentication token request.

api_key instance-attribute

api_key: str

API key generated in iikoWeb under "Integrations → API Keys". The key determines which restaurant organizations the token grants access to.

app_id instance-attribute

app_id: str

Unique application identifier issued by the iiko Developer Portal (https://public-api.iikoweb.ru/portal). You receive it when you register a new application in your developer account. The appId never changes for the lifetime of the application.

client_secret instance-attribute

client_secret: str

Application secret key issued by the iiko Developer Portal (https://public-api.iikoweb.ru/portal). The secret is shown only once — right after the application is created. Store it securely. If the secret is lost or compromised, regenerate it in the Developer Portal; the previous secret will be revoked immediately.

GetAccessTokenV2Response

Bases: IikoModel

Response to authentication token request.

correlation_id instance-attribute

correlation_id: str

Unique request identifier for tracing and support purposes. Include this value when contacting support about a specific request.

token instance-attribute

token: str

JWT session token. Pass it in the Authorization header as Bearer {token} in every subsequent API call. The token is valid for 1 hour (see the exp claim in the decoded JWT). When the token expires, call this method again to obtain a new one.

GetCombosInfoRequest

Bases: IikoModel

Get combos info request.

extra_data class-attribute instance-attribute

extra_data: bool | None = None

Extra data.

organization_id instance-attribute

organization_id: str

Organization id.

GetCombosInfoResponse

Bases: IikoModel

Information about combos of organization.

combo_categories class-attribute instance-attribute

combo_categories: list[ComboCategory] | None = None

Combo's categories.

combo_specifications class-attribute instance-attribute

combo_specifications: list[ComboSpecification] | None = None

Full combo's specifications.

warnings class-attribute instance-attribute

warnings: list[WarningInfo] | None = Field(
    default=None, alias="Warnings"
)

Warnings about errors, not blocking loyalty calculation.

GetCommandStatusRequest

Bases: IikoModel

Request for command status obtaining.

correlation_id instance-attribute

correlation_id: str

Operation ID obtained from any command supporting operations.

organization_id instance-attribute

organization_id: str

Organization id which "correlationId" belongs to.

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

GetCommandStatusResponseBase

Bases: IikoModel

Class containing information about command status.

GetPersonalSessionInfoRequest

Bases: IikoModel

Personal session request.

employee_id instance-attribute

employee_id: str

Employee ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

terminal_group_id instance-attribute

terminal_group_id: str

Delivery group ID.

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

GetPersonalSessionInfoResponse

Bases: IikoModel

Personal session info response.

correlation_id instance-attribute

correlation_id: str

Operation ID.

error class-attribute instance-attribute

error: str | None = None

Error details.

is_session_opened class-attribute instance-attribute

is_session_opened: bool | None = None

Is personal session opened.

GetTerminalGroupsOfEmployeeRequest

Bases: IikoModel

GetTerminalGroupsOfEmployeeRequest.

GetTerminalGroupsOfEmployeeResponse

Bases: IikoModel

GetTerminalGroupsOfEmployeeResponse.

GroupModifierInfo

Bases: IikoModel

Information on group of modifiers.

child_modifiers instance-attribute

child_modifiers: list[ChildModifierInfo]

List of child modifiers.

child_modifiers_have_min_max_restrictions class-attribute instance-attribute

child_modifiers_have_min_max_restrictions: bool | None = (
    None
)

Presence of max/min quantity limitations of child modifiers.

default_amount class-attribute instance-attribute

default_amount: int | None = None

Amount by default. This field is supported since 7.2.4 iikoRMS version.

free_of_charge_amount class-attribute instance-attribute

free_of_charge_amount: int | None = None

Free amount. This field is supported since 7.2.4 iikoRMS version.

hide_if_default_amount class-attribute instance-attribute

hide_if_default_amount: bool | None = None

Hide if the amount is by default. This field is supported since 7.2.4 iikoRMS version.

id instance-attribute

id: str

ID.

max_amount instance-attribute

max_amount: int

Maximum quantity.

min_amount instance-attribute

min_amount: int

Minimum quantity.

required class-attribute instance-attribute

required: bool | None = None

Required availability.

splittable class-attribute instance-attribute

splittable: bool | None = None

Modifier can be split. This field is supported since 7.2.4 iikoRMS version.

Image

Bases: IikoModel

Unified image object. Replaces the deprecated buttonImageUrl field across all entities.

hash class-attribute instance-attribute

hash: str | None = None

SHA-1 hash of the image file bytes. Used for detecting changes without re-downloading.

updated_at class-attribute instance-attribute

updated_at: IikoDateTime | None = None

Date and time of the last image update (UTC).

url instance-attribute

url: str

Public URL of the image in the file storage.

InProgressCommandStatus

Bases: GetCommandStatusResponseBase

Command is in progress.

Item

Bases: IikoModel

Item in a group.

allergen_group_ids class-attribute instance-attribute

allergen_group_ids: list[str] | None = None

Allergen group IDs.

combo_id class-attribute instance-attribute

combo_id: str | None = None

Combo meal ID (from the Menu.combos[] array). REQUIRED for combo meals (itemType = "COMBO"). NULL for regular products.

description class-attribute instance-attribute

description: str | None = None

Item description.

is_hidden class-attribute instance-attribute

is_hidden: bool | None = None

Flag indicating whether the item is hidden.

item_type class-attribute instance-attribute

item_type: str | None = None

Item type: "PRODUCT" (default), "COMBO". If not set (null), treated as PRODUCT for backward compatibility with the old menu schema.

labels class-attribute instance-attribute

labels: list[str] | None = None

List of website tags associated with the item.

menu_item_id class-attribute instance-attribute

menu_item_id: str | None = None

Unique key of the menu item.

modifier_groups class-attribute instance-attribute

modifier_groups: list[ModifierGroup] | None = None

Modifier groups.

name instance-attribute

name: str

Item name.

product_id class-attribute instance-attribute

product_id: str | None = None

Product ID. REQUIRED for regular products (itemType = null or "PRODUCT"). NULL for combo meals (itemType = "COMBO").

size_prices class-attribute instance-attribute

size_prices: list[MenuSizePrice] | None = None

Prices by size.

sizes class-attribute instance-attribute

sizes: list[ComboSize] | None = None

Combo sizes with visual information (images, visibility). Used only when itemType = "COMBO". Ignored for PRODUCT (sizePrices[] is used instead). Contains information specific to placement in a group.

sort_order class-attribute instance-attribute

sort_order: Decimal | None = None

Sort order of the item in a group (starting from 0). Optional — for explicit sorting in the UI.

tags class-attribute instance-attribute

tags: list[str] | None = None

List of internal tags associated with the item.

ItemsGroup

Bases: IikoModel

Item group.

button_image_url class-attribute instance-attribute

button_image_url: str | None = None

Deprecated. Button image URL.

description class-attribute instance-attribute

description: str | None = None

Group description.

id instance-attribute

id: str

Group ID.

image class-attribute instance-attribute

image: Image | None = None

Group image. Replaces ButtonImageUrl.

is_hidden class-attribute instance-attribute

is_hidden: bool | None = None

Flag indicating whether the group is hidden.

items class-attribute instance-attribute

items: list[Item] | None = None

List of items in the group.

labels class-attribute instance-attribute

labels: list[str] | None = None

List of website tags associated with the element.

name instance-attribute

name: str

Group name.

schedule_id class-attribute instance-attribute

schedule_id: str | None = None

Schedule ID.

tags class-attribute instance-attribute

tags: list[str] | None = None

List of internal tags associated with the element.

MeasureUnitType

Bases: OpenStrEnum

Unit of measurement.

MenuAllergenGroup

Bases: IikoModel

Allergen group.

code instance-attribute

code: str

Allergen group code.

id instance-attribute

id: str

Allergen group ID.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Flag indicating whether the group is deleted.

name instance-attribute

name: str

Allergen group name.

MenuCombo

Bases: IikoModel

Combo meal. Consists of component groups, each group offers a choice of products.

component_groups class-attribute instance-attribute

component_groups: list[ComboComponentGroup] | None = None

Combo component groups (Burger, Drink, Fries, etc.).

id instance-attribute

id: str

Unique combo ID. Unique within the combos[] array — each combo appears only once.

labels class-attribute instance-attribute

labels: list[str] | None = None

List of website tags.

price_strategy class-attribute instance-attribute

price_strategy: PriceStrategy | None = None

Pricing strategy. BY_COMPONENT (default): price is composed from selected components. FIXED: fixed combo price.

sku instance-attribute

sku: str

Combo SKU.

tags class-attribute instance-attribute

tags: list[str] | None = None

List of internal tags.

MenuModifier

Bases: IikoModel

Menu modifier.

allergen_group_ids class-attribute instance-attribute

allergen_group_ids: list[str] | None = None

Allergen group IDs.

barcodes class-attribute instance-attribute

barcodes: list[BarcodeInfo] | None = None

Barcodes.

button_image_url class-attribute instance-attribute

button_image_url: str | None = None

Button image URL.

customer_tag_groups class-attribute instance-attribute

customer_tag_groups: list[CustomerTagGroupItem] | None = (
    None
)

Customer tag groups.

description class-attribute instance-attribute

description: str | None = None

Description.

id instance-attribute

id: str

Modifier ID.

image class-attribute instance-attribute

image: Image | None = None

Modifier image. Replaces ButtonImageUrl. May be overridden by iikoTransport.PublicApi.Contracts.NomenclatureV3.ModifierItem.Image.

independent_quantity class-attribute instance-attribute

independent_quantity: bool | None = None

Independent quantity.

is_hidden class-attribute instance-attribute

is_hidden: bool | None = None

Flag indicating whether the modifier is hidden. May be overridden by iikoTransport.PublicApi.Contracts.NomenclatureV3.ModifierItem.IsHidden.

is_marked class-attribute instance-attribute

is_marked: bool | None = None

Flag indicating whether the product is marked.

labels class-attribute instance-attribute

labels: list[str] | None = None

List of website tags associated with the element. May be empty or absent.

measure_unit_type class-attribute instance-attribute

measure_unit_type: MeasureUnitType | None = None

Unit of measurement. May be overridden by iikoTransport.PublicApi.Contracts.NomenclatureV3.ModifierItem.MeasureUnitType.

name class-attribute instance-attribute

name: str | None = None

Modifier name. May be overridden by iikoTransport.PublicApi.Contracts.NomenclatureV3.ModifierItem.Name.

nutritions class-attribute instance-attribute

nutritions: Nutritions | None = None

Nutritional value.

outer_ean_code class-attribute instance-attribute

outer_ean_code: str | None = None

External EAN code.

payment_subject_code class-attribute instance-attribute

payment_subject_code: str | None = None

Payment subject code.

product_category_id class-attribute instance-attribute

product_category_id: str | None = None

Product category ID.

restrictions class-attribute instance-attribute

restrictions: Restrictions | None = None

Modifier selection restrictions. May be overridden by iikoTransport.PublicApi.Contracts.NomenclatureV3.ModifierItem.Restrictions.

size_prices class-attribute instance-attribute

size_prices: list[SizePriceShort] | None = None

Prices by size.

sku instance-attribute

sku: str

SKU.

tags class-attribute instance-attribute

tags: list[str] | None = None

List of tags associated with the element. May be empty or absent.

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

Tax category ID.

weight class-attribute instance-attribute

weight: Decimal | None = None

Weight. May be overridden by iikoTransport.PublicApi.Contracts.NomenclatureV3.ModifierItem.Weight.

MenuOrderItemType

Bases: OpenStrEnum

Order item type.

MenuRequestV3

Bases: IikoModel

Request for menu by id.

external_menu_id instance-attribute

external_menu_id: str

External menu id

Can be obtained by api/2/menu operation.

organization_id instance-attribute

organization_id: str

Organization ID.

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

price_category_id class-attribute instance-attribute

price_category_id: str | None = None

Price category id.

Can be obtained by api/2/menu operation.

MenuSizePrice

Bases: IikoModel

Size price.

button_image_url class-attribute instance-attribute

button_image_url: str | None = None

Deprecated. Button image URL.

image class-attribute instance-attribute

image: Image | None = None

Product size image. Replaces ButtonImageUrl.

is_default class-attribute instance-attribute

is_default: bool | None = None

Flag indicating whether this is the default size.

is_hidden class-attribute instance-attribute

is_hidden: bool | None = None

Flag indicating whether the size is hidden.

measure_unit_type class-attribute instance-attribute

measure_unit_type: MeasureUnitType | None = None

Unit of measurement.

menu_item_size_id class-attribute instance-attribute

menu_item_size_id: str | None = None

Unique key of the size. Unlike SizeId, present even for non-sized items.

nutritions class-attribute instance-attribute

nutritions: Nutritions | None = None

Nutritional value.

price class-attribute instance-attribute

price: Decimal | None = None

Price.

size_code class-attribute instance-attribute

size_code: str | None = None

Size code.

size_id class-attribute instance-attribute

size_id: str | None = None

Size ID.

size_name class-attribute instance-attribute

size_name: str | None = None

Size name.

sku class-attribute instance-attribute

sku: str | None = None

Predefined size SKU.

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

Tax category ID.

weight class-attribute instance-attribute

weight: Decimal | None = None

Weight.

MenuTaxCategory

Bases: IikoModel

Tax category.

id instance-attribute

id: str

Tax category ID.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Flag indicating whether the category is deleted.

name instance-attribute

name: str

Tax category name.

percentage instance-attribute

percentage: Decimal

Tax percentage.

MenuV3

Bases: IikoModel

Menu structure.

allergen_groups class-attribute instance-attribute

allergen_groups: list[MenuAllergenGroup] | None = None

Allergen groups.

button_image_url class-attribute instance-attribute

button_image_url: str | None = None

Deprecated. Button image URL.

combos class-attribute instance-attribute

combos: list[MenuCombo] | None = None

Combo meals.

customer_tag_groups class-attribute instance-attribute

customer_tag_groups: list[CustomerTagGroup] | None = None

Customer tag groups.

description class-attribute instance-attribute

description: str | None = None

Menu description.

id instance-attribute

id: str

Menu ID.

image class-attribute instance-attribute

image: Image | None = None

Menu image. Replaces ButtonImageUrl.

items_groups class-attribute instance-attribute

items_groups: list[ItemsGroup] | None = None

Item groups. Placed after the reference dictionaries (products, modifiers, etc.) so that dictionaries are deserialized first.

modifiers class-attribute instance-attribute

modifiers: list[MenuModifier] | None = None

Modifiers.

name instance-attribute

name: str

Menu name.

override_tax_categories class-attribute instance-attribute

override_tax_categories: (
    list[TaxCategoryOverride] | None
) = None

Tax category overrides of the organization.

product_categories class-attribute instance-attribute

product_categories: list[ProductCategory] | None = None

Product categories.

products class-attribute instance-attribute

products: list[Product] | None = None

Products.

schedules class-attribute instance-attribute

schedules: list[Schedule] | None = None

Schedules.

tax_categories class-attribute instance-attribute

tax_categories: list[MenuTaxCategory] | None = None

Tax categories.

MenusDataResponse

Bases: IikoModel

Response with stock lists.

correlation_id instance-attribute

correlation_id: str

Operation ID.

external_menus class-attribute instance-attribute

external_menus: list[ExternalMenu] | None = None

External menu.

price_categories class-attribute instance-attribute

price_categories: list[NomenclaturePriceCategory] | None = (
    None
)

Price category.

ModifierGroup

Bases: IikoModel

Modifier group.

child_modifiers_have_min_max_restrictions class-attribute instance-attribute

child_modifiers_have_min_max_restrictions: bool | None = (
    None
)

Flag indicating whether child modifiers have min/max restrictions.

id class-attribute instance-attribute

id: str | None = None

Modifier group ID.

is_hidden class-attribute instance-attribute

is_hidden: bool | None = None

Flag indicating whether the group is hidden.

items class-attribute instance-attribute

items: list[ModifierItem] | None = None

List of modifiers in the group.

name instance-attribute

name: str

Modifier group name.

restrictions class-attribute instance-attribute

restrictions: Restrictions | None = None

Modifier selection restrictions.

sku class-attribute instance-attribute

sku: str | None = None

SKU.

splittable class-attribute instance-attribute

splittable: bool | None = None

Flag indicating whether the group is splittable.

ModifierItem

Bases: IikoModel

Modifier item in a group. All fields except Id are optional overrides: when a field is null, its value must be taken from the reference Modifier (MenuV3.modifiers) with the same Id.

button_image_url class-attribute instance-attribute

button_image_url: str | None = None

Deprecated. Button image URL. If null, the value is taken from the reference Modifier with the same Id.

description class-attribute instance-attribute

description: str | None = None

Modifier description. If null, the value is taken from the reference Modifier with the same Id.

id instance-attribute

id: str

Modifier ID.

image class-attribute instance-attribute

image: Image | None = None

Modifier image. Replaces ButtonImageUrl. If null, the value is taken from the reference Modifier with the same Id.

is_hidden class-attribute instance-attribute

is_hidden: bool | None = None

Flag indicating whether the modifier is hidden. If null, the value is taken from the reference Modifier with the same Id.

measure_unit_type class-attribute instance-attribute

measure_unit_type: MeasureUnitType | None = None

Unit of measurement. If null, the value is taken from the reference Modifier with the same Id.

name class-attribute instance-attribute

name: str | None = None

Modifier name. If null, the value is taken from the reference Modifier with the same Id.

restrictions class-attribute instance-attribute

restrictions: Restrictions | None = None

Modifier selection restrictions. If null, the value is taken from the reference Modifier with the same Id.

tags class-attribute instance-attribute

tags: list[str] | None = None

List of tags associated with the element. If null, the value is taken from the reference Modifier with the same Id.

weight class-attribute instance-attribute

weight: Decimal | None = None

Weight. If null, the value is taken from the reference Modifier with the same Id.

NomenclatureOrderItemType

Bases: OpenStrEnum

Flag that determines dish linkage with modifiers scheme.

NomenclaturePriceCategory

Bases: IikoModel

Price category, related to ApiLogin.

id instance-attribute

id: str

ID.

name instance-attribute

name: str

Name.

NomenclatureRequest

Bases: IikoModel

Request for stock list by organization.

organization_id instance-attribute

organization_id: str

Organization ID.

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

start_revision class-attribute instance-attribute

start_revision: int | None = None

The revision (version) of the menu saved on the integration side. Use 0 for the first request for each organization. In every subsequent request, the startRevision field should contain the value of the revision field received in the response to the previous request.

NomenclatureResponse

Bases: IikoModel

Response with stock lists.

correlation_id instance-attribute

correlation_id: str

Operation ID.

groups instance-attribute

groups: list[ProductsGroupInfo]

Stock list group.

product_categories instance-attribute

product_categories: list[ProductCategoryInfo]

Menu item category.

products instance-attribute

products: list[ProductInfo]

Menu items and modifiers.

revision instance-attribute

revision: int

The revison (version) of the menu recevied in the response of the request. This value should be saved by the integration and passed in the startRevision field of the next menu request. If the values in revision and startRevision are the same, it means there have been no changes to the menu since the previous request. In this case, the groups, productCategories, products and sizes fields will not contain any data.

sizes instance-attribute

sizes: list[Size]

Item sizes.

NomenclatureSizePrice

Bases: IikoModel

Price per item size.

price instance-attribute

price: Price

Price per this item size.

size_id class-attribute instance-attribute

size_id: str | None = None

Item size ID.

Nutritions

Bases: IikoModel

Nutritional value.

carbs class-attribute instance-attribute

carbs: Decimal | None = None

Carbohydrates.

energy class-attribute instance-attribute

energy: Decimal | None = None

Energy value.

fats class-attribute instance-attribute

fats: Decimal | None = None

Fats.

proteins class-attribute instance-attribute

proteins: Decimal | None = None

Proteins.

salt class-attribute instance-attribute

salt: Decimal | None = None

Salt.

saturated_fatty_acid class-attribute instance-attribute

saturated_fatty_acid: Decimal | None = None

Saturated fatty acids.

sugar class-attribute instance-attribute

sugar: Decimal | None = None

Sugar.

OpenPersonalSessionRequest

Bases: IikoModel

Open personal session request.

employee_id instance-attribute

employee_id: str

Employee ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

role_id class-attribute instance-attribute

role_id: str | None = None

Employee role ID.

Must be null if the restaurant doesn't use roles, otherwise not-null role must be specified.

terminal_group_id instance-attribute

terminal_group_id: str

Delivery group ID.

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

OrderAttentionNotificationRequest

Bases: SendNotificationRequestBase

Request to notify external systems (iikoFront and iikoWeb) about an order requiring attention.

additional_info instance-attribute

additional_info: str

Additional info about the problem.

order_id instance-attribute

order_id: str

Order ID.

order_source instance-attribute

order_source: str

Order source.

OrderType

Bases: IikoModel

Order type.

external_revision class-attribute instance-attribute

external_revision: int | None = None

External system revision number.

id instance-attribute

id: str

Order type ID in RMS.

is_default class-attribute instance-attribute

is_default: bool | None = None

IsDefault attribute of order type.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

IsDeleted attribute of order type.

name instance-attribute

name: str

Order type name.

order_service_type instance-attribute

order_service_type: OrderTypeServiceType

Service type.

OrderTypeServiceType

Bases: OpenStrEnum

Order service type.

OrderTypesRequest

Bases: IikoModel

Request for order types.

organization_ids instance-attribute

organization_ids: list[str]

Organizations IDs which payment types have to be returned.

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

OrderTypesResponse

Bases: IikoModel

Response to request for order types by organization.

correlation_id instance-attribute

correlation_id: str

Operation ID.

order_types instance-attribute

order_types: list[OrganizationItems[OrderType]]

List of order types.

OrganizationSettings

Bases: IikoModel

Organization settings.

address_format_type class-attribute instance-attribute

address_format_type: AddressFormatType | None = None

Address format type.

Available if AddressFormatType requested.

address_lookup class-attribute instance-attribute

address_lookup: list[AddressHintsServiceType] | None = None

Available address lookup services.

Available if AddressLookup requested.

confirm_allowed_interval_in_minutes class-attribute instance-attribute

confirm_allowed_interval_in_minutes: int | None = None

Confirm orders time interval.

Available if ConfirmAllowedIntervalInMinutes requested.

country class-attribute instance-attribute

country: str | None = None

Country.

Available if Country requested.

country_phone_code class-attribute instance-attribute

country_phone_code: str | None = None

Country dialing code.

Available if CountryPhoneCode requested.

currency_iso_name class-attribute instance-attribute

currency_iso_name: str | None = None

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

default_call_center_payment_type_id class-attribute instance-attribute

default_call_center_payment_type_id: str | None = None

Default payment type for CallCenter.

Available if DefaultCallCenterPaymentTypeId requested.

default_delivery_city_id class-attribute instance-attribute

default_delivery_city_id: str | None = None

Default delivery city.

Available if DefaultDeliveryCityId requested.

delivery_city_ids class-attribute instance-attribute

delivery_city_ids: list[str] | None = None

Delivery cities.

Available if DeliveryCityIds requested.

delivery_order_payment_settings class-attribute instance-attribute

delivery_order_payment_settings: (
    DeliveryOrderPaymentSettings | None
) = None

Delivery order payment settings.

Available if DeliveryOrderPaymentSettings requested.

delivery_service_type class-attribute instance-attribute

delivery_service_type: (
    DeliverySettingsServiceType | None
) = None

Delivery type.

Available if DeliveryServiceType requested.

external_data class-attribute instance-attribute

external_data: list[ExternalDataEntry] | None = None

Organization`s external data.

id instance-attribute

id: str

Organization ID.

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.

Available if IsAnonymousGuestsAllowed requested.

is_confirmation_enabled class-attribute instance-attribute

is_confirmation_enabled: bool | None = None

Determines whether to use delivery confirmation.

Available if IsConfirmationEnabled requested.

latitude class-attribute instance-attribute

latitude: Decimal | None = None

Latitude.

Available if Latitude requested.

longitude class-attribute instance-attribute

longitude: Decimal | None = None

Longitude.

Available if Longitude requested.

loyalty_discount_affects_vat class-attribute instance-attribute

loyalty_discount_affects_vat: bool | None = None

Determines whether organization loyalty discounts affects VAT.

Working only if "pricesVatInclusive" = false

Available if VAT requested.

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.

Available if MarketingSourceRequiredInDelivery requested.

name class-attribute instance-attribute

name: str | None = None

Organization name.

Available if Name requested.

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

Available if OrderItemCommentEnabled requested.

prices_vat_inclusive class-attribute instance-attribute

prices_vat_inclusive: bool | None = None

Determines whether organization prices include VAT.

Available if VAT requested.

restaurant_address class-attribute instance-attribute

restaurant_address: str | None = None

Restaurant address.

Available if RestaurantAddress requested.

use_business_hours_and_mapping class-attribute instance-attribute

use_business_hours_and_mapping: bool | None = None

Determines whether the organization use a business hours and mapping settings.

use_uae_addressing_system class-attribute instance-attribute

use_uae_addressing_system: bool | None = None

Regional setting "Use the UAE Addressing System".

Available if UseUaeAddressingSystem requested.

version class-attribute instance-attribute

version: str | None = None

RMS version.

Available if Version requested.

OrganizationSettingsParameters

Bases: OpenStrEnum

Type of organization settings.

OrganizationsSettingsRequest

Bases: IikoModel

Request for organizations specified settings.

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.

parameters class-attribute instance-attribute

parameters: list[OrganizationSettingsParameters] | None = (
    None
)

Parameters of information to be present in response.

return_external_data class-attribute instance-attribute

return_external_data: list[str] | None = None

External data keys that have to be returned.

OrganizationsSettingsResponse

Bases: IikoModel

Response to request for organizations specified settings.

correlation_id instance-attribute

correlation_id: str

Operation ID.

organizations instance-attribute

organizations: list[OrganizationSettings]

List of organizations with specified settings.

PaymentProcessingType

Bases: OpenStrEnum

Payment processing type.

PaymentType

Bases: IikoModel

DTO for payment type in iikoRMS

applicable_marketing_campaigns instance-attribute

applicable_marketing_campaigns: list[str]

Array of marketing campaigns associated with LoyaltyApp payment type applicable to this organization.

code class-attribute instance-attribute

code: str | None = None

Payment type code

combinable class-attribute instance-attribute

combinable: bool | None = None

Combinability attribute

comment class-attribute instance-attribute

comment: str | None = None

Payment type comment

external_revision class-attribute instance-attribute

external_revision: int | None = None

External system revision number.

id class-attribute instance-attribute

id: str | None = None

Payment type ID

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

IsDeleted attribute of payment type.

name class-attribute instance-attribute

name: str | None = None

Payment type name

payment_processing_type class-attribute instance-attribute

payment_processing_type: PaymentProcessingType | None = None

Describes operation processing type.

payment_type_kind class-attribute instance-attribute

payment_type_kind: PaymentTypeCategory | None = None

Payment type category.

print_cheque class-attribute instance-attribute

print_cheque: bool | None = None

If true, payment type is fiscal and bill will be printed.

terminal_groups instance-attribute

terminal_groups: list[TerminalGroup]

Terminal groups where this payment type is available.

PaymentTypeCategory

Bases: OpenStrEnum

Payment type category.

PaymentTypesRequest

Bases: IikoModel

Request for payment types.

organization_ids instance-attribute

organization_ids: list[str]

Organizations IDs which payment types have to be returned.

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

PaymentTypesResponse

Bases: IikoModel

Response to request for payment types by organization.

payment_types instance-attribute

payment_types: list[PaymentType]

List of payment types and terminal groups where they are available.

Period

Bases: IikoModel

Schedule period.

from_ class-attribute instance-attribute

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

Start time (format: HH:mm:ss).

to instance-attribute

to: str

End time (format: HH:mm:ss).

week_days instance-attribute

week_days: list[WeekDay]

Days of week.

Price

Bases: IikoModel

Price per this item size.

current_price instance-attribute

current_price: Decimal

Current price.

is_included_in_menu instance-attribute

is_included_in_menu: bool

Is on the menu.

next_date_price class-attribute instance-attribute

next_date_price: IikoDateTime | None = None

New price validity start date (Local for the terminal).

next_included_in_menu instance-attribute

next_included_in_menu: bool

Will be on the menu in the future.

next_price class-attribute instance-attribute

next_price: Decimal | None = None

New price

PriceStrategy

Bases: OpenStrEnum

Combo meal pricing strategy.

Product

Bases: IikoModel

Product.

barcodes class-attribute instance-attribute

barcodes: list[BarcodeInfo] | None = None

Barcodes.

can_set_open_price class-attribute instance-attribute

can_set_open_price: bool | None = None

Flag indicating whether open price can be set.

customer_tag_groups class-attribute instance-attribute

customer_tag_groups: list[CustomerTagGroupItem] | None = (
    None
)

Customer tag groups.

id instance-attribute

id: str

Product ID.

is_marked class-attribute instance-attribute

is_marked: bool | None = None

Flag indicating whether the product is marked.

measure_unit class-attribute instance-attribute

measure_unit: str | None = None

Unit of measurement.

modifier_schema_id class-attribute instance-attribute

modifier_schema_id: str | None = None

Modifier schema ID.

modifier_schema_name class-attribute instance-attribute

modifier_schema_name: str | None = None

Modifier schema name.

order_item_type class-attribute instance-attribute

order_item_type: MenuOrderItemType | None = None

Order item type.

outer_ean_code class-attribute instance-attribute

outer_ean_code: str | None = None

External EAN code.

payment_subject_code class-attribute instance-attribute

payment_subject_code: str | None = None

Payment subject code.

product_category_id class-attribute instance-attribute

product_category_id: str | None = None

Product category ID.

sku instance-attribute

sku: str

SKU.

splittable class-attribute instance-attribute

splittable: bool | None = None

Flag indicating whether the product is splittable.

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

Tax category ID.

type class-attribute instance-attribute

type: ProductType | None = None

Product type.

use_balance_for_sell class-attribute instance-attribute

use_balance_for_sell: bool | None = None

Use balance for sale.

ProductCategory

Bases: IikoModel

Product category.

id instance-attribute

id: str

Category ID.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Flag indicating whether the category is deleted.

name instance-attribute

name: str

Category name.

ProductCategoryDiscount

Bases: IikoModel

Product category discount details.

category_id instance-attribute

category_id: str

Category ID.

category_name class-attribute instance-attribute

category_name: str | None = None

Category name.

percent instance-attribute

percent: Decimal

This category discount %.

ProductCategoryInfo

Bases: IikoModel

DTO for outside transferring of product category details.

id instance-attribute

id: str

Product category ID.

is_deleted instance-attribute

is_deleted: bool

Is deleted attribute.

name instance-attribute

name: str

Name.

ProductInfo

Bases: IikoModel

DTO for outside transferring of external menu item details.

additional_info class-attribute instance-attribute

additional_info: str | None = None

Additional information.

can_set_open_price instance-attribute

can_set_open_price: bool

Open price.

carbohydrates_amount class-attribute instance-attribute

carbohydrates_amount: Decimal | None = None

Carbohydrate per 100g.

carbohydrates_full_amount class-attribute instance-attribute

carbohydrates_full_amount: Decimal | None = None

Carbohydrate per item.

code class-attribute instance-attribute

code: str | None = None

SKU.

description class-attribute instance-attribute

description: str | None = None

Description.

do_not_print_in_cheque class-attribute instance-attribute

do_not_print_in_cheque: bool | None = None

Do not print on bill.

energy_amount class-attribute instance-attribute

energy_amount: Decimal | None = None

Calories per 100g.

energy_full_amount class-attribute instance-attribute

energy_full_amount: Decimal | None = None

Calories per item.

fat_amount class-attribute instance-attribute

fat_amount: Decimal | None = None

Fat per 100g.

fat_full_amount class-attribute instance-attribute

fat_full_amount: Decimal | None = None

Fat per item.

full_name_english class-attribute instance-attribute

full_name_english: str | None = None

Full name in a foreign language.

group_id class-attribute instance-attribute

group_id: str | None = None

Stock list group in RMS.

group_modifiers class-attribute instance-attribute

group_modifiers: list[GroupModifierInfo] | None = None

Modifier groups.

id instance-attribute

id: str

ID.

image_links class-attribute instance-attribute

image_links: list[str] | None = None

Links to images.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Is-Deleted attribute.

measure_unit class-attribute instance-attribute

measure_unit: str | None = None

Item's unit of measurement.

modifier_schema_id class-attribute instance-attribute

modifier_schema_id: str | None = None

Modifier schema's ID.

modifier_schema_name class-attribute instance-attribute

modifier_schema_name: str | None = None

Modifier schema's name.

modifiers class-attribute instance-attribute

modifiers: list[SimpleModifierInfo] | None = None

Modifiers.

name instance-attribute

name: str

Name.

order class-attribute instance-attribute

order: int | None = None

Product's order (priority) in menu.

order_item_type class-attribute instance-attribute

order_item_type: NomenclatureOrderItemType | None = None

Product or compound. Depends on modifiers scheme existence.

parent_group class-attribute instance-attribute

parent_group: str | None = None

External menu group.

payment_subject class-attribute instance-attribute

payment_subject: str | None = None

Payment subject.

product_category_id class-attribute instance-attribute

product_category_id: str | None = None

Product category in RMS.

proteins_amount class-attribute instance-attribute

proteins_amount: Decimal | None = None

Protein per 100g.

proteins_full_amount class-attribute instance-attribute

proteins_full_amount: Decimal | None = None

Protein per item.

seo_description class-attribute instance-attribute

seo_description: str | None = None

SEO description for client.

seo_keywords class-attribute instance-attribute

seo_keywords: str | None = None

SEO key words.

seo_text class-attribute instance-attribute

seo_text: str | None = None

SEO text for robots.

seo_title class-attribute instance-attribute

seo_title: str | None = None

SEO header.

size_prices class-attribute instance-attribute

size_prices: list[NomenclatureSizePrice] | None = None

Prices.

splittable instance-attribute

splittable: bool

Is product splittable.

tags class-attribute instance-attribute

tags: list[str] | None = None

Tags.

type class-attribute instance-attribute

type: str | None = None

dish | good | modifier.

use_balance_for_sell instance-attribute

use_balance_for_sell: bool

Weighed product.

weight class-attribute instance-attribute

weight: Decimal | None = None

Item weight.

ProductType

Bases: OpenStrEnum

Product type.

ProductsGroupInfo

Bases: IikoModel

DTO for outside transferring of external menu group details.

additional_info class-attribute instance-attribute

additional_info: str | None = None

Additional information.

code class-attribute instance-attribute

code: str | None = None

SKU.

description class-attribute instance-attribute

description: str | None = None

Description.

id instance-attribute

id: str

ID.

image_links instance-attribute

image_links: list[str]

Links to images.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Is-Deleted attribute.

is_group_modifier instance-attribute

is_group_modifier: bool

Is group modifier attribute. * true - group modifier. * false - external menu group.

is_included_in_menu instance-attribute

is_included_in_menu: bool

On-the-menu attribute.

name instance-attribute

name: str

Name.

order instance-attribute

order: int

Group's order (priority) in menu.

parent_group class-attribute instance-attribute

parent_group: str | None = None

Parent group.

seo_description class-attribute instance-attribute

seo_description: str | None = None

SEO description for client.

seo_keywords class-attribute instance-attribute

seo_keywords: str | None = None

SEO key words.

seo_text class-attribute instance-attribute

seo_text: str | None = None

SEO text for robots.

seo_title class-attribute instance-attribute

seo_title: str | None = None

SEO header.

tags class-attribute instance-attribute

tags: list[str] | None = None

Tags.

RemovalType

Bases: IikoModel

Removal type (aka reason for deletion).

can_writeoff_to_cafe class-attribute instance-attribute

can_writeoff_to_cafe: bool | None = None

Can write off to cafe.

can_writeoff_to_user class-attribute instance-attribute

can_writeoff_to_user: bool | None = None

Can write off to user.

can_writeoff_to_waiter class-attribute instance-attribute

can_writeoff_to_waiter: bool | None = None

Can write off to waiter.

comment class-attribute instance-attribute

comment: str | None = None

Comment.

id instance-attribute

id: str

Identifier.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Is deleted sign.

manual class-attribute instance-attribute

manual: bool | None = None

Can be used manually.

name instance-attribute

name: str

Name of removal type.

reason_required class-attribute instance-attribute

reason_required: bool | None = None

Require comments on operations.

RemovalTypesRequest

Bases: IikoModel

Request for organization's removal types (reasons for deletion).

organization_ids instance-attribute

organization_ids: list[str]

Organizations ids which removal types needs to be returned.

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

RemovalTypesResponse

Bases: IikoModel

Response with removal types (reasons for deletion) list.

correlation_id instance-attribute

correlation_id: str

Operation ID.

removal_types instance-attribute

removal_types: list[RemovalType]

List of removal types.

RemoveProductsFromStopListItem

Bases: IikoModel

Item for remove from out-of-stock list.

product_id instance-attribute

product_id: str

Out-of-stock list product ID.

size_id class-attribute instance-attribute

size_id: str | None = None

Out-of-stock list product size ID.

RemoveProductsFromStopListRequest

Bases: IikoModel

Request for remove items from out-of-stock list.

items instance-attribute

items: list[RemoveProductsFromStopListItem]

Items for removing from out-of-stock list.

organization_id instance-attribute

organization_id: str

Organization ID.

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

terminal_group_id instance-attribute

terminal_group_id: str

Terminal group ID.

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

Restrictions

Bases: IikoModel

Modifier selection restrictions.

default_quantity class-attribute instance-attribute

default_quantity: Decimal | None = None

Default quantity.

free_quantity class-attribute instance-attribute

free_quantity: Decimal | None = None

Free quantity.

hide_if_default_quantity class-attribute instance-attribute

hide_if_default_quantity: bool | None = None

Hide if quantity equals default quantity.

max_quantity class-attribute instance-attribute

max_quantity: Decimal | None = None

Maximum quantity.

min_quantity class-attribute instance-attribute

min_quantity: Decimal | None = None

Minimum quantity.

RoleCheckResult

Bases: IikoModel

Result of checking employee role.

checked_role_code instance-attribute

checked_role_code: str

Checked for employee role.

employee_has_role instance-attribute

employee_has_role: bool

Sign that employee has role "checkedRoleCode".

Schedule

Bases: IikoModel

Schedule.

id instance-attribute

id: str

Schedule ID.

name instance-attribute

name: str

Schedule name.

periods instance-attribute

periods: list[Period]

Schedule periods.

SendNotificationRequestBase

Bases: IikoModel

Request to notify external systems (iikoFront and iikoWeb).

organization_id instance-attribute

organization_id: str

Organization UOC Id.

SimpleModifierInfo

Bases: IikoModel

Modifier details.

default_amount class-attribute instance-attribute

default_amount: int | None = None

Default quantity.

free_of_charge_amount class-attribute instance-attribute

free_of_charge_amount: int | None = None

Free of charge amount. This field is supported since 7.2.4 iikoRMS version.

hide_if_default_amount class-attribute instance-attribute

hide_if_default_amount: bool | None = None

Hide if default amount applied. This field is supported since 7.2.4 iikoRMS version.

id instance-attribute

id: str

ID.

max_amount instance-attribute

max_amount: int

Maximum quantity.

min_amount instance-attribute

min_amount: int

Minimum quantity.

required class-attribute instance-attribute

required: bool | None = None

Required availability.

splittable class-attribute instance-attribute

splittable: bool | None = None

Modifier can be split. This field is supported since 7.2.4 iikoRMS version.

Size

Bases: IikoModel

Item size.

id class-attribute instance-attribute

id: str | None = None

ID.

is_default class-attribute instance-attribute

is_default: bool | None = None

Is the default size in the size scale.

name class-attribute instance-attribute

name: str | None = None

Name.

priority class-attribute instance-attribute

priority: int | None = None

Priority (serial number) of the size in the size scale.

SizePriceShort

Bases: IikoModel

Size price (short form).

price class-attribute instance-attribute

price: Decimal | None = None

Price.

size_id class-attribute instance-attribute

size_id: str | None = None

Size ID.

tax_category_id class-attribute instance-attribute

tax_category_id: str | None = None

Tax category ID.

StopListItem

Bases: IikoModel

Out-of-stock list.

balance instance-attribute

balance: Decimal

Product balance.

date_add class-attribute instance-attribute

date_add: IikoDateTime | None = None

Date the product was added to the out-of-stock list (UTC).

product_id instance-attribute

product_id: str

Out-of-stock list product ID.

size_id class-attribute instance-attribute

size_id: str | None = None

Product size.

sku class-attribute instance-attribute

sku: str | None = None

Stock keeping unit.

StopListsRequest

Bases: IikoModel

DTO of out-of-stock lists request.

organization_ids instance-attribute

organization_ids: list[str]

Organizations for which out-of-stock lists will be requested.

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

return_size class-attribute instance-attribute

return_size: bool | None = None

Flag indicating the need to return the sizes of the dish.

terminal_groups_ids class-attribute instance-attribute

terminal_groups_ids: list[str] | None = None

List of terminal groups for which you need to get out-of-stock lists.

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

StopListsResponse

Bases: IikoModel

Status of out-of-stock lists for a specified organization

correlation_id instance-attribute

correlation_id: str

Operation ID.

terminal_group_stop_lists instance-attribute

terminal_group_stop_lists: list[
    OrganizationItems[TerminalGroupStopList]
]

Set of out-of-stock lists

SuccessCommandStatus

Bases: GetCommandStatusResponseBase

Command completed successfully.

TagItem

Bases: IikoModel

Tag.

id instance-attribute

id: str

Tag ID.

name instance-attribute

name: str

Tag name.

TaxCategoryOverride

Bases: IikoModel

Tax category override.

base_tax_category_id class-attribute instance-attribute

base_tax_category_id: str | None = None

Base tax category ID.

new_tax_category_id class-attribute instance-attribute

new_tax_category_id: str | None = None

New tax category ID to use instead of the base one.

order_type_id class-attribute instance-attribute

order_type_id: str | None = None

Order type ID. If null, the override is applied to all order types.

TerminalGroupAliveInfo

Bases: IikoModel

DTO containing terminal group availability details.

is_alive instance-attribute

is_alive: bool

Attribute that shows whether a terminal is available to request processing.

organization_id instance-attribute

organization_id: str

Organizations ID.

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

terminal_group_id instance-attribute

terminal_group_id: str

ID of front group of terminals.

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

TerminalGroupStopList

Bases: IikoModel

Out-of-stock list status for a group of front terminals.

items instance-attribute

items: list[StopListItem]

Out-of-stock list.

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Terminal ID.

TerminalGroupsIsAliveRequest

Bases: IikoModel

Request for terminal group availability details.

organization_id class-attribute instance-attribute

organization_id: str | None = None

Deprecated. Organization ID. Deprecated, use "organizationIds".

organization_ids class-attribute instance-attribute

organization_ids: list[str] | None = None

Organization IDs.

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

terminal_group_ids instance-attribute

terminal_group_ids: list[str]

List of terminal groups IDs.

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

TerminalGroupsIsAliveResponse

Bases: IikoModel

DTO containing terminal group availability details.

correlation_id instance-attribute

correlation_id: str

Operation ID.

is_alive_status instance-attribute

is_alive_status: list[TerminalGroupAliveInfo]

Availability attribute of each requested terminal.

TerminalGroupsRequest

Bases: IikoModel

Request for list of terminal groups.

include_disabled class-attribute instance-attribute

include_disabled: bool | None = None

Attribute that shows that response contains disabled 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.

return_external_data class-attribute instance-attribute

return_external_data: list[str] | None = None

External data keys that have to be returned.

TipsType

Bases: IikoModel

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.

order_service_types instance-attribute

order_service_types: list[OrderTypeServiceType]

Supported order service types.

organization_ids instance-attribute

organization_ids: list[str]

Supported organizations IDs.

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

payment_types_ids instance-attribute

payment_types_ids: list[str]

Supported payment types IDs.

TipsTypesResponse

Bases: IikoModel

Response to request for tips types by api-login`s rms group.

correlation_id instance-attribute

correlation_id: str

Operation ID.

tips_types instance-attribute

tips_types: list[TipsType]

List of tips types for rms group.

WeekDay

Bases: OpenStrEnum

Day of week.