Loyalty models

Models of the loyalty (iikoCard) endpoints.

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

GetCustomerInfoRequest module-attribute

GetCustomerInfoRequest = Annotated[
    Annotated[GetCustomerInfoByPhoneRequest, Tag("phone")]
    | Annotated[
        GetCustomerInfoByCardTrackRequest, Tag("cardTrack")
    ]
    | Annotated[
        GetCustomerInfoByCardNumberRequest,
        Tag("cardNumber"),
    ]
    | Annotated[GetCustomerInfoByEmailRequest, Tag("email")]
    | Annotated[GetCustomerInfoByIdRequest, Tag("id")]
    | Annotated[GetCustomerInfoRequestBase, Tag(UNKNOWN)],
    discriminator(
        "type",
        "type",
        ("phone", "cardTrack", "cardNumber", "email", "id"),
    ),
]

Base class for customer info request.

One of GetCustomerInfoByPhoneRequest, GetCustomerInfoByCardTrackRequest, GetCustomerInfoByCardNumberRequest, GetCustomerInfoByEmailRequest, GetCustomerInfoByIdRequest, selected by type. Values unknown to this library are parsed as GetCustomerInfoRequestBase.

AddCustomerToProgramRequest

Bases: IikoModel

Add customer to program request.

customer_id class-attribute instance-attribute

customer_id: str | None = None

Customer id.

organization_id instance-attribute

organization_id: str

Organization id.

program_id class-attribute instance-attribute

program_id: str | None = None

Program id.

AddCustomerToProgramResponse

Bases: IikoModel

Add customer to program response.

user_wallet_id class-attribute instance-attribute

user_wallet_id: str | None = None

User wallet id.

wallet_id class-attribute instance-attribute

wallet_id: str | None = None

Program Wallet id which guest was added to.

AddMagnetCardRequest

Bases: IikoModel

Add magnet card request.

card_number instance-attribute

card_number: str

Card number. Can be null.

card_track instance-attribute

card_track: str

Card track. Can be null.

customer_id instance-attribute

customer_id: str

Customer id.

organization_id instance-attribute

organization_id: str

Organization id.

AddMagnetCardResponse

Bases: IikoModel

Add magnet card response.

AvailableCombo

Bases: IikoModel

Available combo.

group_mapping class-attribute instance-attribute

group_mapping: list[ComboGroupMapping] | None = None

Groups contained in combo. If null - there is no suitable product in order yet for that group.

specification_id class-attribute instance-attribute

specification_id: str | None = None

Id of combo specification, describing combo content.

AvailablePayment

Bases: IikoModel

Available payment.

id class-attribute instance-attribute

id: str | None = None

Marketing campaign id.

max_sum class-attribute instance-attribute

max_sum: Decimal | None = None

Max sum.

order class-attribute instance-attribute

order: int | None = None

Payment order. In case of partial payment, payments with lesser order should be filled first.

wallet_infos class-attribute instance-attribute

wallet_infos: list[WalletInfo] | None = None

Wallet infos.

CalculateCheckinRequest

Bases: IikoModel

Request to calculate loyalty operations for order.

applicable_manual_conditions class-attribute instance-attribute

applicable_manual_conditions: list[str] | None = None

Obsolete field. Use request.Order.LoyaltyInfo.ApplicableManualConditions instead.

available_payment_marketing_campaign_ids class-attribute instance-attribute

available_payment_marketing_campaign_ids: (
    list[str] | None
) = None

List of identifiers of applied campaigns. Should be empty if no payment method is used.

coupon class-attribute instance-attribute

coupon: str | None = None

Obsolete field. Use Order.LoyaltyInfo.Coupon instead. Can be null.

dynamic_discounts class-attribute instance-attribute

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

Obsolete field. Use Order.LoyaltyInfo.DynamicDiscounts instead. Can be null..

is_loyalty_trace_enabled class-attribute instance-attribute

is_loyalty_trace_enabled: bool | None = None

Loyalty trace is enabled.

order instance-attribute

order: Order

Order.

organization_id instance-attribute

organization_id: str

Organization id.

referrer_id class-attribute instance-attribute

referrer_id: str | None = None

Referrer id.

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Identifier of a target terminal. Should be used only when auto distribution is off and no call center operator is available.

CalculateCheckinResponse

Bases: IikoModel

Loyalty result for order.

available_payments class-attribute instance-attribute

available_payments: list[AvailablePayment] | None = None

Marketing campaigns with available payments.

loyalty_program_results class-attribute instance-attribute

loyalty_program_results: (
    list[LoyaltyProgramResult] | None
) = None

Loyalty program results.

loyalty_trace class-attribute instance-attribute

loyalty_trace: str | None = None

Loyalty trace. Can be null.

validation_warnings class-attribute instance-attribute

validation_warnings: list[str] | None = None

Warnings about errors, not blocking loyalty calculation.

warnings class-attribute instance-attribute

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

Warnings about errors, not blocking loyalty calculation.

CancelHoldMoneyRequest

Bases: IikoModel

Cancel hold money request.

organization_id instance-attribute

organization_id: str

Organization id.

transaction_id instance-attribute

transaction_id: str

Transaction id.

CancelHoldMoneyResponse

Bases: IikoModel

Cancel hold money response.

CertificateCounteragentType

Bases: OpenIntEnum

Certificate counteragent type

ChangeCategoryForCustomerRequest

Bases: IikoModel

Change category for customer request.

category_id instance-attribute

category_id: str

Guest category id.

customer_id instance-attribute

customer_id: str

Customer id.

organization_id instance-attribute

organization_id: str

Organization id.

ChangeCategoryForCustomerResponse

Bases: IikoModel

Change category for customer response.

ChangeUserBalanceRequest

Bases: IikoModel

