Helpers

class pochta.helpers.Address(address)[source]

Адрес для нормализации.

Parameters

address (str) – Оригинальный адрес одной строкой

raw

Получения словаря для отправки через API.

Return type

dict

class pochta.helpers.CustomsEntry(amount, country_code, description, tnved_code, weight, value=None)[source]

Вложение.

Конструктор вложения.

Parameters

  • amount (int) – Количество

  • country_code (int) – Код страны происхождения.

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

  • tnved_code (str) – Код ТНВЭД

  • weight (int) – Вес вложения в граммах

  • value (Optional[int]) – Цена товара (вкл. НДС)

raw

Представление Таможенного Вложения для использования в конструкторе РПО.

Return type

dict

Returns

Словарь с данными Вложения

class pochta.helpers.Item(description, quantity, value=None, vat_rate=None, insurance_value=None)[source]

Вложение.

Конструктор вложения.

Parameters

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

  • quantity (int) – Количество товара

  • value (Optional[int]) – Цена товара (вкл. НДС)

  • vat_rate (Optional[int]) – Ставка НДС

  • insurance_value (Optional[int]) – Объявленная ценность

raw

Представление Вложения для использования в конструкторе РПО.

Return type

dict

Returns

Словарь с данными Вложения

class pochta.helpers.Name(name)[source]

ФИО для нормализации.

Parameters

name (str) – Оригинальные фамилия, имя , отчество одной строкой

raw

Получения словаря для отправки через API.

Return type

dict

class pochta.helpers.Order(mass, order_num, fragile, mail_category=<MailCategory.SIMPLE: 'SIMPLE'>, mail_type=<MailType.POSTAL_PARCEL: 'POSTAL_PARCEL'>, payment=None, payment_method=None)[source]

Класс помошник создания РПО.

Инициализация РПО.

https://otpravka.pochta.ru/specification#/orders-creating_order

Parameters

  • mass (int) – Вес РПО (в граммах).

  • order_num (str) – Номер заказа. Внешний идентификатор заказа, который формируется отправителем.

  • fragile (bool) – Установлена ли отметка “Осторожно/Хрупкое”?

  • mail_category (MailCategory) – Категория РПО.

  • mail_type (MailType) – Вид РПО.

  • payment (Optional[int]) – Сумма наложенного платежа (копейки).

  • payment_method (Optional[PaymentType]) – Способ оплаты.

add_customs_declaration(currency, entries_type, customs_entries, with_certificate=None, with_invoice=None, with_license=None)[source]

Таможенная декларация (для международных отправлений).

Parameters

  • currency (str) – Код валюты.

  • entries_type (EntryType) – Категория вложения.

  • customs_entries (List[CustomsEntry]) – Список вложений

  • with_certificate (Optional[bool]) – Приложенные документы: сертификат

  • with_invoice (Optional[bool]) – Приложенные документы: счет-фактура

  • with_license (Optional[bool]) – Приложенные документы: лицензия

Return type

None

add_items(items)[source]

Добавление товарных вложений РПО.

Parameters

items (List[Item]) – Список вложений

Return type

None

add_services(completeness_checking=None, courier=None, envelope_type=None, delivery_with_cod=False, insurance_value=None, inventory=None, no_return=None, with_order_of_notice=None, with_simple_notice=None, sms_notice_recipient=None, notice_payment_method=None, wo_mail_rank=None)[source]

Дополнительные параметры РПО.

Parameters

  • completeness_checking (Optional[bool]) – Признак услуги проверки комплектности.

  • courier (Optional[bool]) – Отметка “Курьер”

  • envelope_type (Optional[EnvelopeType]) – Тип конверта - ГОСТ Р 51506-99.

  • delivery_with_cod (Optional[bool]) – Признак оплаты при получении.

  • insurance_value (Optional[int]) – Объявленная ценность

  • inventory (Optional[bool]) – Наличие описи вложения

  • no_return (Optional[bool]) – Отметка “Возврату не подлежит”

  • with_order_of_notice (Optional[bool]) – Отметка ‘С заказным уведомлением’

  • with_simple_notice (Optional[bool]) – Отметка ‘С простым уведомлением’

  • sms_notice_recipient (Optional[int]) – Признак услуги SMS уведомления

  • notice_payment_method (Optional[PaymentType]) – Способ оплаты уведомления

  • wo_mail_rank (Optional[bool]) – Отметка “Без разряда”

