Delivery models

Models of the delivery endpoints.

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

ChangeServiceTypeRequest module-attribute

ChangeServiceTypeRequest = Annotated[
    Annotated[
        ChangeServiceTypeDeliveryByCourier,
        Tag("DeliveryByCourier"),
    ]
    | Annotated[
        ChangeServiceTypeDeliveryByClient,
        Tag("DeliveryByClient"),
    ]
    | Annotated[ChangeServiceTypeRequestBase, Tag(UNKNOWN)],
    discriminator(
        "newServiceType",
        "new_service_type",
        ("DeliveryByCourier", "DeliveryByClient"),
    ),
]

Request for change order's delivery type.

One of ChangeServiceTypeDeliveryByCourier, ChangeServiceTypeDeliveryByClient, selected by new_service_type. Values unknown to this library are parsed as ChangeServiceTypeRequestBase.

ActionOnValidationRejection

Bases: OpenIntEnum

Actions on problems with auto-assignment.

AddOrderItemsRequest

Bases: IikoModel

Request for add order items.

combos class-attribute instance-attribute

combos: list[Combo] | None = None

Combos.

Allowed from version 7.6.1.

items instance-attribute

items: list[OrderItem]

Order items (may include ProductOrderItem or CompoundOrderItem).

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

AllowedItemWithDuration

Bases: IikoModel

Suitable terminal group with delivery duration and other parameters.

delivery_duration_in_minutes instance-attribute

delivery_duration_in_minutes: int

Delivery duration in minutes.

delivery_service_product_id class-attribute instance-attribute

delivery_service_product_id: str | None = None

Link to "delivery service payment".

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.

zone class-attribute instance-attribute

zone: str | None = None

Delivery zone name which this TerminalGroupId belongs to.

CancelDeliveryConfirmationRequest

Bases: IikoModel

Request for cancel delivery confirmation.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

CancelOrderRequest

Bases: IikoModel

Request for cancel the order.

cancel_cause_id class-attribute instance-attribute

cancel_cause_id: str | None = None

Cancel order dictionary item id.

Allowed from version 7.7.1.

cancel_comment class-attribute instance-attribute

cancel_comment: str | None = None

Comment to the delivery cancellation.

Allowed from version 8.7.6.

moved_order_id class-attribute instance-attribute

moved_order_id: str | None = None

Fill this field with id of the new order if current order has been moved to the new RMS/terminal group.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

removal_comment class-attribute instance-attribute

removal_comment: str | None = Field(
    default=None, min_length=0, max_length=255
)

Comment to the charge-off.

Allowed from version 8.7.6.

removal_type_id class-attribute instance-attribute

removal_type_id: str | None = None

Removal type (for delete printed order items).

Allowed from version 7.7.1.

user_id_for_writeoff class-attribute instance-attribute

user_id_for_writeoff: str | None = None

User for writeoff (for delete printed order items).

Allowed from version 7.7.1.

ChangeCompleteBeforeRequest

Bases: IikoModel

Request for change time when client wants the order to be delivered.

new_complete_before instance-attribute

new_complete_before: IikoDateTime

New time when client wants the order to be delivered (Local for delivery terminal).

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

ChangeDeliveryCommentRequest

Bases: IikoModel

Request for change delivery comment.

comment instance-attribute

comment: str

New delivery comment.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

ChangeDeliveryOperatorRequest

Bases: IikoModel

Request for assign/change the order operator.

operator_id instance-attribute

operator_id: str

Operator to assign the order to.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

ChangeDeliveryPointRequest

Bases: IikoModel

Request for change order's delivery point information.

new_delivery_point instance-attribute

new_delivery_point: DeliveryPoint

New address of delivery.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

ChangeDriverInfoRequest

Bases: IikoModel

Request for change driver info.

driver_id class-attribute instance-attribute

driver_id: str | None = None

Driver ID.

Can be obtained by /api/1/employees/couriers operation.

estimated_time class-attribute instance-attribute

estimated_time: IikoDateTime | None = None

Delivery estimated time.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

ChangeServiceTypeDeliveryByClient

Bases: ChangeServiceTypeRequestBase

Change order's delivery type to DeliveryByClient.

ChangeServiceTypeDeliveryByCourier

Bases: ChangeServiceTypeRequestBase

Change order's delivery type to DeliveryByCourier.

delivery_point instance-attribute

delivery_point: DeliveryPoint

Address of delivery.

ChangeServiceTypeRequestBase

Bases: IikoModel

Request for change order's delivery type.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

CitiesRequest

Bases: IikoModel

Organization request DTO.