Change user balance request.

comment class-attribute instance-attribute

comment: str | None = None

Comment. Can be null.

customer_id class-attribute instance-attribute

customer_id: str | None = None

Customer id.

organization_id instance-attribute

organization_id: str

Organization id.

sum class-attribute instance-attribute

sum: Decimal | None = None

Sum of balance change. Must be positive.

wallet_id class-attribute instance-attribute

wallet_id: str | None = None

Wallet id.

CheckSmsStatusRequest

Bases: IikoModel

Check sms status request.

organization_id instance-attribute

organization_id: str

Organization id.

sms_ids instance-attribute

sms_ids: list[str]

Sms IDs for checking.

CheckSmsStatusResponse

Bases: IikoModel

Check sms status response.

statuses instance-attribute

statuses: list[SmsSendingStatusInfo]

Information about the status of sending SMS.

ComboGroupMapping

Bases: IikoModel

Mapping combo's group to OrderItem.

group_id class-attribute instance-attribute

group_id: str | None = None

Id of combo group.

item_id class-attribute instance-attribute

item_id: str | None = None

Id of item, suitable for group.

CounterMetric

Bases: OpenIntEnum

CounterMetric values.

CounterPeriod

Bases: OpenIntEnum

CounterPeriod values.

CouponInfo

Bases: IikoModel

Coupon info.

id class-attribute instance-attribute

id: str | None = None

Id.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Is deleted.

number class-attribute instance-attribute

number: str | None = None

Number. Can be null.

series_id class-attribute instance-attribute

series_id: str | None = None

Series id.

series_name class-attribute instance-attribute

series_name: str | None = None

Series name. Can be null.

when_activated class-attribute instance-attribute

when_activated: IikoDateTime | None = None

When activated.

CouponInfoRequest

Bases: IikoModel

Coupon info request.

number instance-attribute

number: str

Number. Can be null.

organization_id instance-attribute

organization_id: str

Organization id.

series class-attribute instance-attribute

series: str | None = None

Series. Can be null.

CouponInfoResponse

Bases: IikoModel

Coupon info response.

coupon_info class-attribute instance-attribute

coupon_info: list[CouponInfo] | None = None

Coupon info.

CreateOrUpdateCustomerRequest

Bases: IikoModel

Not empty phone or magnetCardTrack or id is required for successful import.

birthday class-attribute instance-attribute

birthday: IikoDateTime | None = None

Customer birthday.

card_number class-attribute instance-attribute

card_number: str | None = None

Card number. Required if cardTrack set. Can be null.

card_track class-attribute instance-attribute

card_track: str | None = None

Card track. Required if cardNumber set. Can be null.

comment class-attribute instance-attribute

comment: str | None = None

Customer description and additional data. Can be null.

consent_status class-attribute instance-attribute

consent_status: PersonalDataConsentStatus | None = None

Customer consent status.

0 - unknown, 1 - given, 2 - revoked.

email class-attribute instance-attribute

email: str | None = None

Customer email. Can be null.

employee_id class-attribute instance-attribute

employee_id: str | None = None

Employee number or id. Can be null.

id class-attribute instance-attribute

id: str | None = None

Customer id.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Customer logical deletion flag.

middle_name class-attribute instance-attribute

middle_name: str | None = None

Customer middle name. Can be null.

name class-attribute instance-attribute

name: str | None = None

Customer name. Can be null.

nullify_empty_fields class-attribute instance-attribute

nullify_empty_fields: bool | None = None

If set to true, then empty string values (not null) will overwrite origin guest fields with nulls, otherwise empty fields are ignored.

organization_id instance-attribute

organization_id: str

Customer organization id.

phone class-attribute instance-attribute

phone: str | None = None

Customer phone. Can be null.

referrer_id class-attribute instance-attribute

referrer_id: str | None = None

Id for referrer guest. Null for old integrations, Guid.Empty - for referrer deletion. Can be null.

sex class-attribute instance-attribute

sex: IikoNetUserSex | None = None

Customer sex.

0 - not specified, 1 - male, 2 - female.

should_receive_loyalty_info class-attribute instance-attribute

should_receive_loyalty_info: bool | None = None

Customer get loyalty messages (email, sms). If the parameter is not specified for new customers, the value 'true' is used.

should_receive_promo_actions_info class-attribute instance-attribute

should_receive_promo_actions_info: bool | None = None

Customer get promo messages (email, sms). If the parameter is not specified for new customers, the value 'true' is used.

sur_name class-attribute instance-attribute

sur_name: str | None = None

Customer surname. Can be null.

user_data class-attribute instance-attribute

user_data: str | None = None

Customer user data. Can be null.

CreateOrUpdateCustomerResponse

Bases: IikoModel

Create or update customer response.

id class-attribute instance-attribute

id: str | None = None

Customer id.

DeleteCustomersRequest

Bases: IikoModel

Delete customers request.

customer_ids instance-attribute

customer_ids: list[str]

Customer IDs for logical deletion.

organization_id instance-attribute

organization_id: str

Organization id.

DeleteCustomersResponse

Bases: IikoModel

Delete customers response.

deleted class-attribute instance-attribute

deleted: int | None = None

Number of deleted customers.

not_found class-attribute instance-attribute

not_found: int | None = None

Number of not found customers.

total class-attribute instance-attribute

total: int | None = None

Number of unique customer IDs.

DeleteMagnetCardRequest

Bases: IikoModel

Delete magnet card request.

card_track instance-attribute

card_track: str

Card track. Can be null.

customer_id instance-attribute

customer_id: str

Customer id.

organization_id instance-attribute

organization_id: str

Organization id.

DeleteMagnetCardResponse

Bases: IikoModel

Delete magnet card response.

DiscountOperation

Bases: IikoModel

Discount operation.

