Партии

class pochta.api.batches.Batches(client)[source]

Bases: object

Методы API Партий.

Используется через объект Delivery или вручную.

Инициализация API Партий.

Parameters

client (Delivery) – API клиент Доставки

add_orders_to_batch(batch_name, orders)[source]

Добавление заказов в партию.

Создает массив заказов и помещает непосредственно в партию. Автоматически рассчитывает и проставляет плату за пересылку. Каждому заказу автоматически присваивается ШПИ.

https://otpravka.pochta.ru/specification#/batches-add_orders_to_batch

Parameters

  • batch_name (str) – Наименование партии

  • orders (List[Order]) – Список заказов

Return type

dict

Returns

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

change_sending_date(batch_name, year, month, day)[source]

Изменение дня отправки в почтовое отделение.

Изменяет (устанавливает) новый день отправки в почтовое отделение.

https://otpravka.pochta.ru/specification#/batches-sending_date

Parameters

  • batch_name (int) – Наименование партии

  • year (int) – Дата сдачи в почтовое отделение: год

  • month (int) – Дата сдачи в почтовое отделение: месяц

  • day (int) – Дата сдачи в почтовое отделение: день

Return type

dict

Returns

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

create_batch(shipment_ids, sending_date=None)[source]

Создание партии из N заказов.

Автоматически создает партию и переносит указанные подготовленные заказы в эту партию. Если заказы относятся к разным типам и категориям – создается несколько партий. Заказы распределяются по соответствующим партиям. Каждому перенесенному заказу автоматически присваивается ШПИ.

https://otpravka.pochta.ru/specification#/batches-create_batch_from_N_orders

Parameters

  • shipment_ids (List[str]) – Список внутренних идентификаторов заказов

  • sending_date (Optional[date]) – Дата сдачи в почтовое отделение (yyyy-MM-dd)

Return type

dict

Returns

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

delete_order_from_batch(shipment_ids)[source]

Удаление заказов из партии.

https://otpravka.pochta.ru/specification#/batches-delete_order_from_batch

Parameters

shipment_ids (List[str]) – Список внутренних идентификаторов заказов

Return type

dict

Returns

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

find_batch(batch_name)[source]

Поиск партии по наименованию.

Возвращает параметры партии. https://otpravka.pochta.ru/specification#/batches-find_batch

Parameters

batch_name (str) – Наименование партии

Return type

dict

Returns

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

find_order_by_id(shipment_id)[source]

Поиск заказа в партии по внутреннему id.

https://otpravka.pochta.ru/specification#/batches-find_order_by_id

Parameters

shipment_id (str) – Внутренний идентификатор отправления

Return type

dict

Returns

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

find_orders_with_barcode(query)[source]

Поиск заказов с ШПИ.

https://otpravka.pochta.ru/specification#/batches-find_orders_with_barcode

Parameters

query (str) – Условие для поиска: номер заказа или ШПИ

Return type

List[dict]

Returns

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

get_batch_orders_info(batch_name, sort='asc', size=None, page=None)[source]

Запрос данных о заказах в партии.

https://otpravka.pochta.ru/specification#/batches-get_info_about_orders_in_batch

Parameters

  • batch_name (str) – Наименование партии

  • sort (str) – Критерии сортировки в формате: asc(по возрастанию) или desc (по убыванию). По умолчанию порядок сортировки по возрастанию

  • size (Optional[int]) – Количество записей на странице

  • page (Optional[int]) – Номер страницы (0..N)

Return type

List[dict]

Returns

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

move_orders_to_batch(batch_name, shipment_ids)[source]

Перенос заказов в партию.

Переносит подготовленные заказы в указанную партию. Если часть заказов не может быть помещена в партию (тип и категория партии не соответствует типу и категории заказа) - возвращается json объект с указанием индекса заказа в переданном массиве и типом ошибки, остальные заказы помещаются в указанную партию. Каждому перенесенному заказу автоматически присваивается ШПИ.

https://otpravka.pochta.ru/specification#/batches-move_orders_to_batch

Parameters

  • batch_name (str) – Наименование партии

  • shipment_ids (List[str]) – Список внутренних идентификаторов заказов

Return type

dict

Returns

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

search_all_batches(mail_type=None, mail_category=None, sort='asc', size=None, page=None)[source]

Поиск всех партий.

https://otpravka.pochta.ru/specification#/batches-search_all_batches

Parameters

  • mail_type (Optional[MailType]) – Тип отправления (По умолчанию: ВСЕ)

  • mail_category (Optional[MailCategory]) – Категория отправления (По умолчанию: ВСЕ)

  • sort (Optional[str]) – Критерии сортировки в формате: asc(по возрастанию) или desc (по убыванию). По умолчанию порядок сортировки по возрастанию

  • size (Optional[int]) – Количество записей на странице

  • page (Optional[int]) – Номер страницы (0..N)

Return type

List[dict]

Returns

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