include_deleted class-attribute instance-attribute

include_deleted: bool | None = None

Include deleted cities in response.

organization_ids instance-attribute

organization_ids: list[str]

IDs of organizations that require data return.

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

CitiesResponse

Bases: IikoModel

Service response with list of cities.

cities instance-attribute

cities: list[OrganizationItems[City]]

List of cities.

correlation_id instance-attribute

correlation_id: str

Operation ID.

City

Bases: IikoModel

City DTO.

additional_info class-attribute instance-attribute

additional_info: str | None = None

City additional information.

classifier_id class-attribute instance-attribute

classifier_id: str | None = None

ID in classifier, e.g., address database.

external_revision class-attribute instance-attribute

external_revision: int | None = None

External revision.

id instance-attribute

id: str

City ID in RMS.

is_deleted instance-attribute

is_deleted: bool

Is-Deleted attribute.

name instance-attribute

name: str

Name.

CloseDeliveryOrderRequest

Bases: IikoModel

Request for close table order.

delivery_date class-attribute instance-attribute

delivery_date: IikoDateTime | None = None

Actual delivery time. If empty local iikoFront time will used.

Allowed from version 8.0.6.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

CommitDraftRequest

Bases: IikoModel

Delivery order draft commitment request.

create_order_settings class-attribute instance-attribute

create_order_settings: CreateOrderSettings | None = None

Order creation parameters.

order_id instance-attribute

order_id: str

ID of the order.

organization_id instance-attribute

organization_id: str

Organization ID of the new order.

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

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Front group ID the order must be sent to.

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

ConfirmDeliveryRequest

Bases: IikoModel

Request for confirm delivery.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

CreateDraftRequest

Bases: IikoModel

Draft creation model.

order instance-attribute

order: DeliveryOrderDraft

Order item.

organization_id instance-attribute

organization_id: str

Organization ID of the new order.

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

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Front group ID the order must be sent to.

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

CreateOrSaveDraftResponse

Bases: IikoModel

Wrapping object (external) for a delivery order draft creation/update return.

correlation_id instance-attribute

correlation_id: str

Operation ID.

order_id instance-attribute

order_id: str

Order draft order ID.

CreateOrderRequest

Bases: IikoModel

Order creation model.

create_order_settings class-attribute instance-attribute

create_order_settings: CreateOrderSettings | None = None

Order creation parameters.

order instance-attribute

order: DeliveryOrder

Order.

organization_id instance-attribute

organization_id: str

Organization ID of the new order.

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

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Front group ID the order must be sent to.

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

CreateOrderSettings

Bases: IikoModel

Order creation options.

check_stop_list class-attribute instance-attribute

check_stop_list: bool | None = None

Flag indicating whether there's need to check order items in out-of-stock list.

Unable if terminalGroupId is null.

transport_to_front_timeout class-attribute instance-attribute

transport_to_front_timeout: int | None = None

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

DeleteDraftRequest

Bases: IikoModel

Delivery order draft deletion request.

order_id instance-attribute

order_id: str

ID of the order.

organization_id instance-attribute

organization_id: str

Organization ID.

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

DeliveryGeocodeServiceType

Bases: OpenIntEnum

Geocoding service.

DeliveryOrder

Bases: IikoModel

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

menu_id class-attribute instance-attribute

menu_id: str | None = None

External menu ID.

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.

DeliveryOrderDraft

Bases: IikoModel

Delivery order draft.

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 = None

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.

menu_id instance-attribute

menu_id: str

External menu ID.

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 instance-attribute

phone: str

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

phone_extension class-attribute instance-attribute

phone_extension: str | None = None

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.

DeliveryRestrictionItem

Bases: IikoModel

Item of delivery restrictions.

delivery_duration_in_minutes instance-attribute

delivery_duration_in_minutes: int

Delivery duration in delivery zone.

delivery_service_product_id class-attribute instance-attribute

delivery_service_product_id: str | None = None

Link to "delivery service payment".

from_ class-attribute instance-attribute

from_: int | None = Field(default=None, alias='from')

The time from which the point can process orders from the selected zone, in minutes from the beginning of the day.

min_sum class-attribute instance-attribute

min_sum: Decimal | None = None

The minimum order amount for a given point in a given time interval in this delivery zone.

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization ID.

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

priority instance-attribute

priority: int

Priority of point in delivery zone.

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Terminal group ID.

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

to class-attribute instance-attribute

to: int | None = None

The maximum time at which a point can carry an order to a given zone, in minutes from the beginning of the day.

week_map instance-attribute

week_map: int

Days of the week.