amount class-attribute instance-attribute

amount: Decimal | None = None

Amount.

code class-attribute instance-attribute

code: OperationCode | None = None

Operation Type Code.

0 - fixed discount for the entire order, 1 - fixed discount for the item, 2 - free product, 3 - other type of discounts.

comment class-attribute instance-attribute

comment: str | None = None

Comment. Can be null.

discount_sum class-attribute instance-attribute

discount_sum: Decimal | None = None

Discount sum.

order_item_id class-attribute instance-attribute

order_item_id: str | None = None

Deprecated, use positionId.

position_id class-attribute instance-attribute

position_id: str | None = None

Id of item the discount is applied to. If null - discount applied to whole orders.

FreeProduct

Bases: IikoModel

Free item to be added to order.

code class-attribute instance-attribute

code: str | None = None

Code of product. Can be null.

id class-attribute instance-attribute

id: str | None = None

Id of product.

size class-attribute instance-attribute

size: list[str] | None = None

Sizes available for that product.

sizes class-attribute instance-attribute

sizes: list[FreeProductSize] | None = None

Sizes with IDs available for that product.

FreeProductSize

Bases: IikoModel

Free item size info.

id class-attribute instance-attribute

id: str | None = None

Id of size.

name class-attribute instance-attribute

name: str | None = None

Name. Can be null.

FreeProductsGroup

Bases: IikoModel

Free item to be added to order.

description_for_user class-attribute instance-attribute

description_for_user: str | None = None

Description for user. Can be null.

products class-attribute instance-attribute

products: list[FreeProduct] | None = None

Products that should be added to order.

source_action_id class-attribute instance-attribute

source_action_id: str | None = None

Id of action that caused the suggestion.

GetByOrganizationIdRequest

Bases: IikoModel

Get request only by organization id

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization id.

GetCategoriesRequest

Bases: IikoModel

Get categories request.

organization_id instance-attribute

organization_id: str

Organization id.

GetCategoriesResponse

Bases: IikoModel

Get categories response.

guest_categories class-attribute instance-attribute

guest_categories: list[GuestCategoryShortInfo] | None = None

Guest categories for organization.

GetCountersRequest

Bases: IikoModel

Get counters request.

guest_ids class-attribute instance-attribute

guest_ids: list[str] | None = None

Guest ids.

metrics class-attribute instance-attribute

metrics: list[CounterMetric] | None = None

Metrics.

organization_id instance-attribute

organization_id: str

Organization id.

periods class-attribute instance-attribute

periods: list[CounterPeriod] | None = None

Periods.

GetCountersResponse

Bases: IikoModel

Get counters response.

counters class-attribute instance-attribute

counters: list[GuestCounter] | None = None

Counters.

GetCustomerInfoByCardNumberRequest

Bases: GetCustomerInfoRequestBase

Request to get customer by card number.

card_number class-attribute instance-attribute

card_number: str | None = None

Customer card number.

GetCustomerInfoByCardTrackRequest

Bases: GetCustomerInfoRequestBase

Request to get customer by card track.

card_track class-attribute instance-attribute

card_track: str | None = None

Customer card track.

GetCustomerInfoByEmailRequest

Bases: GetCustomerInfoRequestBase

Request to get customer by email.

email class-attribute instance-attribute

email: str | None = None

Customer email.

GetCustomerInfoByIdRequest

Bases: GetCustomerInfoRequestBase

Request to get customer by Id.

id class-attribute instance-attribute

id: str | None = None

Customer id.

GetCustomerInfoByPhoneRequest

Bases: GetCustomerInfoRequestBase

Request to get customer by phone number.

phone class-attribute instance-attribute

phone: str | None = None

Customer phone number.

GetCustomerInfoRequestBase

Bases: IikoModel

Base class for customer info request.

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization id.

GetCustomerInfoResponse

Bases: IikoModel

Get customer info response.

anonymized class-attribute instance-attribute

anonymized: bool | None = None

Guest anonymized.

birthday class-attribute instance-attribute

birthday: IikoDateTime | None = None

Guest birthday.

cards class-attribute instance-attribute

cards: list[GuestCardInfo] | None = None

Customer's cards.

categories class-attribute instance-attribute

categories: list[GuestCategoryShortInfo] | None = None

Customer categories.

comment class-attribute instance-attribute

comment: str | None = None

Guest comment. Can be null.

consent_status class-attribute instance-attribute

consent_status: PersonalDataConsentStatus | None = None

Guest consent status.

0 - unknown, 1 - given, 2 - revoked.

culture_name class-attribute instance-attribute

culture_name: str | None = None

Guest culture name. Can be null.

email class-attribute instance-attribute

email: str | None = None

Guest email. Can be null.

first_order_date class-attribute instance-attribute

first_order_date: IikoDateTime | None = None

First order date.

id class-attribute instance-attribute

id: str | None = None

Guest id.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

Customer marked as deleted.

last_processed_order_date class-attribute instance-attribute

last_processed_order_date: IikoDateTime | None = None

Last order date.

last_visited_organization_id class-attribute instance-attribute

last_visited_organization_id: str | None = None

Guest last visited organization id.

middle_name class-attribute instance-attribute

middle_name: str | None = None

Guest middle name. Can be null.

name class-attribute instance-attribute

name: str | None = None

Guest name. Can be null.

personal_data_consent_from class-attribute instance-attribute

personal_data_consent_from: IikoDateTime | None = None

Guest personal data consent from.

personal_data_consent_to class-attribute instance-attribute

personal_data_consent_to: IikoDateTime | None = None

Guest personal data consent to.

personal_data_processing_from class-attribute instance-attribute

personal_data_processing_from: IikoDateTime | None = None

Guest personal data processing from.

personal_data_processing_to class-attribute instance-attribute

