Поиск ОПС

class pochta.api.services.Services(client)

Bases: object

Методы API Поиска ОПС.

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

Инициализация API Поиска ОПС.

Parameters

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

get_nearby_postoffices(lan, lon, top=None, work_filter=<PostofficeWorkType.ALL: 'ALL'>, search_radius=None, current_date_time=None, hide_private=False, filter_by_office_type=True, yandex_address=None, geo_object=None)

Поиск почтовых отделений по координатам.

https://otpravka.pochta.ru/specification#/services-postoffice-nearby

Parameters

• lan (float) – Широта

• lon (float) – Долгота

• top (Optional[int]) – Количество ближайших почтовых отделений в результате поиска

• work_filter (PostofficeWorkType) – Дополнительное ограничение по времени работы для поиска ОПС.

• search_radius (Optional[float]) – Радиус для поиска (в километрах)

• current_date_time (Optional[datetime]) – Текущее клиентское дата-время в таймзоне клиента. Формат: yyyy-MM-dd’T’HH:mm:ss. Данный параметр используется для определения отделений, работающих в данный момент, т.е. если эти данные нужны, параметр передавать обязательно!

• hide_private (Optional[bool]) – Исключать не публичные отделения. По-умолчанию не исключать (false).

• filter_by_office_type (Optional[bool]) – Фильтр по типам объектов в ответе. true: ГОПС, СОПС, ПОЧТОМАТ. false: все. Значение по-умолчанию - true.

• yandex_address (Optional[str]) – Адрес в том формате, в котором возвращает его сервис Яндекса для адреса, указанного пользователем. Пример: Санкт-Петербург, улица Победы, 15к1. Параметр необходим для определения является ли переданный адрес точным адресом отделения. Требует также заполненного параметра geoObject.

• geo_object (Optional[str]) – JSON-строка, содержащая объект GeoObject, получаемый для адреса в сервисе Яндекса. См. api.yandex.ru. Требует также заполненного параметра ‘yandex-address’.

Return type

List[dict]

Returns

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

get_postoffice(postal_code)

Поиск почтового отделения по индексу.

https://otpravka.pochta.ru/specification#/services-postoffice

Parameters

postal_code (Union[str, int]) – Индекс почтового отделения

Return type

dict

Returns

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

get_postoffice_by_address(address, top=3)

Поиск обслуживающего ОПС по адресу.

https://otpravka.pochta.ru/specification#/services-postoffice-by-address

Parameters

• address (str) – Строка с адресом. Следует учесть, что чем точнее адрес, тем точнее будет поиск. Пример: Санкт-Петербург, улица Победы, 15к1

• top (Optional[int]) – Количество ближайших почтовых отделений в результате поиска (Опционально). По умолчанию равно 3.

Returns

Список почтовых индексов найденных ОПС отсортированный по релевантности

get_postoffice_service_group(postal_code, group_id)

Поиск почтовых сервисов ОПС по идентификатору группы сервисов.

https://otpravka.pochta.ru/specification#/services-postoffice-service-group

Parameters

• postal_code (Union[str, int]) – Индекс почтового отделения.

• group_id (str) – Идентификатор группы сервисов.

Return type

List[dict]

Returns

Почтовые сервисы в ОПС

get_postoffice_services(postal_code)

Поиск почтовых сервисов ОПС.

Может возвращать как все доступные сервисы, так и сервисы определенной группы (например: Киберпочт@).

https://otpravka.pochta.ru/specification#/services-postoffice-service

Parameters

postal_code (Union[str, int]) – Индекс почтового отделения.

Return type

List[dict]

Returns

Почтовые сервисы в ОПС

get_settlement_postoffices(settlement, region=None, district=None)

Поиск почтовых индексов в населённом пункте.

https://otpravka.pochta.ru/specification#/services-postoffice-settlement.offices.codes

Parameters

• region (Optional[str]) – Область/край/республика, где расположен населённый пункт (например Свердловская).

• district (Optional[str]) – Район, где расположен населённый пункт (для деревень, посёлков и т. д. - например Сухоложский).

• settlement (str) – Название населённого пункта (например Екатеринбург)

Return type

List[str]

Returns

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