zone class-attribute instance-attribute

zone: str | None = None

Name of delivery zone from cartography.

DeliveryRestrictionRejectCode

Bases: OpenStrEnum

Delivery restrictions reject cause code.

DeliveryRestrictions

Bases: IikoModel

Delivery restrictions.

action_on_validation_rejection instance-attribute

action_on_validation_rejection: ActionOnValidationRejection

Action on problems with auto-assignment.

add_delivery_service_cost instance-attribute

add_delivery_service_cost: bool

Add shipping cost to order.

auto_assign_external_deliveries instance-attribute

auto_assign_external_deliveries: bool

Automatically assigned delivery method based on cartography.

default_delivery_duration_in_minutes instance-attribute

default_delivery_duration_in_minutes: int

General standard of delivery time.

default_delivery_service_product_id class-attribute instance-attribute

default_delivery_service_product_id: str | None = None

Link to "delivery service payment".

default_from class-attribute instance-attribute

default_from: int | None = None

The beginning of the interval of the total work time for all points and delivery zones, in minutes from the beginning of the day.

default_min_sum class-attribute instance-attribute

default_min_sum: Decimal | None = None

Total minimum order amount.

default_self_service_duration_in_minutes instance-attribute

default_self_service_duration_in_minutes: int

Default pickup time.

default_to class-attribute instance-attribute

default_to: int | None = None

End of the total work time interval for all points and delivery zones, in minutes from the beginning of the day.

delivery_geocode_service_type instance-attribute

delivery_geocode_service_type: DeliveryGeocodeServiceType

Geocoding service type.

delivery_regions_map_url class-attribute instance-attribute

delivery_regions_map_url: str | None = None

Link to the map of delivery service regions.

delivery_zones instance-attribute

delivery_zones: list[DeliveryZone]

Delivery zones.

external_assignation_service_url class-attribute instance-attribute

external_assignation_service_url: str | None = None

Address of external delivery distribution service.

front_trusts_call_center_check instance-attribute

front_trusts_call_center_check: bool

Indication whether or not to trust on the fronts the call center mapping restrictions from the call center if the composition of the order has not changed since the last check. If true, then trust.

organization_id instance-attribute

organization_id: str

Organization ID.

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

reject_on_geocoding_error instance-attribute

reject_on_geocoding_error: bool

Reject delivery if we could not geocode the address.

require_exact_address_for_geocoding instance-attribute

require_exact_address_for_geocoding: bool

Require an exact geocoding address.

restrictions instance-attribute

restrictions: list[DeliveryRestrictionItem]

Restrictions.

use_external_assignation_service instance-attribute

use_external_assignation_service: bool

Use external delivery distribution service.

use_same_delivery_duration instance-attribute

use_same_delivery_duration: bool

Indication that all delivery points in all delivery zones use common delivery time limits.

use_same_delivery_service_product instance-attribute

use_same_delivery_service_product: bool

Indication that the cost is the same for all points of delivery.

use_same_min_sum instance-attribute

use_same_min_sum: bool

Indication that all delivery points for all delivery zones use the total minimum order amount.

use_same_restrictions_on_all_week instance-attribute

use_same_restrictions_on_all_week: bool

Indication that all delivery points in all zones use the same schedule for all days of the week.

use_same_work_time_interval instance-attribute

use_same_work_time_interval: bool

Indication that all delivery points in all zones use common time limits.

zones_mode instance-attribute

zones_mode: DeliveryRestrictionsMode

Delivery restrictions mode.

DeliveryRestrictionsCoordinates

Bases: IikoModel

Coordinate details.

latitude instance-attribute

latitude: Decimal

Latitude.

longitude instance-attribute

longitude: Decimal

Longitude.

DeliveryRestrictionsMode

Bases: OpenIntEnum

Delivery restrictions mode.

DeliveryStatusForUpdate

Bases: OpenStrEnum

Delivery order statuses for update requests.

DeliveryZone

Bases: IikoModel

Delivery zone.

addresses instance-attribute

addresses: list[DeliveryZoneAddressBinding]

A set of addresses describing a polygon.

Available only for manual delivery zones.

coordinates instance-attribute

coordinates: list[DeliveryRestrictionsCoordinates]

A set of points describing a polygon.

name instance-attribute

name: str

Polygon name.

DeliveryZoneAddressBinding

Bases: IikoModel

Delivery zone polygon, defined by the combination of street, index and house numbers.

houses instance-attribute

houses: HousesRange

Range of house numbers in the delivery zone.

postcode instance-attribute

postcode: str

Postcode.

street_id instance-attribute