personal_data_processing_to: IikoDateTime | None = None

Guest personal data processing to.

phone class-attribute instance-attribute

phone: str | None = None

Main customer's phone. Can be null.

referrer_id class-attribute instance-attribute

referrer_id: str | None = None

Guest referrer id.

registration_organization_id class-attribute instance-attribute

registration_organization_id: str | None = None

Guest registration organization id.

sex class-attribute instance-attribute

sex: IikoNetUserSex | None = None

Sex.

0 - not specified, 1 - male, 2 - female.

should_receive_loyalty_info class-attribute instance-attribute

should_receive_loyalty_info: bool | None = None

Guest should receive loyalty info.

should_receive_order_status_info class-attribute instance-attribute

should_receive_order_status_info: bool | None = None

Guest should receive order status info.

should_receive_promo_actions_info class-attribute instance-attribute

should_receive_promo_actions_info: bool | None = None

Customer get promo messages (email, sms). If null - unknown.

surname class-attribute instance-attribute

surname: str | None = None

Guest surname. Can be null.

user_data class-attribute instance-attribute

user_data: str | None = None

Technical user data, customizable by restaurateur. Can be null.

wallet_balances class-attribute instance-attribute

wallet_balances: list[GuestBalanceInfo] | None = None

Customer's user wallets. Contains bonus balances of different loyalty programs.

when_registered class-attribute instance-attribute

when_registered: IikoDateTime | None = None

Registration date.

GetManualConditionsResponse

Bases: IikoModel

Get manual conditions response.

manual_conditions class-attribute instance-attribute

manual_conditions: list[ManualConditionInfo] | None = None

Info about manual conditions.

GetProgramsRequest

Bases: IikoModel

Get programs request.

organization_id instance-attribute

organization_id: str

Organization id.

without_marketing_campaigns class-attribute instance-attribute

without_marketing_campaigns: bool | None = None

Determines if marketing campaigns not required.

GetProgramsResponse

Bases: IikoModel

Get programs response.

programs class-attribute instance-attribute

programs: list[LoyaltyProgram] | None = Field(
    default=None, alias="Programs"
)

Programs.

GetTransactionsReportByPeriodRequest

Bases: IikoModel

Report request.

customer_id instance-attribute

customer_id: str

Customer id.

date_from instance-attribute

date_from: IikoDateTime

Report since date in UTC. Included.

date_to instance-attribute

date_to: IikoDateTime

Report till date in UTC. Included.

organization_id instance-attribute

organization_id: str

Organization id.

page_number instance-attribute

page_number: int

Page number. Zero based. Previous pages will be skipped.

page_size instance-attribute

page_size: int

Page size. Ignored if more than max page size on server.

GetTransactionsReportByPeriodResponse

Bases: IikoModel

Get transactions report by period response.

page_number class-attribute instance-attribute

page_number: int | None = None

Page number. Zero based.

page_size class-attribute instance-attribute

page_size: int | None = None

Page size.

transactions class-attribute instance-attribute

transactions: (
    list[TransportTransactionsReportItem] | None
) = None

Transactions.

GetTransactionsReportByRevisionRequest

Bases: IikoModel

Report request.

customer_id instance-attribute

customer_id: str

Customer id.

last_transaction_id class-attribute instance-attribute

last_transaction_id: str | None = None

Report since transaction. Excluded. Can't be used without revision..

organization_id instance-attribute

organization_id: str

Organization id.

page_size instance-attribute

page_size: int

Page size. Ignored if more than max size on server..

revision class-attribute instance-attribute

revision: int | None = None

Report since revision. Included if LastTransactionId set..

GetTransactionsReportByRevisionResponse

Bases: IikoModel

Get transactions report by revision response.

last_revision class-attribute instance-attribute

last_revision: int | None = None

Last known transaction revision.

last_transaction_id class-attribute instance-attribute

last_transaction_id: str | None = None

Last known transaction id.

page_size class-attribute instance-attribute

page_size: int | None = None

Page size.

transactions class-attribute instance-attribute

transactions: (
    list[TransportTransactionsReportItem] | None
) = None

Transactions.

GuestBalanceInfo

Bases: IikoModel

Information about guest balance.

balance class-attribute instance-attribute

balance: Decimal | None = None

Wallet balance.

id class-attribute instance-attribute

id: str | None = None

Wallet id.

name class-attribute instance-attribute

name: str | None = None

Wallet name.

type class-attribute instance-attribute

type: ProgramType | None = None

Wallet type.

0 - deposit or corporate nutrition, 1 - bonus program, 2 - products program, 3 - discount program, 4 - certificate program.

GuestCardInfo

Bases: IikoModel

Guest card info.

id class-attribute instance-attribute

id: str | None = None

Card id.

number class-attribute instance-attribute

number: str | None = None

Card number.

track class-attribute instance-attribute

track: str | None = None

Card track.

valid_to_date class-attribute instance-attribute

valid_to_date: IikoDateTime | None = None

Card valid to date.

GuestCategoryShortInfo

Bases: IikoModel

Guest category info.

id class-attribute instance-attribute

id: str | None = None

Category id.

is_active class-attribute instance-attribute

is_active: bool | None = None

Is category active or not.

is_default_for_new_guests class-attribute instance-attribute

is_default_for_new_guests: bool | None = None

Is category default for new guests or not.

name class-attribute instance-attribute

name: str | None = None

Category name.

GuestCounter

Bases: IikoModel

Guest counter.

guest_id class-attribute instance-attribute

guest_id: str | None = None

Guest id.

metric class-attribute instance-attribute

metric: CounterMetric | None = None

Metric.

period class-attribute instance-attribute

period: CounterPeriod | None = None

Period.

value class-attribute instance-attribute