Return type

None

raw

Представление РПО для использования в вызовах API.

Return type

dict

Returns

Словарь с данными РПО

set_address(house_to, mail_direct, region_to, place_to, street_to, address_type_to=<AddressType.DEFAULT: 'DEFAULT'>, index_to=None, postoffice_code=None, area_to=None, building_to=None, hotel_to=None, corpus_to=None, slash_to=None, letter_to=None, location_to=None, office_to=None, room_to=None, num_address_type_to=None, raw_address=None, str_index_to=None, vladenie_to=None, transport_type=None)[source]

Установка адресных данных РПО.

Parameters

  • house_to (str) – Часть адреса: Номер здания

  • mail_direct (int) – Код страны.

  • region_to (str) – Область, регион

  • place_to (str) – Населенный пункт

  • street_to (str) – Часть адреса: Улица

  • address_type_to (AddressType) – Тип адреса.

  • index_to (Union[str, int, None]) – Почтовый индекс

  • postoffice_code (Union[str, int, None]) – Индекс места приема

  • area_to (Optional[str]) – Район

  • building_to (Optional[str]) – Часть здания: Строение

  • hotel_to (Optional[str]) – Название гостиницы

  • corpus_to (Optional[str]) – Часть здания: Корпус

  • slash_to (Optional[str]) – Часть здания: Дробь

  • letter_to (Optional[str]) – Часть здания: Литера

  • location_to (Optional[str]) – Микрорайон

  • office_to (Optional[str]) – Часть здания: Офис

  • room_to (Optional[str]) – Часть здания: Номер помещения

  • num_address_type_to (Optional[str]) – Номер для а/я, войсковая часть, войсковая часть ЮЯ, полевая почта

  • raw_address (Optional[str]) – Необработанный адрес получателя

  • str_index_to (Optional[str]) – Почтовый индекс (буквенно-цифровой)

  • vladenie_to (Optional[str]) – Часть здания: Владение

  • transport_type (Optional[TransportType]) – Возможный вид транспортировки (для международных отправлений).

Return type

None

set_dimensions(height, length, width)[source]

Добавление линейных размеров.

Parameters

  • height (int) – Линейная высота (сантиметры)

  • length (int) – Линейная длина (сантиметры)

  • width (int) – Линейная ширина (сантиметры)

Return type

None

set_recipient(given_name, surname, middle_name=None, recipient_name=None, tel_address=None)[source]

Указать получателя.

Parameters

  • recipient_name (Optional[str]) – Наименование получателя одной строкой (ФИО, наименование организации)

  • given_name (str) – Имя получателя

  • surname (str) – Фамилия получателя

  • middle_name (Optional[str]) – Отчество получателя

  • tel_address (Optional[int]) – Телефон получателя (может быть обязательным для некоторых типов отправлений)

Return type

None

class pochta.helpers.Phone(phone, area=None, place=None, region=None)[source]

Телефон для нормализации.

Parameters

  • phone (str) – Оригинальный номер одной строкой

  • area (Optional[str]) – Область/край трелефонного номера

  • place (Optional[str]) – Город телефонного номера

  • region (Optional[str]) – Регион телефонного номера

raw

Получения словаря для отправки через API.

Return type

dict

class pochta.helpers.Recipient(address, full_name, phone)[source]

Получатель для проверки благонадежности.

Parameters

  • address (str) – Адрес

  • full_name (str) – Полное имя

  • phone (str) – Телефон

raw

Получения словаря для отправки через API.

Return type

dict