street_id: str

ID of the delivery zone's street.

FilterDraftsRequest

Bases: IikoModel

Request for the list of order drafts by several filters.

date_from class-attribute instance-attribute

date_from: IikoDateTime | None = None

Draft creation time (UTC). Lower limit.

date_to class-attribute instance-attribute

date_to: IikoDateTime | None = None

Draft creation time (UTC). Upper limit.

limit class-attribute instance-attribute

limit: int | None = None

Desirable size of result set (50 by default).

offset class-attribute instance-attribute

offset: int | None = None

Offset from the beginning of full result set for paging.

operator_ids class-attribute instance-attribute

operator_ids: list[str] | None = None

List of drafts operator IDs.

order_type_ids class-attribute instance-attribute

order_type_ids: list[str] | None = None

List of drafts order type IDs.

organization_ids instance-attribute

organization_ids: list[str]

Organization ID for which the order drafts search will be performed.

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

phone class-attribute instance-attribute

phone: str | None = None

Phone number.

search_text class-attribute instance-attribute

search_text: str | None = None

Value for search. Used for prefix search.

sort_direction class-attribute instance-attribute

sort_direction: SortDirection | None = None

Sorting direction.

sort_property class-attribute instance-attribute

sort_property: OrderDraftSortProperty | None = None

Sorting property.

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Delivery sources (DeliveryClub, PH and etc.)

terminal_group_ids class-attribute instance-attribute

terminal_group_ids: list[str] | None = None

List of terminal groups IDs.

FilterDraftsResponse

Bases: IikoModel

Wrapping object (external) for a delivery order drafts return.

correlation_id instance-attribute

correlation_id: str

Operation ID.

drafts instance-attribute

drafts: list[OrderDraft]

Order drafts list.

GetAllowedRestrictionsRequest

Bases: IikoModel

Request to identify suitable terminal groups.

delivery_address class-attribute instance-attribute

delivery_address: RestrictionsAddress | None = None

Delivery address.

delivery_date class-attribute instance-attribute

delivery_date: IikoDateTime | None = None

Delivery date (Local for delivery terminal).

delivery_sum class-attribute instance-attribute

delivery_sum: Decimal | None = None

Sum.

discount_sum class-attribute instance-attribute

discount_sum: Decimal | None = None

Discounts sum.

is_courier_delivery instance-attribute

is_courier_delivery: bool

Type of delivery service.

order_items class-attribute instance-attribute

order_items: list[RestrictionsOrderItem] | None = None

Order list.

order_location class-attribute instance-attribute

order_location: OrderLocation | None = None

Order location.

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.

GetAllowedRestrictionsResponse

Bases: IikoModel

Response for a request to identify suitable terminal groups.

address_external_id class-attribute instance-attribute

address_external_id: str | None = None

Delivery address ID in external mapping system.

allowed_items instance-attribute

allowed_items: list[AllowedItemWithDuration]

Suitable terminal groups with a delivery duration for them.

correlation_id instance-attribute

correlation_id: str

Operation ID.

is_allowed instance-attribute

is_allowed: bool

A sign of successful verification.

location class-attribute instance-attribute

location: OrderLocation | None = None

Coordinates returned by geocoding service.

reject_cause class-attribute instance-attribute

reject_cause: str | None = None

Deprecated. Reject cause.

rejected_items instance-attribute

rejected_items: list[RejectItem]

Rejected items with cause.

GetDeliveryRestrictionsRequest

Bases: IikoModel

Request for delivery restrictions.

organization_ids instance-attribute

organization_ids: list[str]

Organizations IDs which delivery restrictions have to be returned.

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

GetDeliveryRestrictionsResponse

Bases: IikoModel

Response for delivery restrictions.

correlation_id instance-attribute

correlation_id: str

Operation ID.

delivery_restrictions instance-attribute

delivery_restrictions: list[DeliveryRestrictions]

Delivery restrictions.

GetDraftRequest

Bases: IikoModel

Request for an order draft by ID.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID for which the order search will be performed.

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

GetDraftResponse

Bases: IikoModel

Wrapping object (external) for an order draft.

correlation_id instance-attribute

correlation_id: str

Operation ID.

created_at instance-attribute

created_at: IikoDateTime

Draft creation time (UTC).

locked_at class-attribute instance-attribute

locked_at: IikoDateTime | None = None

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

locked_by_user class-attribute instance-attribute

locked_by_user: str | None = None

ID of the employee who is currently editing this draft.

order instance-attribute

order: DeliveryOrderDraft

Order draft object.

organization_id instance-attribute

organization_id: str