value: Decimal | None = None

Value.

HoldMoneyRequest

Bases: IikoModel

Hold money request.

comment class-attribute instance-attribute

comment: str | None = None

Additional information about holding. Can be null.

customer_id instance-attribute

customer_id: str

Customer id.

organization_id instance-attribute

organization_id: str

Organization id.

sum instance-attribute

sum: Decimal

Sum.

transaction_id class-attribute instance-attribute

transaction_id: str | None = None

Predefined transaction id. Random if empty.

wallet_id instance-attribute

wallet_id: str

Wallet id.

HoldMoneyResponse

Bases: IikoModel

Hold money response.

transaction_id class-attribute instance-attribute

transaction_id: str | None = None

Holding money transaction id.

IikoNetUserSex

Bases: OpenIntEnum

IikoNetUserSex values.

FEMALE class-attribute instance-attribute

FEMALE = 2

Female.

MALE class-attribute instance-attribute

MALE = 1

Male.

NOT_SPECIFIED class-attribute instance-attribute

NOT_SPECIFIED = 0

Not specified.

LoyaltyDynamicDiscount

Bases: IikoModel

Manual discount.

manual_condition_id class-attribute instance-attribute

manual_condition_id: str | None = None

Manual discount condition identifier.

sum class-attribute instance-attribute

sum: Decimal | None = Field(default=None, alias='Sum')

Discount amount.

LoyaltyProgram

Bases: IikoModel

Loyalty program.

applied_organizations class-attribute instance-attribute

applied_organizations: list[str] | None = None

Program applied organizations.

description class-attribute instance-attribute

description: str | None = None

Program description. Can be null.

id class-attribute instance-attribute

id: str | None = None

Program id.

is_active class-attribute instance-attribute

is_active: bool | None = None

Program is active.

is_exchange_rate_enabled class-attribute instance-attribute

is_exchange_rate_enabled: bool | None = None

Exchange rate for bonuses and real currency.

marketing_campaigns class-attribute instance-attribute

marketing_campaigns: list[MarketingCampaignInfo] | None = (
    None
)

Program marketing campaigns.

name class-attribute instance-attribute

name: str | None = None

Program name. Can be null.

notify_about_balance_changes class-attribute instance-attribute

notify_about_balance_changes: bool | None = None

Notify customer when balance has changed (sms/push).

program_type class-attribute instance-attribute

program_type: ProgramType | None = None

Program type.

0 - deposit or corporate nutrition, 1 - bonus program, 2 - products program, 3 - discount program, 4 - certificate program.

refill_type class-attribute instance-attribute

refill_type: RefillType | None = None

Refill type with payment.

service_from class-attribute instance-attribute

service_from: IikoDateTime | None = None

Program works since date.

service_to class-attribute instance-attribute

service_to: IikoDateTime | None = None

Program works till date.

template_type class-attribute instance-attribute

template_type: TemplateType | None = None

Program template type.

0 - None, 1 - BonusProgram, 2 - DiscountProgram, 3 - NthDishProgram, 4 - ManualOrderAnonymousDiscount, 5 - AutoOrderAnonymousDiscount, 6 - AutoDishAnonymousDiscount, 7 - PromotionsProgram, 8 - NthDishPromotionsProgram.

wallet_id class-attribute instance-attribute

wallet_id: str | None = None

Wallet id. Program has only wallet that means global payment type for customers.

LoyaltyProgramResult

Bases: IikoModel

Loyalty result for order.

available_combo_specifications class-attribute instance-attribute

available_combo_specifications: list[str] | None = None

Ids of combo specification available in current order.

available_combos class-attribute instance-attribute

available_combos: list[AvailableCombo] | None = None

Partially added combos, available for assembly.

discounts class-attribute instance-attribute

discounts: list[DiscountOperation] | None = None

Discount operations applied to order items.

free_products class-attribute instance-attribute

free_products: list[FreeProductsGroup] | None = None

Program free products.

marketing_campaign_id class-attribute instance-attribute

marketing_campaign_id: str | None = None

Program marketing campaign id.

name class-attribute instance-attribute

name: str | None = None

Program name.

need_to_activate_certificate class-attribute instance-attribute

need_to_activate_certificate: bool | None = None

Certificate number is required for activation.

upsales class-attribute instance-attribute

upsales: list[Upsale] | None = None

Suggested items to add or advices for customer.

ManualConditionInfo

Bases: IikoModel

Manual condition.

caption class-attribute instance-attribute

caption: str | None = None

Name of manual condition.

id class-attribute instance-attribute

id: str | None = None

Id.

is_applicable_on_cashier_screen class-attribute instance-attribute

is_applicable_on_cashier_screen: bool | None = None

Flag of applicability on the cashier screen..

is_dynamic_discount class-attribute instance-attribute

is_dynamic_discount: bool | None = None

Arbitrary discount attribute.

MarketingCampaignActionConditionBindingInfo

Bases: IikoModel

Marketing campaign binding info.

actions class-attribute instance-attribute

actions: list[MarketingCampaignSettingsInfo] | None = None

Marketing actions.

conditions class-attribute instance-attribute

conditions: list[MarketingCampaignSettingsInfo] | None = (
    None
)

Marketing conditions.

id class-attribute instance-attribute

id: str | None = None

Id.

stop_further_execution class-attribute instance-attribute

stop_further_execution: bool | None = None

Loyalty processing stop after successful execution of binding. So means order of bindings affects.

MarketingCampaignInfo

Bases: IikoModel

Marketing campaign info.

description class-attribute instance-attribute

description: str | None = None

Marketing campaign description. Can be null.

guest_registration_action_condition_bindings class-attribute instance-attribute

guest_registration_action_condition_bindings: (
    list[MarketingCampaignActionConditionBindingInfo] | None
) = None

