Выгрузка списков ПВЗ Метод GetParcelShops Описание Данный метод предназначен для получения списка доступных для заданного бизнес-юнита ПВЗ. Метод возвращает сразу все доступные ПВЗ. Для обновления данных в системе клиента необходимо анализировать поле UpdateTimestamp, чтобы выявить записи, которые были обновлены с прошлой обработки списка.
Необходимо обновлять список не реже одного раза в сутки. Закрытые, закрывающиеся и другие неактуальные ПВЗ не передаются, поэтому стоит позаботиться об актуализации списка на стороне клиента.
По вопросам согласование доступных для бизнес-юнита регионов и конкретных ПВЗ обращайтесь к вашему менеджеру Hermes Russia.
Входные параметры Параметр
| Описание
| Тип
| Обязательный
| Пример
| businessUnitCode
| Номер бизнес-юнита
| String
| Да
| 1234
|
Выходные параметры Параметр
| Описание
| Тип
| Пример
| ParcelShops
| Массив записей с информацией о ПВЗ
| ParcelShop[]
| См. описание используемых типов данных
|
Отслеживание статусов посылок Отслеживание статусов посылок возможно следующими методами:
Метод GetStatusesByBusinessUnit – непрерывное получение статусов посылок по бизнес-юниту
Error: Reference source not found – получение статусов по штрих-коду посылки
Рекомендуется выбирать небольшие периоды времени для запроса статусов, поскольку иногда их количество за месяц может достигать нескольких десятков тысяч. Рекомендуется использовать не большие периоды, либо запрашивать по частям.
Метод получения статусов по посылкам рекомендуется использовать только в технических или в единичных запросах.
Метод GetStatusesByBusinessUnit Описание Данный метод предназначен для решения задачи получения всех статусов всех посылок заданного бизнес-юнита в режиме, приближенном к реальному времени и сохранении статусов в системе клиента. Метод позволяет получить все статусы, которые появились в системе Hermes Russia с заданной даты.
Данный метод не возвращает статусы посылок по услуге «Экспресс-возврат».
Рекомендуется использовать только этот метод для автоматического получения статусов в систему клиента.
Алгоритм работы с методом При первом вызове необходимо передать в параметре dateFrom текущую дату
Далее гарантируется передача всех статусов без потерь или повторов, при условии, что параметр dateFrom будет содержать значение, возвращенное в параметре NextRequestDateFrom из предыдущего вызова метода, а параметр dateTo необходимо оставлять пустым
При удалении статуса, он передается еще раз, но уже с заполненным полем StatusDeleteTimestamp
Входные параметры Параметр
| Описание
| Тип
| Обязательный
| Пример
| businessUnitCode
| Код бизнес-юнита
| String
| Да
| 1234
| dateFrom
| Дата и время начала периода, за который необходимо вернуть статусы
| DateTime
| Да
| 2014-03-17T20:49:19.000
| dateTo
| Дата и время окончания периода, за который необходимо вернуть статусы. Обычно должно быть пустым. Необходимо заполнять, только если нужны статусы за старые периоды из-за сбоя на стороне клиента.
| Nullable DateTime
| Нет
| null
|
Выходные параметры Параметр
| Описание
| Тип
| Пример
| NextRequestDateFrom
| Дата окончания периода, за который переданы статусы. Необходимо сохранять эту дату в системе клиента и передавать в следующем запросе статусов в параметре DateFrom
| DateTime
| 2014-03-17T21:49:19.000
Возможны варианты передачи даты в формате /Date(1449672181000+0300)/, как ее распознать, см. здесь
| Statuses
| Массив записей с информацией о статусе посылки
| Status[]
|
|
Метод GetStatusesByParcelBarcodes Описание Данный метод предназначен для получения всех статусов по заданному списку посылок. Удаленные статусы не возвращаются данным методом. Часто использовать этот метод крайне не рекомендуется, только для редких и частных случаев.
Входные параметры Параметр
| Описание
| Тип
| Обязательный
| Пример
| parcelBarCodes
| Массив штрих-кодов посылок. Максимум 1000 штрих-кодов.
| String[1..1000]
| Да
| 20000000000001
|
Выходные параметры Параметр
| Описание
| Тип
| Пример
| Statuses
| Список статусов по запрошенным посылкам
| Status[]
|
|
|