Organization ID.

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Terminal group ID.

HousesRange

Bases: IikoModel

Range of house numbers in the delivery zone. It can work in two modes: a) HousesRangeType.SpecificNumbers - list of house numbers. If the house is on this list - it is in the range b) Rest HousesRangeType. Defines a range of numbers from StartingNumber to MaxNumber. Since it is necessary to compare numbers - only supports numeric house numbers. Type determines the admissibility of even/odd numbers.

is_unlimited_range instance-attribute

is_unlimited_range: bool

Unlimited range.

max_number instance-attribute

max_number: int

Maximum house number.

specific_numbers instance-attribute

specific_numbers: list[str]

Specific numbers.

starting_number instance-attribute

starting_number: int

Starting house number.

type instance-attribute

type: HousesRangeType

Type of house number range.

HousesRangeType

Bases: OpenIntEnum

Type of house number range.

LockOrUnlockDraftRequest

Bases: IikoModel

Delivery order draft lock or unlock request.

employee_id instance-attribute

employee_id: str

ID of the employee.

order_id instance-attribute

order_id: str

ID of the order.

organization_id instance-attribute

organization_id: str

Organization ID.

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

MarketingSource

Bases: IikoModel

DTO for marketing source in iikoRMS.

attached_sources instance-attribute

attached_sources: list[str]

Attached marketing sources.

external_revision class-attribute instance-attribute

external_revision: int | None = None

External system revision number.

id instance-attribute

id: str

Marketing source ID.

is_deleted class-attribute instance-attribute

is_deleted: bool | None = None

IsDeleted attribute of marketing source.

name instance-attribute

name: str

Marketing source name.

organization_id instance-attribute

organization_id: str

Organization ID.

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

MarketingSourcesRequest

Bases: IikoModel

Request for marketing sources.

organization_ids instance-attribute

organization_ids: list[str]

Organizations IDs which marketing sources have to be returned.

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

MarketingSourcesResponse

Bases: IikoModel

Response to request for marketing sources by organization.

marketing_sources instance-attribute

marketing_sources: list[MarketingSource]

List of marketing sources.

OrderDraft

Bases: IikoModel

Order draft object.

created_at instance-attribute

created_at: IikoDateTime

Draft creation time (UTC).

id instance-attribute

id: str

Order ID.

locked_at class-attribute instance-attribute

locked_at: IikoDateTime | None = None

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

locked_by_user class-attribute instance-attribute

locked_by_user: str | None = None

ID of the employee, who is editing this draft.

order instance-attribute

order: DeliveryOrderDraft

Order.

organization_id instance-attribute

organization_id: str

Organization ID.

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

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Terminal group ID.

OrderDraftSortProperty

Bases: OpenStrEnum

OrderDraft sorting property.

OrderLocation

Bases: IikoModel

Order location.

latitude instance-attribute

latitude: Decimal

Latitude.

longitude instance-attribute

longitude: Decimal

Longitude.

OrderPaymentItem

Bases: IikoModel

Payments details.

is_processed_externally instance-attribute

is_processed_externally: bool

Payment item is processed by external payment system.

payment_type_id instance-attribute

payment_type_id: str

Payment type ID.

sum instance-attribute

sum: Decimal

Amount due

OrderResponse

Bases: IikoModel

Wrapping object (external) for a delivery order return.

correlation_id instance-attribute

correlation_id: str

Operation ID.

order_info instance-attribute

order_info: OrderInfo

Delivery order.

OrderSortProperty

Bases: OpenStrEnum

Order sorting property.

OrdersByDeliveryDateAndFilterRequest

Bases: IikoModel

Request for information about orders from external source and based on additional filters.

cooking_timeout class-attribute instance-attribute

cooking_timeout: int | None = None

Expected cooking time, in seconds.

delivery_date_from class-attribute instance-attribute

delivery_date_from: IikoDateTime | None = None

Order delivery date (Local for delivery terminal). Lower limit.

The guaranteed order availability period is the last 7 days. To access earlier orders, use the /api/1/deliveries/history/by_delivery_date_and_phone method.

delivery_date_to class-attribute instance-attribute

delivery_date_to: IikoDateTime | None = None

Order delivery date (Local for delivery terminal). Upper limit.

has_problem class-attribute instance-attribute

has_problem: bool | None = None

If true, delivery has a problem. Conditions under which the order has a problem: * order.problem.hasProblem is true; * order status is Unconfirmed and CookingStartTime before now; * order status is ReadyForCooking and (CookingStartTime + timeToCookingErrorTimeout) before now; * order status is CookingCompleted or Waiting and (CookingStartTime + cookingTimeout) before now.