Conditions and actions that will be checked by guest registration.

id class-attribute instance-attribute

id: str | None = None

Marketing campaign id.

is_active class-attribute instance-attribute

is_active: bool | None = None

Marketing campaign is active.

name class-attribute instance-attribute

name: str | None = None

Loyalty program name. Can be null.

order_action_condition_bindings class-attribute instance-attribute

order_action_condition_bindings: (
    list[MarketingCampaignActionConditionBindingInfo] | None
) = None

Conditions and actions that will be checked when order is processed.

overdraft_action_condition_bindings class-attribute instance-attribute

overdraft_action_condition_bindings: (
    list[MarketingCampaignActionConditionBindingInfo] | None
) = None

Conditions and actions that will be checked by overdraft.

period_from class-attribute instance-attribute

period_from: IikoDateTime | None = None

Marketing campaign works since date.

period_to class-attribute instance-attribute

period_to: IikoDateTime | None = None

Marketing campaign works till date. Null means limitless.

periodic_action_condition_bindings class-attribute instance-attribute

periodic_action_condition_bindings: (
    list[MarketingCampaignActionConditionBindingInfo] | None
) = None

Conditions and actions that will be checked by schedule.

program_id class-attribute instance-attribute

program_id: str | None = None

Loyalty program id.

MarketingCampaignSettingsInfo

Bases: IikoModel

Marketing campaign settings info.

check_sum class-attribute instance-attribute

check_sum: str | None = None

Hash value of checksum. Can be null.

id class-attribute instance-attribute

id: str | None = None

Id.

settings class-attribute instance-attribute

settings: str | None = None

Action/condition settings. Stored as Json. Can be null.

type_name class-attribute instance-attribute

type_name: str | None = None

Action/condition type name. Can be null.

NotActivatedCoupon

Bases: IikoModel

Not activated coupon.

id class-attribute instance-attribute

id: str | None = None

Id.

number class-attribute instance-attribute

number: str | None = None

Number. Can be null.

series_id class-attribute instance-attribute

series_id: str | None = None

Series id.

series_name class-attribute instance-attribute

series_name: str | None = None

Series name. Can be null.

NotActivatedCouponRequest

Bases: IikoModel

Not activated coupon request.

organization_id instance-attribute

organization_id: str

Organization id.

page class-attribute instance-attribute

page: int | None = None

Page.

page_size class-attribute instance-attribute

page_size: int | None = None

Page size.

series instance-attribute

series: str

Series. Can be null.

NotActivatedCouponResponse

Bases: IikoModel

Not activated coupon response.

not_activated_coupon class-attribute instance-attribute

not_activated_coupon: list[NotActivatedCoupon] | None = None

Not activated coupon.

NotificationSendingCapabilityCheckStatus

Bases: OpenIntEnum

Notification sending capability check status.

OperationCode

Bases: OpenIntEnum

Operation's code.

FIXED_DISCOUNT_FOR_THE_ENTIRE_ORDER class-attribute instance-attribute

FIXED_DISCOUNT_FOR_THE_ENTIRE_ORDER = 0

Fixed discount for the entire order.

FIXED_DISCOUNT_FOR_THE_ITEM class-attribute instance-attribute

FIXED_DISCOUNT_FOR_THE_ITEM = 1

Fixed discount for the item.

FREE_PRODUCT class-attribute instance-attribute

FREE_PRODUCT = 2

Free product.

OTHER_TYPE_OF_DISCOUNTS class-attribute instance-attribute

OTHER_TYPE_OF_DISCOUNTS = 3

Other type of discounts.

Order

Bases: IikoModel

Order.

cheque_additional_info class-attribute instance-attribute

cheque_additional_info: ChequeAdditionalInfo | None = None

Cheque additional information.

combos class-attribute instance-attribute

combos: list[Combo] | None = None

Combos included in order.

comment class-attribute instance-attribute

comment: str | None = None

Order comment.

complete_before class-attribute instance-attribute

complete_before: IikoDateTime | None = None

Order fulfillment date. Date and time must be local for delivery terminal, without time zone (take a look at example). If null, order is urgent and time is calculated based on customer settings, i.e. the shortest delivery time possible. Permissible values: from current day and 60 days on.

customer class-attribute instance-attribute

customer: Customer | None = None

Customer.

'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

'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

delivery_duration class-attribute instance-attribute

delivery_duration: int | None = None

Delivery duration.

Allowed from version 8.8.6.

delivery_point class-attribute instance-attribute

delivery_point: DeliveryPoint | None = None

Delivery point details. Not required in case of customer pickup. Otherwise, required.

delivery_zone class-attribute instance-attribute

delivery_zone: str | None = None

Name of delivery zone.

Allowed from version 8.8.6.

discounts_info class-attribute instance-attribute

discounts_info: DiscountsInfo | None = None

Discounts/surcharges.

external_data class-attribute instance-attribute

external_data: list[ExternalData] | None = None

Order external data.

Allowed from version 8.0.6.

external_number class-attribute instance-attribute

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

Order external number.

Allowed from version 8.0.6.

guests class-attribute instance-attribute

guests: Guests | None = None

Guest details. Not equal to the customer who makes an order.

id class-attribute instance-attribute

id: str | None = None

Order ID. Must be unique. If sent null, it generates automatically on iikoTransport side.

items instance-attribute

items: list[OrderItem]

Order items.

loyalty_info class-attribute instance-attribute

loyalty_info: LoyaltyInfo | None = None

Information about Loyalty app.

marketing_source_id class-attribute instance-attribute

marketing_source_id: str | None = None

Marketing source (advertisement) ID.

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

operator_id class-attribute instance-attribute

operator_id: str | None = None

Operator ID.

Allowed from version 7.6.3.

