Документы¶
-
class
pochta.api.documents.
Documents
(client)[source]¶ Bases:
object
Методы API Документов.
Используется через объект
Delivery
или вручную.Инициализация API Документов.
- Parameters
client (Delivery) – API клиент Доставки
-
checkin
(batch_name)[source]¶ Подготовка и отправка электронной формы Ф103.
Присваивает уникальную версию партии для дальнейшего приема этой партии сотрудниками ОПС. Отправляет по e-mail электронную форму Ф103 в ОПС для регистрации.
https://otpravka.pochta.ru/specification#/documents-checkin
- Parameters
batch_name (
str
) – Наименование партии- Return type
dict
- Returns
Результат операции
-
create_all_docs
(batch_name)[source]¶ Генерация пакета документации.
- Генерирует и возвращает zip архив с 4-мя файлами:
Export.xls , Export.csv - список с основными данными по заявкам в составе партии
F103.pdf - форма ф103 по заявкам в составе партии
В зависимости от типа и категории отправлений, формируется комбинация из сопроводительных документов в формате pdf ( формы: f7, f112, f22)
https://otpravka.pochta.ru/specification#/documents-create_all_docs
- Parameters
batch_name (
str
) – Наименование партии- Return type
Response
- Returns
Ответ API
-
create_comp_check_form
(batch_name)[source]¶ Генерация печатной формы акта осмотра содержимого.
Генерирует и возвращает pdf файл с формой акта осмотра содержимого для указанной партии.
https://otpravka.pochta.ru/specification#/documents-create_comp_check_form
- Parameters
batch_name (
str
) – Наименование партии- Return type
Response
- Returns
Ответ API
-
create_f103
(batch_name)[source]¶ Генерация печатной формы Ф103.
Генерирует и возвращает pdf файл с формой Ф103 для указанной партии.
https://otpravka.pochta.ru/specification#/documents-create_f103
- Parameters
batch_name (
str
) – Наименование партии- Return type
Response
- Returns
Ответ API
-
create_f112
(shipment_id, sending_date=None)[source]¶ Генерация печатной формы Ф112ЭК.
Генерирует и возвращает pdf-файл с заполненной формой Ф112ЭК для указанного заказа. Только для заказа с «наложенным платежом». Если заказ не имеет данного атрибута, метод вернет ошибку. Если параметр sending-date не передается, берется текущая дата.
https://otpravka.pochta.ru/specification#/documents-create_f112
- Parameters
shipment_id (
str
) – Уникальный идентификатор заказаsending_date (
Optional
[date
]) – Дата отправки в почтовое отделение (yyyy-MM-dd)
- Return type
Response
- Returns
Ответ API
-
create_f7_f22
(shipment_id, sending_date=None, print_type=None)[source]¶ Генерация печатной формы Ф7п.
Генерирует и возвращает pdf файл с формой ф7п для указанного заказа. Опционально в файл прикрепляется форма Ф22 (посылка онлайн). Если параметр sending-date не передается, берется текущая дата.
https://otpravka.pochta.ru/specification#/documents-create_f7_f22
- Parameters
shipment_id (
str
) – Уникальный идентификатор заказаsending_date (
Optional
[date
]) – Дата отправки в почтовое отделение (yyyy-MM-dd)print_type (
Optional
[PrintType
]) – Тип печати
- Return type
Response
- Returns
Ответ API
-
create_forms
(shipment_id, sending_date=None, print_type=None)[source]¶ Генерация печатных форм для заказа.
- Генерирует и возвращает pdf файл, который содержит, либо:
форму ф7п (посылка, посылка-онлайн, бандероль, курьер-онлайн)
форму Е-1 (EMS, EMS-оптимальное, Бизнес курьер, Бизнес курьер экспресс)
конверт (письмо заказное)
Опционально прикрепляются формы: Ф112ЭК (отправление с наложенным платежом), Ф22 (посылка онлайн), уведомление и опись вложения (для заказного письма или бандероли).
https://otpravka.pochta.ru/specification#/documents-create_forms
- Parameters
shipment_id (
str
) – Уникальный идентификатор заказаsending_date (
Optional
[date
]) – Дата отправки в почтовое отделение (yyyy-MM-dd)print_type (
Optional
[PrintType
]) – Тип печати
- Return type
Response
- Returns
Ответ API
-
create_forms_backlog
(shipment_id, sending_date=None)[source]¶ Генерация печатных форм для заказа (до формирования партии).
- Генерирует и возвращает pdf файл, который может содержать в зависимости от типа отправления:
форму ф7п (посылка, посылка-онлайн, бандероль, курьер-онлайн)
форму Е-1 (EMS, EMS-оптимальное, Бизнес курьер, Бизнес курьер экспресс)
конверт (письмо заказное)
Опционально прикрепляются формы: Ф112ЭК (отправление с наложенным платежом), Ф22 (посылка онлайн), уведомление (для заказного письма или бандероли).
https://otpravka.pochta.ru/specification#/documents-create_forms_backlog
- Parameters
shipment_id (
str
) – Уникальный идентификатор заказаsending_date (
Optional
[date
]) – Дата отправки в почтовое отделение (yyyy-MM-dd)
- Return type
Response
- Returns
Ответ API