order_ids class-attribute instance-attribute

order_ids: list[str] | None = None

Order IDs.

Must be null if "posOrderIds" is not null.

order_service_type class-attribute instance-attribute

order_service_type: DeliveryServiceType | None = None

Order service type.

organization_ids instance-attribute

organization_ids: list[str]

Organization ID for which an order search will be performed.

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

pos_order_ids class-attribute instance-attribute

pos_order_ids: list[str] | None = None

POS order IDs.

Must be null if "orderIds" is not null.

rows_count class-attribute instance-attribute

rows_count: int | None = None

Maximum number of items returned.

search_text class-attribute instance-attribute

search_text: str | None = None

Value for search. Used for prefix search.

sort_direction class-attribute instance-attribute

sort_direction: SortDirection | None = None

Sorting direction.

sort_property class-attribute instance-attribute

sort_property: OrderSortProperty | None = None

Sorting property.

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Source keys.

statuses class-attribute instance-attribute

statuses: list[DeliveryStatus] | None = None

Allowed order statuses.

terminal_group_ids class-attribute instance-attribute

terminal_group_ids: list[str] | None = None

List of terminal groups IDs.

time_to_cooking_error_timeout class-attribute instance-attribute

time_to_cooking_error_timeout: int | None = None

Error timeout for status time to cooking, in seconds.

OrdersByDeliveryDateAndPhoneRequest

Bases: IikoModel

Request for a list of orders by phone number.

delivery_date_from class-attribute instance-attribute

delivery_date_from: IikoDateTime | None = None

Order delivery date (Local for delivery terminal). Lower limit.

The guaranteed order availability period is the last 7 days. To access earlier orders, use the /api/1/deliveries/history/by_delivery_date_and_phone method.

delivery_date_to class-attribute instance-attribute

delivery_date_to: IikoDateTime | None = None

Order delivery date (Local for delivery terminal). Upper limit.

organization_ids instance-attribute

organization_ids: list[str]

Organization ID for which an order search will be performed.

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

phone class-attribute instance-attribute

phone: str | None = None

Delivery order phone number.

rows_count class-attribute instance-attribute

rows_count: int | None = None

Maximum number of items returned.

If null, all items will be returned.

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Source keys.

start_revision class-attribute instance-attribute

start_revision: int | None = None

Revision start number beginning from which (but not including) new/edited orders will be returned.

OrdersByDeliveryDateAndStatusRequest

Bases: IikoModel

Request for information about orders.

courier_ids class-attribute instance-attribute

courier_ids: list[str] | None = None

List of driver IDs.

delivery_date_from instance-attribute

delivery_date_from: IikoDateTime

Order delivery date (Local for delivery terminal). Lower limit.

The guaranteed order availability period is the last 7 days. To access earlier orders, use the /api/1/deliveries/history/by_delivery_date_and_phone method.

delivery_date_to class-attribute instance-attribute

delivery_date_to: IikoDateTime | None = None

Order delivery date (Local for delivery terminal). Upper limit.

organization_ids instance-attribute

organization_ids: list[str]

Organization ID for which an order search will be performed.

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

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Source keys.

statuses class-attribute instance-attribute

statuses: list[DeliveryStatus] | None = None

Allowed order statuses.

OrdersByIdRequest

Bases: IikoModel

Request for information about orders using IDs.

order_ids class-attribute instance-attribute

order_ids: list[str] | None = None

IDs of orders information on which is required.

Required if "posOrderIds" is null. Must be null if "posOrderIds" is not null.

Maximum allowed "orderIds" to request - 200.

The guaranteed order availability period is the last 7 days. To access earlier orders, use the /api/1/deliveries/history/by_delivery_date_and_phone method.

organization_id instance-attribute

organization_id: str

Organization ID for which an order search will be performed.

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

pos_order_ids class-attribute instance-attribute

pos_order_ids: list[str] | None = None

POS order IDs information on which is required.

Required if "orderIds" is null. Must be null if "orderIds" is not null.

Maximum allowed "posOrderIds" to request - 200.

The guaranteed order availability period is the last 7 days. To access earlier orders, use the /api/1/deliveries/history/by_delivery_date_and_phone method.

return_external_data_keys class-attribute instance-attribute

return_external_data_keys: list[str] | None = None

Keys for retrun external data information.

return_locked_by_user class-attribute instance-attribute

return_locked_by_user: bool | None = None

Whether to check and return LockedByUser property (see FullOrderUpdateRequest.EmployeeId).

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Source keys.

OrdersByOrganization