order_service_type class-attribute instance-attribute

order_service_type: DeliveryServiceType | None = None

Order service type. Only one of the fields must be defined: orderTypeId or orderServiceType.

Allowed from version 7.0.3.

order_type_id class-attribute instance-attribute

order_type_id: str | None = None

Order type ID.

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

Only one of the fields must be defined: orderTypeId or orderServiceType.

payments class-attribute instance-attribute

payments: list[Payment] | None = None

Order payment components.

Type LoyaltyCard allowed from version 7.1.5.

phone class-attribute instance-attribute

phone: str = Field(min_length=8, max_length=40)

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

phone_extension class-attribute instance-attribute

phone_extension: str | None = Field(
    default=None, min_length=1, max_length=10
)

Extension telephone number. Must contain only digits and have length from 1 to 10 symbols.

Allowed from version 9.2.5.

price_category_id class-attribute instance-attribute

price_category_id: str | None = None

Price category id of the order.

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

Allowed from version 9.0.5.

source_key class-attribute instance-attribute

source_key: str | None = None

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

tips class-attribute instance-attribute

tips: list[TipsPayment] | None = None

Order tips components.

PersonalDataConsentStatus

Bases: OpenIntEnum

PersonalDataConsentStatus values.

GIVEN class-attribute instance-attribute

GIVEN = 1

Given.

REVOKED class-attribute instance-attribute

REVOKED = 2

Revoked.

UNKNOWN class-attribute instance-attribute

UNKNOWN = 0

Unknown.

ProgramType

Bases: OpenIntEnum

Corporate program type.

BONUS_PROGRAM class-attribute instance-attribute

BONUS_PROGRAM = 1

Bonus program.

CERTIFICATE_PROGRAM class-attribute instance-attribute

CERTIFICATE_PROGRAM = 4

Certificate program.

DEPOSIT_OR_CORPORATE_NUTRITION class-attribute instance-attribute

DEPOSIT_OR_CORPORATE_NUTRITION = 0

Deposit or corporate nutrition.

DISCOUNT_PROGRAM class-attribute instance-attribute

DISCOUNT_PROGRAM = 3

Discount program.

PRODUCTS_PROGRAM class-attribute instance-attribute

PRODUCTS_PROGRAM = 2

Products program.

RefillType

Bases: OpenIntEnum

RefillType values.

RefillUserBalanceResponse

Bases: IikoModel

Refill user balance response.

RestoreCustomersRequest

Bases: IikoModel

Restore customers request.

customer_ids instance-attribute

customer_ids: list[str]

Customer IDs to recover.

organization_id instance-attribute

organization_id: str

Organization id.

RestoreCustomersResponse

Bases: IikoModel

Restore customers response.

not_found class-attribute instance-attribute

not_found: int | None = None

Number of not found customers.

restored class-attribute instance-attribute

restored: int | None = None

Number of restored customers.

total class-attribute instance-attribute

total: int | None = None

Number of unique customer IDs.

SendEmailRequest

Bases: IikoModel

Send email request.

body instance-attribute

body: str

Message body. Can be null.

organization_id instance-attribute

organization_id: str

Organization id.

receiver instance-attribute

receiver: str

Email address. Can be null.

subject instance-attribute

subject: str

Message subject. Can be null.

SendEmailResponse

Bases: IikoModel

Send email response.

SendSmsRequest

Bases: IikoModel

Send sms request.

organization_id instance-attribute

organization_id: str

Organization id.

phone instance-attribute

phone: str

Customer's phone number. Can be null.

text instance-attribute

text: str

Message text. Can be null.

SendSmsResponse

Bases: IikoModel

Send sms response.

sms_id class-attribute instance-attribute

sms_id: str | None = None

Sms id.

SeriesWithNotActivatedCoupons

Bases: IikoModel

Series with not activated coupons.

id class-attribute instance-attribute

id: str | None = None

Id.

number class-attribute instance-attribute

number: str | None = None

Number. Can be null.

SeriesWithNotActivatedCouponsRequest

Bases: IikoModel

Series with not activated coupons request.

organization_id instance-attribute

organization_id: str

Organization id.

SeriesWithNotActivatedCouponsResponse

Bases: IikoModel

Series with not activated coupons response.

series_with_not_activated_coupons class-attribute instance-attribute

series_with_not_activated_coupons: (
    list[SeriesWithNotActivatedCoupons] | None
) = None

Series with not activated coupons.

SmsSendingPossibilityRequest

Bases: IikoModel

Sms sending possibility request.

organization_id instance-attribute

organization_id: str

Organization id.

SmsSendingPossibilityResponse

Bases: IikoModel

Sms sending possibility response.

available_sms_count class-attribute instance-attribute

available_sms_count: int | None = None

Available sms count.

status class-attribute instance-attribute

status: NotificationSendingCapabilityCheckStatus | None = (
    None
)

Notification sending capability check status.

SmsSendingStatus

Bases: OpenIntEnum

SMS sending status.

SmsSendingStatusInfo

Bases: IikoModel

Sms sending status info.

internal_error class-attribute instance-attribute

internal_error: str | None = None

Sms sending internal error. Can be null.

sms_id instance-attribute

sms_id: str

Sms id.

status instance-attribute

status: SmsSendingStatus

Sms sending status.

TemplateType

Bases: OpenIntEnum

TemplateType values.

AUTO_DISH_ANONYMOUS_DISCOUNT class-attribute instance-attribute

AUTO_DISH_ANONYMOUS_DISCOUNT = 6

AutoDishAnonymousDiscount.

AUTO_ORDER_ANONYMOUS_DISCOUNT class-attribute instance-attribute

AUTO_ORDER_ANONYMOUS_DISCOUNT = 5

AutoOrderAnonymousDiscount.

