orders

Источник API: Доставка.json, Управлениезаказами.json, Управлениеостатками.json.

Enum

• DeliveryStatus
• LabelTaskStatus
• OrderStatus
• TrackingAvitoEventType
• TrackingAvitoStatus

Пакет orders.

DeliveryOrder dataclass

DeliveryOrder(
    transport: Transport, user_id: int | str | None = None
)

Bases: DomainObject

Доменный объект production API доставки.

create_announcement

create_announcement(
    *, order_id: str, idempotency_key: str | None = None
) -> DeliveryEntityResult

Выполняет публичную операцию DeliveryOrder.create_announcement и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

delete

delete(
    *, order_id: str, idempotency_key: str | None = None
) -> DeliveryEntityResult

Выполняет публичную операцию DeliveryOrder.delete и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create

create(
    *,
    order_id: str,
    parcel_id: str,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию DeliveryOrder.create и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

update_change_parcels

update_change_parcels(
    *,
    parcel_ids: Sequence[str],
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию DeliveryOrder.update_change_parcels и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_change_parcel_result

create_change_parcel_result(
    *,
    parcel_id: str,
    result: str,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию DeliveryOrder.create_change_parcel_result и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

DeliveryTask dataclass

DeliveryTask(
    transport: Transport,
    task_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект задачи доставки.

get

get(*, task_id: str | None = None) -> DeliveryTaskInfo

Выполняет публичную операцию DeliveryTask.get и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

Order dataclass

Order(
    transport: Transport, user_id: int | str | None = None
)

Bases: DomainObject

Доменный объект заказа.

list

list() -> OrdersResult

Выполняет публичную операцию Order.list и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

update_markings

update_markings(
    *,
    order_id: str,
    codes: Sequence[str],
    idempotency_key: str | None = None,
) -> OrderActionResult

Выполняет публичную операцию Order.update_markings и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

accept_return_order

accept_return_order(
    *,
    order_id: str,
    postal_office_id: str,
    idempotency_key: str | None = None,
) -> OrderActionResult

Выполняет публичную операцию Order.accept_return_order и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

apply

apply(
    *,
    order_id: str,
    transition: str,
    idempotency_key: str | None = None,
) -> OrderActionResult

Выполняет публичную операцию Order.apply и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

check_confirmation_code

check_confirmation_code(
    *,
    order_id: str,
    code: str,
    idempotency_key: str | None = None,
) -> OrderActionResult

Выполняет публичную операцию Order.check_confirmation_code и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

set_cnc_details

set_cnc_details(
    *,
    order_id: str,
    pickup_point_id: str,
    idempotency_key: str | None = None,
) -> OrderActionResult

Выполняет публичную операцию Order.set_cnc_details и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_courier_delivery_range

get_courier_delivery_range() -> CourierRangesResult

Выполняет публичную операцию Order.get_courier_delivery_range и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

set_courier_delivery_range

set_courier_delivery_range(
    *,
    order_id: str,
    interval_id: str,
    idempotency_key: str | None = None,
) -> OrderActionResult

Выполняет публичную операцию Order.set_courier_delivery_range и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

update_tracking_number

update_tracking_number(
    *,
    order_id: str,
    tracking_number: str,
    idempotency_key: str | None = None,
) -> OrderActionResult

Выполняет публичную операцию Order.update_tracking_number и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

OrderLabel dataclass

OrderLabel(
    transport: Transport,
    task_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект генерации и загрузки этикеток.

create

create(
    *,
    order_ids: Sequence[str],
    extended: bool = False,
    idempotency_key: str | None = None,
) -> LabelTaskResult

Выполняет публичную операцию OrderLabel.create и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

download

download(*, task_id: str | None = None) -> LabelPdfResult

Выполняет публичную операцию OrderLabel.download и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

SandboxDelivery dataclass

SandboxDelivery(
    transport: Transport, user_id: int | str | None = None
)

Bases: DomainObject

Доменный объект sandbox API доставки.

create_announcement

create_announcement(
    *, order_id: str, idempotency_key: str | None = None
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.create_announcement и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

track_announcement

track_announcement(
    *, order_id: str, idempotency_key: str | None = None
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.track_announcement и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

update_custom_area_schedule

update_custom_area_schedule(
    *,
    items: Sequence[CustomAreaScheduleEntry],
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.update_custom_area_schedule и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

cancel_parcel

cancel_parcel(
    *,
    parcel_id: str,
    actor: str,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.cancel_parcel и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

check_confirmation_code

check_confirmation_code(
    *,
    parcel_id: str,
    confirm_code: str,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.check_confirmation_code и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

set_order_properties

set_order_properties(
    *,
    order_id: str,
    properties: OrderDeliveryProperties,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.set_order_properties и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

set_order_real_address

set_order_real_address(
    *,
    order_id: str,
    address: RealAddress,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.set_order_real_address и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

tracking

tracking(
    *,
    order_id: str,
    avito_status: TrackingAvitoStatus | str,
    avito_event_type: TrackingAvitoEventType | str,
    provider_event_code: str,
    date: str,
    location: str,
    comment: str | None = None,
    options: DeliveryTrackingOptions | None = None,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.tracking и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

prohibit_order_acceptance

prohibit_order_acceptance(
    *, order_id: str, idempotency_key: str | None = None
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.prohibit_order_acceptance и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

list_sorting_center

list_sorting_center() -> DeliverySortingCentersResult

Выполняет публичную операцию SandboxDelivery.list_sorting_center и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

add_sorting_center

add_sorting_center(
    *,
    items: Sequence[SortingCenterUpload],
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.add_sorting_center и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

add_areas

add_areas(
    *,
    tariff_id: str,
    areas: Sequence[SandboxArea],
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.add_areas и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

add_tags_to_sorting_center

add_tags_to_sorting_center(
    *,
    tariff_id: str,
    items: Sequence[TaggedSortingCenter],
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.add_tags_to_sorting_center и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

add_terminals

add_terminals(
    *,
    tariff_id: str,
    items: Sequence[TerminalUpload],
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.add_terminals и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

update_terms

update_terms(
    *,
    tariff_id: str,
    items: Sequence[DeliveryTermsZone],
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.update_terms и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

add_tariff

add_tariff(
    *,
    name: str,
    delivery_provider_tariff_id: str,
    directions: Sequence[DeliveryDirection],
    tariff_zones: Sequence[DeliveryTariffZone],
    terms_zones: Sequence[DeliveryTermsZone],
    tariff_type: str | None = None,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.add_tariff и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_parcel

create_parcel(
    *,
    order_id: str,
    parcel_id: str,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.create_parcel и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

cancel_sandbox_announcement

cancel_sandbox_announcement(
    *,
    announcement_id: str,
    date: str,
    options: SandboxCancelAnnouncementOptions,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.cancel_sandbox_announcement и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

cancel_sandbox_parcel

cancel_sandbox_parcel(
    *,
    parcel_id: str,
    options: CancelSandboxParcelOptions | None = None,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.cancel_sandbox_parcel и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

change_sandbox_parcel

change_sandbox_parcel(
    *,
    type: str,
    parcel_id: str,
    application: ChangeParcelApplication | None = None,
    options: ChangeParcelOptions | None = None,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.change_sandbox_parcel и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_sandbox_announcement

create_sandbox_announcement(
    *,
    announcement_id: str,
    barcode: str,
    sender: SandboxAnnouncementParticipant,
    receiver: SandboxAnnouncementParticipant,
    announcement_type: str,
    date: str,
    packages: Sequence[SandboxAnnouncementPackage],
    options: SandboxCreateAnnouncementOptions,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.create_sandbox_announcement и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_sandbox_announcement_event

get_sandbox_announcement_event(
    *,
    announcement_id: str,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.get_sandbox_announcement_event и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_sandbox_change_parcel_info

get_sandbox_change_parcel_info(
    *,
    application_id: str,
    idempotency_key: str | None = None,
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.get_sandbox_change_parcel_info и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_sandbox_parcel_info

get_sandbox_parcel_info(
    *, parcel_id: str, idempotency_key: str | None = None
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.get_sandbox_parcel_info и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_sandbox_registered_parcel_id

get_sandbox_registered_parcel_id(
    *, order_id: str, idempotency_key: str | None = None
) -> DeliveryEntityResult

Выполняет публичную операцию SandboxDelivery.get_sandbox_registered_parcel_id и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

Stock dataclass

Stock(
    transport: Transport, user_id: int | str | None = None
)

Bases: DomainObject

Доменный объект управления остатками.

get

get(*, item_ids: Sequence[int]) -> StockInfoResult

Выполняет публичную операцию Stock.get и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

update

update(
    *,
    stocks: Sequence[StockUpdateEntry],
    idempotency_key: str | None = None,
) -> StockUpdateResult

Выполняет публичную операцию Stock.update и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

DeliveryStatus

Bases: str, Enum

Статус операции или задачи delivery API.

LabelTaskStatus

Bases: str, Enum

Статус задачи генерации этикеток.

OrderStatus

Bases: str, Enum

Статус заказа или операции над заказом.

TrackingAvitoEventType

Bases: str, Enum

Тип Avito-события для sandbox tracking.

TrackingAvitoStatus

Bases: str, Enum

Статус Avito для sandbox tracking-события.

AddSortingCentersRequest dataclass

AddSortingCentersRequest(items: list[SortingCenterUpload])

Запрос загрузки сортировочных центров.

AddTariffV2Request dataclass

AddTariffV2Request(
    name: str,
    delivery_provider_tariff_id: str,
    directions: list[DeliveryDirection],
    tariff_zones: list[DeliveryTariffZone],
    terms_zones: list[DeliveryTermsZone],
    tariff_type: str | None = None,
)

Запрос загрузки тарифа sandbox delivery API.

AddTerminalsRequest dataclass

AddTerminalsRequest(items: list[TerminalUpload])

Запрос загрузки терминалов.

CancelParcelRequest dataclass

CancelParcelRequest(parcel_id: str, actor: str)

Запрос отмены sandbox-посылки.

CancelSandboxParcelRequest dataclass

CancelSandboxParcelRequest(
    parcel_id: str,
    options: CancelSandboxParcelOptions | None = None,
)

Запрос отмены тестовой посылки.

ChangeParcelApplication dataclass

ChangeParcelApplication(
    kind: str | None = None,
    name: str | None = None,
    phones: list[str] | None = None,
)

Изменяемые данные по посылке.

ChangeParcelOptions dataclass

ChangeParcelOptions(change_parcel_url: str)

Опции создания заявки на изменение посылки.

ChangeParcelRequest dataclass

ChangeParcelRequest(
    type: str,
    parcel_id: str,
    application: ChangeParcelApplication | None = None,
    options: ChangeParcelOptions | None = None,
)

Запрос создания заявки на изменение тестовой посылки.

CourierRangesResult dataclass

CourierRangesResult(
    items: list[CourierRange], address: str | None = None
)

Bases: SerializableModel

Список доступных интервалов курьерской доставки.

CustomAreaScheduleEntry dataclass

CustomAreaScheduleEntry(
    provider_area_numbers: list[str],
    services: list[str],
    custom_schedule: list[DeliveryDateInterval],
    use_all_areas: bool | None = None,
)

Кастомное расписание для списка областей доставки.

CustomAreaScheduleRequest dataclass

CustomAreaScheduleRequest(
    items: list[CustomAreaScheduleEntry],
)

Запрос установки кастомного расписания областей.

DeliveryAddress dataclass

DeliveryAddress(
    country: str,
    region: str,
    locality: str,
    fias: str,
    zip_code: str,
    lat: float,
    lng: float,
    address_row: str | None = None,
    building: str | None = None,
    floor: int | None = None,
    house: str | None = None,
    housing: str | None = None,
    locality_type: str | None = None,
    porch: str | None = None,
    room: str | None = None,
    street: str | None = None,
    sub_region: str | None = None,
    sub_region_type: str | None = None,
)

Адрес сортировочного центра или терминала.

DeliveryAnnouncementRequest dataclass

DeliveryAnnouncementRequest(order_id: str)

Запрос создания или отмены анонса доставки.

DeliveryDateInterval dataclass

DeliveryDateInterval(date: str, intervals: list[str])

Интервалы доставки/забора для конкретной даты.

DeliveryDirection dataclass

DeliveryDirection(
    provider_direction_id: str,
    tag_from: str,
    tag_to: str,
    zones: list[DeliveryDirectionZone],
)

Направление доставки в тарифе.

DeliveryDirectionZone dataclass

DeliveryDirectionZone(
    tariff_zone_id: str | None = None,
    terms_zone_id: str | None = None,
    type: str | None = None,
)

Условия доставки внутри направления тарифа.

DeliveryEntityResult dataclass

DeliveryEntityResult(
    success: bool,
    task_id: str | None = None,
    order_id: str | None = None,
    parcel_id: str | None = None,
    status: DeliveryStatus | None = None,
    message: str | None = None,
)

Bases: SerializableModel

Результат операции delivery API.

DeliveryParcelIdsRequest dataclass

DeliveryParcelIdsRequest(parcel_ids: list[str])

Запрос пакетной операции по посылкам.

DeliveryParcelRequest dataclass

DeliveryParcelRequest(order_id: str, parcel_id: str)

Запрос создания посылки.

DeliveryParcelResultRequest dataclass

DeliveryParcelResultRequest(parcel_id: str, result: str)

Запрос передачи результата по посылке.

DeliveryRestriction dataclass

DeliveryRestriction(
    max_weight: int,
    max_dimensions: list[int],
    max_declared_cost: int,
    dimensional_factor: int | None = None,
    max_dimensional_weight: int | None = None,
)

Ограничения терминала или сортировочного центра.

DeliverySortingCentersResult dataclass

DeliverySortingCentersResult(
    items: list[DeliverySortingCenter],
)

Bases: SerializableModel

Список сортировочных центров доставки.

DeliveryTariffItem dataclass

DeliveryTariffItem(
    calculation_mechanic: str,
    chargeable_parameter: str,
    service_name: str,
    values: list[DeliveryTariffValue],
)

Модель расчета стоимости услуги в тарифной зоне.

DeliveryTariffValue dataclass

DeliveryTariffValue(
    cost: int | None = None,
    max_weight: int | None = None,
    dimensional_factor: int | None = None,
    max_declared_cost: int | None = None,
    percent: float | None = None,
    min_cost: int | None = None,
)

Значение внутри модели расчета тарифной зоны.

DeliveryTariffZone dataclass

DeliveryTariffZone(
    name: str,
    delivery_provider_zone_id: str,
    items: list[DeliveryTariffItem],
)

Тарифная зона доставки.

DeliveryTaskInfo dataclass

DeliveryTaskInfo(
    task_id: str | None,
    status: DeliveryStatus | None,
    error: str | None,
)

Bases: SerializableModel

Информация о задаче доставки.

DeliveryTerms dataclass

DeliveryTerms(
    cost: int | None = None,
    direct_control_date: str | None = None,
    receiver_terminal_code: str | None = None,
    return_control_date: str | None = None,
    sender_receive_terminal_code: str | None = None,
    tough_wrap: bool | None = None,
)

Параметры условий доставки заказа.

DeliveryTermsZone dataclass

DeliveryTermsZone(
    delivery_provider_zone_id: str | None = None,
    min_term: int | None = None,
    max_term: int | None = None,
    name: str | None = None,
)

Зона сроков доставки.

DeliveryTrackingOptions dataclass

DeliveryTrackingOptions(
    barcode: str | None = None,
    return_barcode: str | None = None,
    return_dispatch_number: str | None = None,
    return_tracking_number: str | None = None,
)

Дополнительные поля tracking-события.

DeliveryTrackingRequest dataclass

DeliveryTrackingRequest(
    order_id: str,
    avito_status: TrackingAvitoStatus | str,
    avito_event_type: TrackingAvitoEventType | str,
    provider_event_code: str,
    date: str,
    location: str,
    comment: str | None = None,
    options: DeliveryTrackingOptions | None = None,
)

Запрос передачи tracking-события sandbox-заказа.

GetChangeParcelInfoRequest dataclass

GetChangeParcelInfoRequest(application_id: str)

Запрос информации о заявке на изменение посылки.

GetRegisteredParcelIdRequest dataclass

GetRegisteredParcelIdRequest(order_id: str)

Запрос ID зарегистрированной тестовой посылки.

GetSandboxParcelInfoRequest dataclass

GetSandboxParcelInfoRequest(parcel_id: str)

Запрос информации о тестовой посылке.

LabelPdfResult dataclass

LabelPdfResult(binary: BinaryResponse)

PDF-этикетка заказа.

filename property

filename: str | None

Имя PDF-файла.

to_dict

to_dict() -> dict[str, object]

Сериализует бинарный результат без transport-объекта.

LabelTaskResult dataclass

LabelTaskResult(
    task_id: str | None,
    status: LabelTaskStatus | None = None,
)

Bases: SerializableModel

Результат генерации этикеток.

OrderAcceptReturnRequest dataclass

OrderAcceptReturnRequest(
    order_id: str, postal_office_id: str
)

Запрос подтверждения возврата заказа.

OrderActionResult dataclass

OrderActionResult(
    success: bool,
    order_id: str | None = None,
    status: OrderStatus | None = None,
    message: str | None = None,
)

Bases: SerializableModel

Результат операции над заказом.

OrderApplyTransitionRequest dataclass

OrderApplyTransitionRequest(order_id: str, transition: str)

Запрос перехода заказа в другой статус.

OrderCncDetailsRequest dataclass

OrderCncDetailsRequest(order_id: str, pickup_point_id: str)

Запрос установки деталей cnc-заказа.

OrderConfirmationCodeRequest dataclass

OrderConfirmationCodeRequest(order_id: str, code: str)

Запрос проверки кода подтверждения заказа.

OrderCourierRangeRequest dataclass

OrderCourierRangeRequest(order_id: str, interval_id: str)

Запрос установки интервала курьерской доставки.

OrderDeliveryProperties dataclass

OrderDeliveryProperties(
    delivery: DeliveryTerms | None = None,
    dimensions: list[int] | None = None,
    weight: int | None = None,
)

Набор параметров доставки sandbox-заказа.

OrderLabelsRequest dataclass

OrderLabelsRequest(order_ids: list[str])

Запрос генерации этикеток.

OrderMarkingsRequest dataclass

OrderMarkingsRequest(order_id: str, codes: list[str])

Запрос обновления маркировок заказа.

OrdersResult dataclass

OrdersResult(
    items: list[OrderSummary], total: int | None = None
)

Bases: SerializableModel

Список заказов.

OrderTrackingNumberRequest dataclass

OrderTrackingNumberRequest(
    order_id: str, tracking_number: str
)

Запрос установки трек-номера.

ProhibitOrderAcceptanceRequest dataclass

ProhibitOrderAcceptanceRequest(order_id: str)

Запрос запрета приема sandbox-посылки.

RealAddress dataclass

RealAddress(address_type: str, terminal_number: str)

Фактический адрес приема или возврата.

SandboxAnnouncementDelivery dataclass

SandboxAnnouncementDelivery(
    type: str,
    terminal: SandboxDeliveryPoint | None = None,
    sorting_center: SandboxDeliveryPoint | None = None,
)

Логистическая точка участника тестового анонса.

SandboxAnnouncementPackage dataclass

SandboxAnnouncementPackage(
    package_id: str,
    parcel_ids: list[str],
    seal_id: str | None = None,
)

Грузоместо в тестовом анонсе.

SandboxAnnouncementParticipant dataclass

SandboxAnnouncementParticipant(
    type: str,
    phones: list[str],
    email: str,
    name: str,
    delivery: SandboxAnnouncementDelivery,
)

Участник тестового анонса.

SandboxArea dataclass

SandboxArea(city: str)

Зона sandbox-доставки.

SandboxAreasRequest dataclass

SandboxAreasRequest(areas: list[SandboxArea])

Запрос добавления зон sandbox-доставки.

SandboxCancelAnnouncementOptions dataclass

SandboxCancelAnnouncementOptions(
    url_to_cancel_announcement: str,
)

Опции отмены тестового анонса.

SandboxCancelAnnouncementRequest dataclass

SandboxCancelAnnouncementRequest(
    announcement_id: str,
    date: str,
    options: SandboxCancelAnnouncementOptions,
)

Запрос отмены тестового анонса.

SandboxConfirmationCodeRequest dataclass

SandboxConfirmationCodeRequest(
    parcel_id: str, confirm_code: str
)

Запрос проверки кода подтверждения sandbox-заказа.

SandboxCreateAnnouncementOptions dataclass

SandboxCreateAnnouncementOptions(
    url_to_send_announcement: str,
)

Опции создания тестового анонса.

SandboxCreateAnnouncementRequest dataclass

SandboxCreateAnnouncementRequest(
    announcement_id: str,
    barcode: str,
    sender: SandboxAnnouncementParticipant,
    receiver: SandboxAnnouncementParticipant,
    announcement_type: str,
    date: str,
    packages: list[SandboxAnnouncementPackage],
    options: SandboxCreateAnnouncementOptions,
)

Запрос создания тестового анонса.

SandboxDeliveryPoint dataclass

SandboxDeliveryPoint(
    provider: str,
    point_id: str | None = None,
    accuracy: str | None = None,
)

Точка отправки или приема в тестовом анонсе.

SandboxGetAnnouncementEventRequest dataclass

SandboxGetAnnouncementEventRequest(announcement_id: str)

Запрос последнего события тестового анонса.

SetOrderPropertiesRequest dataclass

SetOrderPropertiesRequest(
    order_id: str, properties: OrderDeliveryProperties
)

Запрос установки параметров доставки sandbox-заказа.

SetOrderRealAddressRequest dataclass

SetOrderRealAddressRequest(
    order_id: str, address: RealAddress
)

Запрос передачи фактического адреса sandbox-заказа.

StockInfoRequest dataclass

StockInfoRequest(item_ids: list[int])

Запрос текущих остатков.

StockInfoResult dataclass

StockInfoResult(items: list[StockInfo])

Bases: SerializableModel

Список текущих остатков.

StockUpdateEntry dataclass

StockUpdateEntry(item_id: int, quantity: int)

Остаток по одному объявлению.

StockUpdateRequest dataclass

StockUpdateRequest(stocks: list[StockUpdateEntry])

Запрос обновления остатков.

StockUpdateResult dataclass

StockUpdateResult(items: list[StockUpdateItem])

Bases: SerializableModel

Результат изменения остатков.

TaggedSortingCenter dataclass

TaggedSortingCenter(
    delivery_provider_id: str, direction_tag: str
)

Тэг для сортировочного центра.

TaggedSortingCentersRequest dataclass

TaggedSortingCentersRequest(
    items: list[TaggedSortingCenter],
)

Запрос установки тэгов сортировочным центрам.

TerminalUpload dataclass

TerminalUpload(
    delivery_provider_id: str,
    name: str,
    address: DeliveryAddress,
    phones: list[str],
    itinerary: str,
    photos: list[str],
    direction_tag: str,
    services: list[str],
    schedule: WeeklySchedule,
    restriction: DeliveryRestriction,
    display_name: str | None = None,
    options: list[str] | None = None,
    terminal_type: str | None = None,
)

Терминал для загрузки в sandbox delivery API.

UpdateTermsRequest dataclass

UpdateTermsRequest(items: list[DeliveryTermsZone])

Запрос обновления сроков по тарифу.

WeeklySchedule dataclass

WeeklySchedule(
    mon: list[str],
    tue: list[str],
    wed: list[str],
    thu: list[str],
    fri: list[str],
    sat: list[str],
    sun: list[str],
)

Недельное расписание работы.