Bases: IikoModel

Orders grouped by organization.

orders instance-attribute

orders: list[OrderInfo]

List of orders by organization.

organization_id instance-attribute

organization_id: str

Organization ID.

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

OrdersByRevisionRequest

Bases: IikoModel

Request for a list of edited orders starting from specified revision number.

organization_ids instance-attribute

organization_ids: list[str]

Organization ID for which an order search will be performed.

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

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Source keys.

start_revision instance-attribute

start_revision: int

Revision start number beginning from which (but not including) new/edited orders will be returned.

Maximum revision offset to request - 3 hours.

OrdersHistoryByDeliveryDateAndPhoneRequest

Bases: IikoModel

Request for a list of historical orders by phone number.

delivery_date_from class-attribute instance-attribute

delivery_date_from: IikoDateTime | None = None

Order delivery date (Local for delivery terminal). Lower limit.

Order details are stored for 90 days.

delivery_date_to class-attribute instance-attribute

delivery_date_to: IikoDateTime | None = None

Order delivery date (Local for delivery terminal). Upper limit.

Order details are stored for 90 days.

organization_ids instance-attribute

organization_ids: list[str]

Organization ID for which an order search will be performed.

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

phone instance-attribute

phone: str

Delivery order phone number.

rows_count instance-attribute

rows_count: int

Maximum number of items returned.

Maximum numbers of items to request - 200.

source_keys class-attribute instance-attribute

source_keys: list[str] | None = None

Source keys.

start_revision class-attribute instance-attribute

start_revision: int | None = None

Revision start number beginning from which (but not including) orders will be returned.

Maximum revision offset to request - 3 hours.

OrdersResponse

Bases: IikoModel

Wrapping object (external) for return of delivery orders.

orders instance-attribute

orders: list[OrderInfo]

Orders.

OrdersWithRevisionResponse

Bases: IikoModel

Wrapping object (external) for return of delivery orders.

correlation_id instance-attribute

correlation_id: str

Operation ID.

max_revision instance-attribute

max_revision: int

Maximum revision value per all orders.

orders_by_organizations instance-attribute

orders_by_organizations: list[OrdersByOrganization]

Orders.

PrintBillRequest

Bases: IikoModel

Request to print bill.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

PrintDeliveryBillRequest

Bases: IikoModel

Request to print delivery bill.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

Region

Bases: IikoModel

Delivery district DTO.

external_revision class-attribute instance-attribute

external_revision: int | None = None

External revision.

id instance-attribute

id: str

Region ID in RMS.

is_deleted instance-attribute

is_deleted: bool

Is-Deleted attribute.

name instance-attribute

name: str

Name.

RegionsRequest

Bases: IikoModel

Organization request DTO.

organization_ids instance-attribute

organization_ids: list[str]

IDs of organizations that require data return.

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

RegionsResponse

Bases: IikoModel

Service response with list of districts.

correlation_id instance-attribute

correlation_id: str

Operation ID.

regions instance-attribute

regions: list[OrganizationItems[Region]]

List of districts.

RejectItem

Bases: IikoModel

Rejected item info.

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization ID.

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

reject_code instance-attribute

reject_code: DeliveryRestrictionRejectCode

Reject cause code.

reject_hint instance-attribute

reject_hint: str

Reject hint.

reject_item_data class-attribute instance-attribute

reject_item_data: RejectItemData | None = None

Reject additional information.

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Terminal group ID.

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

zone class-attribute instance-attribute

zone: str | None = None

Delivery zone name which this TerminalGroupId belongs to.

RejectItemData

Bases: IikoModel

Reject additional information.

allowed_week_days class-attribute instance-attribute

allowed_week_days: list[str] | None = None

Allowed week days.

date_from class-attribute instance-attribute

date_from: str | None = None

Point work time start.

date_to class-attribute instance-attribute

date_to: str | None = None

Point work time end.

min_sum class-attribute instance-attribute

min_sum: Decimal | None = None

Order min sum.

RestrictionsAddress

Bases: IikoModel

Address.

building class-attribute instance-attribute

building: str | None = None

Building.

city class-attribute instance-attribute

city: str | None = None

City.

entrance class-attribute instance-attribute

entrance: str | None = None

Entrance.

house class-attribute instance-attribute

house: str | None = None

House.

index class-attribute instance-attribute

index: str | None = None

Post index.

line1 class-attribute instance-attribute

line1: str | None = None

Address line 1. Contains the primary address information.

street_id class-attribute instance-attribute

street_id: str | None = None

Street ID.

street_name class-attribute instance-attribute