BONUS_PROGRAM class-attribute instance-attribute

BONUS_PROGRAM = 1

BonusProgram.

DISCOUNT_PROGRAM class-attribute instance-attribute

DISCOUNT_PROGRAM = 2

DiscountProgram.

MANUAL_ORDER_ANONYMOUS_DISCOUNT class-attribute instance-attribute

MANUAL_ORDER_ANONYMOUS_DISCOUNT = 4

ManualOrderAnonymousDiscount.

NONE class-attribute instance-attribute

NONE = 0

None.

NTH_DISH_PROGRAM class-attribute instance-attribute

NTH_DISH_PROGRAM = 3

NthDishProgram.

NTH_DISH_PROMOTIONS_PROGRAM class-attribute instance-attribute

NTH_DISH_PROMOTIONS_PROGRAM = 8

NthDishPromotionsProgram.

PROMOTIONS_PROGRAM class-attribute instance-attribute

PROMOTIONS_PROGRAM = 7

PromotionsProgram.

TransactionType

Bases: OpenIntEnum

TransactionType values.

TransportTransactionsCertificateReportItem

Bases: IikoModel

Transactions report item.

number class-attribute instance-attribute

number: str | None = None

Number. Can be null.

series class-attribute instance-attribute

series: str | None = None

Series. Can be null.

status_name class-attribute instance-attribute

status_name: str | None = None

Status name. Can be null.

type_name class-attribute instance-attribute

type_name: str | None = None

Type name. Can be null.

TransportTransactionsCouponReportItem

Bases: IikoModel

Transactions report item.

number class-attribute instance-attribute

number: str | None = None

Number. Can be null.

series class-attribute instance-attribute

series: str | None = None

Series. Can be null.

TransportTransactionsReportItem

Bases: IikoModel

Transactions report item.

api_client_login class-attribute instance-attribute

api_client_login: str | None = None

Api client login. Can be null.

balance_after class-attribute instance-attribute

balance_after: Decimal | None = None

Balance after.

balance_before class-attribute instance-attribute

balance_before: Decimal | None = None

Balance before.

block_reason class-attribute instance-attribute

block_reason: str | None = None

Block reason. Can be null.

certificate class-attribute instance-attribute

certificate: (
    TransportTransactionsCertificateReportItem | None
) = None

Certificate.

comment class-attribute instance-attribute

comment: str | None = None

Comment. Can be null.

counteragent class-attribute instance-attribute

counteragent: str | None = None

Counteragent. Can be null.

counteragent_type class-attribute instance-attribute

counteragent_type: CertificateCounteragentType | None = None

Counteragent type.

counteragent_type_name class-attribute instance-attribute

counteragent_type_name: str | None = None

Counteragent type name. Can be null.

coupon class-attribute instance-attribute

coupon: TransportTransactionsCouponReportItem | None = None

Coupon.

emitent_name class-attribute instance-attribute

emitent_name: str | None = None

Emitent name. Can be null.

id instance-attribute

id: str

Id.

is_delivery class-attribute instance-attribute

is_delivery: bool | None = None

Is delivery.

is_ignored class-attribute instance-attribute

is_ignored: bool | None = None

Is ignored.

loyalty_user class-attribute instance-attribute

loyalty_user: str | None = None

Loyalty user. Can be null.

marketing_campaign_id class-attribute instance-attribute

marketing_campaign_id: str | None = None

Marketing campaign id.

nominal class-attribute instance-attribute

nominal: Decimal | None = None

Nominal.

order_number class-attribute instance-attribute

order_number: int | None = None

Order number.

order_sum class-attribute instance-attribute

order_sum: Decimal | None = None

Order sum.

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization id.

pos_balance_before class-attribute instance-attribute

pos_balance_before: Decimal | None = None

Pos balance before.

pos_order_id class-attribute instance-attribute

pos_order_id: str | None = None

Pos order id.

program_id class-attribute instance-attribute

program_id: str | None = None

Program id.

revision instance-attribute

revision: int

Revision.

sum class-attribute instance-attribute

sum: Decimal | None = None

Sum.

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Terminal group id.

type class-attribute instance-attribute

type: TransactionType | None = None

Type.

type_name class-attribute instance-attribute

type_name: str | None = None

Type name. Can be null.

wallet_id class-attribute instance-attribute

wallet_id: str | None = None

Wallet id.

when_created class-attribute instance-attribute

when_created: IikoDateTime | None = None

When created. In UTC.

when_created_order class-attribute instance-attribute

when_created_order: IikoDateTime | None = None

When created order. In UTC.

Upsale

Bases: IikoModel

user tip.

description_for_user class-attribute instance-attribute

description_for_user: str | None = None

Description for user.

product_codes class-attribute instance-attribute

product_codes: list[str] | None = None

Codes of products that suggested to be added to order.

products class-attribute instance-attribute

products: list[UpsaleProduct] | None = None

Products that suggested to be added to order.

source_action_id class-attribute instance-attribute

source_action_id: str | None = None

Id of action that caused the suggestion.

suggestion_text class-attribute instance-attribute

suggestion_text: str | None = None

Deprecated. Suggestion text.

UpsaleProduct

Bases: IikoModel

Product that suggested to be added to order.

code class-attribute instance-attribute

code: str | None = None

Code of product.

id class-attribute instance-attribute

id: str | None = None

Id of product.

WalletInfo

Bases: IikoModel

Wallet info.

can_hold_money class-attribute instance-attribute

can_hold_money: bool | None = None

Can hold money.

id class-attribute instance-attribute

id: str | None = None

Wallet id.

max_sum class-attribute instance-attribute

max_sum: Decimal | None = None

Max sum for payment from the wallet.

WithdrawUserBalanceResponse

Bases: IikoModel

Withdraw user balance response.