orders

Публичный доменный пакет SDK: orders.

Enum

• DeliveryOperationStatus
• DeliveryStatus
• DeliveryTaskState
• LabelTaskStatus
• OrderActionStatus
• OrderStatus
• OrderTransition

Bases: DomainObject

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

create_announcement

create_announcement(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Создает объявление доставки для заказа.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete

delete(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Удаляет сущность доставки заказа.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create

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

Создает сущность доставки заказа.

Аргументы

order_id: идентифицирует заказ. parcel_id: идентифицирует отправление. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_change_parcels

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

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

Аргументы

parcel_ids: передает идентификаторы отправлений. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

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

Аргументы

parcel_id: идентифицирует отправление. result: передает результат обработки изменения отправления. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

get

get(
    *,
    task_id: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryTaskInfo

Возвращает задач доставки.

Аргументы

task_id: идентифицирует асинхронную задачу. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryTaskInfo с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

list

list(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> OrdersResult

Возвращает список заказов.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrdersResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_markings

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

Обновляет коды маркировки заказа.

Аргументы

order_id: идентифицирует заказ. codes: передает коды маркировки заказа. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> OrderActionResult

Подтверждает return order для заказов.

Аргументы

order_id: идентифицирует заказ. postal_office_id: идентифицирует почтовое отделение для возврата. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

apply

apply(
    *,
    order_id: str,
    transition: OrderTransition | str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> OrderActionResult

Применяет действие к заказов.

Аргументы

order_id: идентифицирует заказ. transition: задает переход статуса заказа. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

check_confirmation_code

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

Проверяет confirmation code для заказов.

Аргументы

order_id: идентифицирует заказ. code: передает код подтверждения. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> OrderActionResult

Устанавливает параметры click-and-collect для заказа.

Аргументы

order_id: идентифицирует заказ. pickup_point_id: идентифицирует пункт выдачи click-and-collect. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_courier_delivery_range

get_courier_delivery_range(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CourierRangesResult

Возвращает courier delivery range для заказов.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CourierRangesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> OrderActionResult

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

Аргументы

order_id: идентифицирует заказ. interval_id: идентифицирует интервал курьерской доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_tracking_number

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

Обновляет трек-номер заказа.

Аргументы

order_id: идентифицирует заказ. tracking_number: передает трек-номер отправления. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

create

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

Создает задачу генерации ярлыков заказов.

Аргументы

order_ids: передает идентификаторы заказов. extended: запрашивает расширенный вариант результата, если поддерживается API. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

LabelTaskResult с типизированными данными ответа API.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_extended

create_extended(
    *,
    order_ids: Sequence[str],
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> LabelTaskResult

Запускает генерацию расширенных этикеток и возвращает типизированную SDK-модель.

Аргументы

order_ids: передает идентификаторы заказов для генерации этикеток. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

LabelTaskResult с идентификатором задачи генерации расширенных этикеток.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

download

download(
    *,
    task_id: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> LabelPdfResult

Скачивает PDF с ярлыками заказов.

Аргументы

task_id: идентифицирует асинхронную задачу. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

LabelPdfResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

create_announcement

create_announcement(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Создает announcement для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

track_announcement

track_announcement(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Передает tracking-событие для announcement для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_custom_area_schedule

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

Обновляет custom area schedule для sandbox-доставки.

Аргументы

items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

cancel_parcel

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

Отменяет parcel для sandbox-доставки.

Аргументы

parcel_id: идентифицирует отправление. actor: задает участника, от имени которого выполняется отмена. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

check_confirmation_code

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

Проверяет confirmation code для sandbox-доставки.

Аргументы

parcel_id: идентифицирует отправление. confirm_code: передает код подтверждения sandbox-доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

set_order_properties

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

Устанавливает order properties для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. properties: передает свойства заказа доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Устанавливает order real address для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. address: передает фактический адрес заказа. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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: DateInput,
    location: str,
    comment: str | None = None,
    options: DeliveryTrackingOptions | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Выполняет действие tracking для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. avito_status: передает статус события Авито. avito_event_type: передает тип события Авито. provider_event_code: передает код события провайдера. date: задает дату события. location: передает местоположение события. comment: передает комментарий к операции. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

prohibit_order_acceptance

prohibit_order_acceptance(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Запрещает прием order acceptance для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_sorting_center

list_sorting_center(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliverySortingCentersResult

Возвращает список sorting center для sandbox-доставки.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliverySortingCentersResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

add_sorting_center

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

Добавляет sorting center для sandbox-доставки.

Аргументы

items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

add_areas

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

Добавляет areas для sandbox-доставки.

Аргументы

tariff_id: идентифицирует тариф доставки. areas: передает зоны доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Добавляет tags to sorting center для sandbox-доставки.

Аргументы

tariff_id: идентифицирует тариф доставки. items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

add_terminals

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

Добавляет terminals для sandbox-доставки.

Аргументы

tariff_id: идентифицирует тариф доставки. items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_terms

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

Обновляет terms для sandbox-доставки.

Аргументы

tariff_id: идентифицирует тариф доставки. items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Добавляет tariff для sandbox-доставки.

Аргументы

name: передает название сущности. delivery_provider_tariff_id: идентифицирует тариф провайдера доставки. directions: передает направления доставки. tariff_zones: передает тарифные зоны. terms_zones: передает зоны условий доставки. tariff_type: задает тип тарифа. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_parcel

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

Создает parcel для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. parcel_id: идентифицирует отправление. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

cancel_sandbox_announcement

cancel_sandbox_announcement(
    *,
    announcement_id: str,
    date: DateInput,
    options: SandboxCancelAnnouncementOptions,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Отменяет sandbox announcement для sandbox-доставки.

Аргументы

announcement_id: идентифицирует sandbox-объявление доставки. date: задает дату события. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Отменяет sandbox parcel для sandbox-доставки.

Аргументы

parcel_id: идентифицирует отправление. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Изменяет sandbox parcel для sandbox-доставки.

Аргументы

type: передает значение type в upstream API. parcel_id: идентифицирует отправление. application: передает значение application в upstream API. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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: DateInput,
    packages: Sequence[SandboxAnnouncementPackage],
    options: SandboxCreateAnnouncementOptions,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Создает sandbox announcement для sandbox-доставки.

Аргументы

announcement_id: идентифицирует sandbox-объявление доставки. barcode: передает штрихкод отправления. sender: передает данные отправителя. receiver: передает данные получателя. announcement_type: задает тип sandbox-объявления доставки. date: задает дату события. packages: передает грузовые места отправления. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_sandbox_announcement_event

get_sandbox_announcement_event(
    *,
    announcement_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Возвращает sandbox announcement event для sandbox-доставки.

Аргументы

announcement_id: идентифицирует sandbox-объявление доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Возвращает sandbox change parcel info для sandbox-доставки.

Аргументы

application_id: идентифицирует заявку на изменение отправления. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_sandbox_parcel_info

get_sandbox_parcel_info(
    *,
    parcel_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Возвращает sandbox parcel info для sandbox-доставки.

Аргументы

parcel_id: идентифицирует отправление. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Возвращает sandbox registered parcel id для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

get

get(
    *,
    item_ids: Sequence[int],
    strong_consistency: bool | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> StockInfoResult

Возвращает остатков товаров.

Аргументы

item_ids: передает идентификаторы объявлений или товаров. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

StockInfoResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update

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

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

Аргументы

stocks: передает остатки товаров для обновления. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

StockUpdateResult с типизированными данными ответа API.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

create_announcement async

create_announcement(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Создает объявление доставки для заказа.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete async

delete(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Удаляет сущность доставки заказа.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create async

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

Создает сущность доставки заказа.

Аргументы

order_id: идентифицирует заказ. parcel_id: идентифицирует отправление. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_change_parcels async

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

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

Аргументы

parcel_ids: передает идентификаторы отправлений. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_change_parcel_result async

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

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

Аргументы

parcel_id: идентифицирует отправление. result: передает результат обработки изменения отправления. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

get async

get(
    *,
    task_id: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryTaskInfo

Возвращает задач доставки.

Аргументы

task_id: идентифицирует асинхронную задачу. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryTaskInfo с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

list async

list(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> OrdersResult

Возвращает список заказов.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrdersResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_markings async

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

Обновляет коды маркировки заказа.

Аргументы

order_id: идентифицирует заказ. codes: передает коды маркировки заказа. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

accept_return_order async

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

Подтверждает return order для заказов.

Аргументы

order_id: идентифицирует заказ. postal_office_id: идентифицирует почтовое отделение для возврата. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

apply async

apply(
    *,
    order_id: str,
    transition: OrderTransition | str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> OrderActionResult

Применяет действие к заказов.

Аргументы

order_id: идентифицирует заказ. transition: задает переход статуса заказа. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

check_confirmation_code async

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

Проверяет confirmation code для заказов.

Аргументы

order_id: идентифицирует заказ. code: передает код подтверждения. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

set_cnc_details async

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

Устанавливает параметры click-and-collect для заказа.

Аргументы

order_id: идентифицирует заказ. pickup_point_id: идентифицирует пункт выдачи click-and-collect. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_courier_delivery_range async

get_courier_delivery_range(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CourierRangesResult

Возвращает courier delivery range для заказов.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CourierRangesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

set_courier_delivery_range async

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

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

Аргументы

order_id: идентифицирует заказ. interval_id: идентифицирует интервал курьерской доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_tracking_number async

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

Обновляет трек-номер заказа.

Аргументы

order_id: идентифицирует заказ. tracking_number: передает трек-номер отправления. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

OrderActionResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

create async

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

Создает задачу генерации ярлыков заказов.

Аргументы

order_ids: передает идентификаторы заказов. extended: запрашивает расширенный вариант результата, если поддерживается API. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

LabelTaskResult с типизированными данными ответа API.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_extended async

create_extended(
    *,
    order_ids: Sequence[str],
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> LabelTaskResult

Запускает генерацию расширенных этикеток и возвращает типизированную SDK-модель.

Аргументы

order_ids: передает идентификаторы заказов для генерации этикеток. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

LabelTaskResult с идентификатором задачи генерации расширенных этикеток.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

download async

download(
    *,
    task_id: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> LabelPdfResult

Скачивает PDF с ярлыками заказов.

Аргументы

task_id: идентифицирует асинхронную задачу. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

LabelPdfResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

create_announcement async

create_announcement(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Создает announcement для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

track_announcement async

track_announcement(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Передает tracking-событие для announcement для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_custom_area_schedule async

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

Обновляет custom area schedule для sandbox-доставки.

Аргументы

items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

cancel_parcel async

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

Отменяет parcel для sandbox-доставки.

Аргументы

parcel_id: идентифицирует отправление. actor: задает участника, от имени которого выполняется отмена. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

check_confirmation_code async

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

Проверяет confirmation code для sandbox-доставки.

Аргументы

parcel_id: идентифицирует отправление. confirm_code: передает код подтверждения sandbox-доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

set_order_properties async

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

Устанавливает order properties для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. properties: передает свойства заказа доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

set_order_real_address async

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

Устанавливает order real address для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. address: передает фактический адрес заказа. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

tracking async

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

Выполняет действие tracking для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. avito_status: передает статус события Авито. avito_event_type: передает тип события Авито. provider_event_code: передает код события провайдера. date: задает дату события. location: передает местоположение события. comment: передает комментарий к операции. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

prohibit_order_acceptance async

prohibit_order_acceptance(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Запрещает прием order acceptance для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_sorting_center async

list_sorting_center(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliverySortingCentersResult

Возвращает список sorting center для sandbox-доставки.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliverySortingCentersResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

add_sorting_center async

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

Добавляет sorting center для sandbox-доставки.

Аргументы

items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

add_areas async

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

Добавляет areas для sandbox-доставки.

Аргументы

tariff_id: идентифицирует тариф доставки. areas: передает зоны доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

add_tags_to_sorting_center async

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

Добавляет tags to sorting center для sandbox-доставки.

Аргументы

tariff_id: идентифицирует тариф доставки. items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

add_terminals async

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

Добавляет terminals для sandbox-доставки.

Аргументы

tariff_id: идентифицирует тариф доставки. items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_terms async

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

Обновляет terms для sandbox-доставки.

Аргументы

tariff_id: идентифицирует тариф доставки. items: передает элементы пакетного запроса. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

add_tariff async

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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Добавляет tariff для sandbox-доставки.

Аргументы

name: передает название сущности. delivery_provider_tariff_id: идентифицирует тариф провайдера доставки. directions: передает направления доставки. tariff_zones: передает тарифные зоны. terms_zones: передает зоны условий доставки. tariff_type: задает тип тарифа. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_parcel async

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

Создает parcel для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. parcel_id: идентифицирует отправление. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

cancel_sandbox_announcement async

cancel_sandbox_announcement(
    *,
    announcement_id: str,
    date: DateInput,
    options: SandboxCancelAnnouncementOptions,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Отменяет sandbox announcement для sandbox-доставки.

Аргументы

announcement_id: идентифицирует sandbox-объявление доставки. date: задает дату события. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

cancel_sandbox_parcel async

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

Отменяет sandbox parcel для sandbox-доставки.

Аргументы

parcel_id: идентифицирует отправление. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

change_sandbox_parcel async

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

Изменяет sandbox parcel для sandbox-доставки.

Аргументы

type: передает значение type в upstream API. parcel_id: идентифицирует отправление. application: передает значение application в upstream API. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_sandbox_announcement async

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

Создает sandbox announcement для sandbox-доставки.

Аргументы

announcement_id: идентифицирует sandbox-объявление доставки. barcode: передает штрихкод отправления. sender: передает данные отправителя. receiver: передает данные получателя. announcement_type: задает тип sandbox-объявления доставки. date: задает дату события. packages: передает грузовые места отправления. options: передает дополнительные параметры операции. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_sandbox_announcement_event async

get_sandbox_announcement_event(
    *,
    announcement_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Возвращает sandbox announcement event для sandbox-доставки.

Аргументы

announcement_id: идентифицирует sandbox-объявление доставки. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_sandbox_change_parcel_info async

get_sandbox_change_parcel_info(
    *,
    application_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Возвращает sandbox change parcel info для sandbox-доставки.

Аргументы

application_id: идентифицирует заявку на изменение отправления. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_sandbox_parcel_info async

get_sandbox_parcel_info(
    *,
    parcel_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Возвращает sandbox parcel info для sandbox-доставки.

Аргументы

parcel_id: идентифицирует отправление. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_sandbox_registered_parcel_id async

get_sandbox_registered_parcel_id(
    *,
    order_id: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> DeliveryEntityResult

Возвращает sandbox registered parcel id для sandbox-доставки.

Аргументы

order_id: идентифицирует заказ. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

DeliveryEntityResult со статусом выполнения операции.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

get async

get(
    *,
    item_ids: Sequence[int],
    strong_consistency: bool | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> StockInfoResult

Возвращает остатков товаров.

Аргументы

item_ids: передает идентификаторы объявлений или товаров. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

StockInfoResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update async

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

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

Аргументы

stocks: передает остатки товаров для обновления. idempotency_key: задает ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

StockUpdateResult с типизированными данными ответа API.

Поведение

idempotency_key следует передавать для write-операций, которые могут безопасно повторяться. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.