street_name: str | None = None

Street.

RestrictionsOrderItem

Bases: IikoModel

Order item.

amount instance-attribute

amount: Decimal

Amount.

id instance-attribute

id: str

Product ID.

modifiers class-attribute instance-attribute

modifiers: list[RestrictionsOrderItemModifier] | None = None

Modifiers (absolute amount).

product instance-attribute

product: str

Product.

RestrictionsOrderItemModifier

Bases: IikoModel

Order item modifier.

amount instance-attribute

amount: Decimal

Amount.

id instance-attribute

id: str

Product ID.

product class-attribute instance-attribute

product: str | None = None

Product.

SaveDraftRequest

Bases: IikoModel

Draft editing model.

employee_id instance-attribute

employee_id: str

ID of the employee who wants to update order draft.

order instance-attribute

order: DeliveryOrderDraft

Order item.

organization_id instance-attribute

organization_id: str

Organization ID of the new order.

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

terminal_group_id class-attribute instance-attribute

terminal_group_id: str | None = None

Front group ID the order must be sent to.

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

SortDirection

Bases: OpenStrEnum

Sorting direction.

Street

Bases: IikoModel

Street DTO in iikoRMS

classifier_id class-attribute instance-attribute

classifier_id: str | None = None

ID in classifier, e.g., address database.

external_revision class-attribute instance-attribute

external_revision: int | None = None

External system revision No.

id instance-attribute

id: str

ID.

is_deleted instance-attribute

is_deleted: bool

Is-Deleted attribute.

name instance-attribute

name: str

Name.

StreetById

Bases: IikoModel

Street by id response.

city_id instance-attribute

city_id: str

City id.

city_name instance-attribute

city_name: str

City name.

classifier_id class-attribute instance-attribute

classifier_id: str | None = None

Street classifierId.

id instance-attribute

id: str

Street id.

street_name instance-attribute

street_name: str

Street name.

StreetsByCityRequest

Bases: IikoModel

Organization and city request DTO.

city_id instance-attribute

city_id: str

City ID.

include_deleted class-attribute instance-attribute

include_deleted: bool | None = None

Include deleted streets in response.

organization_id instance-attribute

organization_id: str

Organization ID details of which have to be returned.

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

StreetsByIdRequest

Bases: IikoModel

Organization and city request DTO.

classifier_ids class-attribute instance-attribute

classifier_ids: list[str] | None = None

Street classifierIds.

ids class-attribute instance-attribute

ids: list[str] | None = None

Street Ids.

organization_id instance-attribute

organization_id: str

Organization Id.

StreetsByIdResponse

Bases: IikoModel

Streets by ids response.

correlation_id class-attribute instance-attribute

correlation_id: str | None = None

Operation ID.

streets class-attribute instance-attribute

streets: list[StreetById] | None = None

Found streets.

StreetsResponse

Bases: IikoModel

Service response with list of streets.

correlation_id instance-attribute

correlation_id: str

Operation ID.

streets instance-attribute

streets: list[Street]

List of streets.

UpdateDeliveryStatusRequest

Bases: IikoModel

Request for delivery status update.

delivery_date class-attribute instance-attribute

delivery_date: IikoDateTime | None = None

The date and time when the order was received by the guest (Local for delivery terminal).

delivery_status instance-attribute

delivery_status: DeliveryStatusForUpdate

Delivery status. Can be only switched between these three statuses.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

UpdateOrderCourierRequest

Bases: IikoModel

Request for order courier update.

employee_id instance-attribute

employee_id: str

Courier ID.

Can be obtained by /api/1/employees/couriers operation.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

UpdateOrderPaymentsRequest

Bases: IikoModel

Request for order payment update.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

payment_items class-attribute instance-attribute

payment_items: list[OrderPaymentItem] | None = None

Payment details.

UpdateOrderProblemRequest

Bases: IikoModel

Request for order problem update.

has_problem instance-attribute

has_problem: bool

Problem flag.

order_id instance-attribute

order_id: str

Order ID.

organization_id instance-attribute

organization_id: str

Organization ID.

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

problem class-attribute instance-attribute

problem: str | None = Field(
    default=None, min_length=0, max_length=1000
)

Problem text.

UpdateTrackingLinkRequest

Bases: IikoModel

Request to update tracking link of a delivery order.

order_id instance-attribute

order_id: str

Delivery order id.

organization_id instance-attribute

organization_id: str

OrganizationId.

tracking_link class-attribute instance-attribute

tracking_link: str | None = Field(
    default=None, min_length=0, max_length=512
)

Tracking link of a delivery order.