Спецификация клиентских веб-сервисов (стр. 3 )

Метод GetStatusesByParcelBarcodes

Описание

Данный метод предназначен для получения всех статусов по заданному списку посылок. Удаленные статусы не возвращаются данным методом. Часто использовать этот метод крайне не рекомендуется, только для редких и частных случаев.

Входные параметры

Параметр	Описание	Тип	Обязательный	Пример
parcelBarCodes	Массив штрих-кодов посылок. Максимум 1000 штрих-кодов.	String[1..1000]	Да	20000000000001

Выходные параметры

Параметр	Описание	Тип	Пример
Statuses	Список статусов по запрошенным посылкам	Status[]

Получение информации о возвращаемых посылках

Метод GetReturnInfoByBusinessUnit

Описание

Данный метод предназначен для получения информации о посылках, возвращаемых на склад клиента. На склад клиента возвращаются посылки:

От которых получатель отказался до выкупа Срок хранения которых истек По услуге «Экспресс-возврат» Которые не удалось доставить по другим причинам

Посылки попадают в результат данного метода перед отправкой на склад клиента. Посылки могут повторно попасть в выгрузку, если какая-либо информация по ним, участвующая в выгрузке, будет изменена.

Алгоритм работы с методом

При первом вызове необходимо передать в параметре DateFrom текущую дату Далее мы можем гарантировать передачу всех записей без потерь, только если вы будете передавать в параметр DateFrom значение, возвращенное в параметре NextRequestDateFrom из предыдущего вызова метода, а параметр DateTo будете оставлять пустым

Входные параметры

Параметр	Описание	Тип	Обязательный	Пример
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)/, как ее распознать, см. здесь
Returns	Список записей с информацией о возвратных посылках. Одна строка по каждой посылке.	ReturnInfo[]

Объектная модель

Preadvice

Параметр	Описание	Тип	Обязательность	Пример
BusinessUnitCode	Идентификатор бизнес-юнита клиента	String (1..256)	Да	1376
CashOnDeliveryCurrency	Валюта стоимости посылки (Доступны только рубли)	String(1..3) Описание CurrencyCode	Да	RUB
CashOnDeliveryValue	Сумма, которую необходимо внести получателю при получении посылки. Если посылка предоплачена полностью, значение установить = 0, если частично, указать, сколько необходимо внести покупателю.	Double	Да	1000.00 (Разделитель – всегда точка)
ClientOrderNumber	Номер заказа в системе клиента, используется для дальнейшего трекинга, отчетности и т. д.	String(1..256)	Нет	1234567890
ClientParcelNumber	Уникальный номер посылки в системе клиента (может быть равен ParcelBarcode, если генерация штрих-кода посылки идет на стороне клиента).	String(1..40)	Да	12345678901234
CustomerAdditionalAddressInfo	Дополнение к адресу получателя	String(0..60)	Нет	Примечание
CustomerAdditionalPhoneNumber	Дополнительный номер телефона получателя. На этот номер будут отправляться только голосовые уведомления, а также использоваться для связи колцентра с получателем	String (0..20)	Нет	8-495-123-44-55
CustomerApartmentNumber	Номер квартиры или офиса получателя	String(0..10)	Нет	102
CustomerBuildingNumber	Номер дома или владения получателя	String(0..10)	Нет	15
CustomerCity	Город получателя	String(0..60)	Нет	Москва
CustomerConstructionNumber	Строение дома получателя	String(0..10)	Нет	3
CustomerCountryCode	Код страны	String(3)	Да	RUS
CustomerEmail	Email получателя	String(0..100)	Нет	*****@***ru
CustomerFarthersName	Отчество получателя	String(0..60)	Нет	Иванович
CustomerFirstName	Имя получателя	String(0..60)	Нет	Иван
CustomerFrameNumber	Корпуса дома получателя	String(0..10)	Нет	Б
CustomerLandlinePhoneNumber	Основной номер телефона получателя. На этот номер будут отправляться только голосовые уведомления	String (0..20)	Нет	8-495-123-44-55
CustomerMobilePhoneNumber	Номер мобильного телефона получателя. На этот номер будет отправляться SMS о статусах посылки и голосовые уведомления	String (0..20)	Нет	8-903-123-44-55
CustomerNumber	Номер получателя в системе клиента	String (0..25)	Нет	1
CustomerRegion	Регион получателя	String(0..60)	Нет	Московская обл.
CustomerStreet	Название улицы получателя	String(0..60)	Нет	Тверская
CustomerStreetType	Тип улицы получателя	String(0..60)	Нет	проспект
CustomerSubregion	Район получателя	String(0..60)	Нет	Пушкинский район
CustomerSurname	Фамилия получателя	String(1..60)	Да	Иванов
CustomerZipCode	Индекс получателя	String(0..20)	Нет	170019
CustomStoragePeriod	Количество дней хранения посылки в ПВЗ. Если значение не указано, то в дальнейшем будет использоваться значение из бизнес - юнита. Если указанное значение превышает допустимое в бизнес - юните, будет установлено максимальное допустимое.	Integer	Нет	14
DirectDistributionCenterCode	Номер склада отгрузки в системе клиента. Если значение указано, будет произведена проверка на доступность выбранного склада для указанного бизнес-юнита, если значение не указано, система попытается найти подходящий номер автоматически.	String (0..256)	Нет	273
DispatchDate	Фактическая дата отгрузки посылки (в текущей версии пока не используется)	DateTime	Нет	2014-11-01T15:10:00 REST JSON: "\/Date(1450794905000)\/" (см. описание)
ExtraParams	Зарезервированные дополнительные параметры для поддержки различных версий текущего API	ExtraParam[]	Нет
InsuranceCurrency	Валюта страховой стоимости посылки (Доступны только рубли)	String(1..3) Описание CurrencyCode	Да	RUB
InsuranceValue	Страховая стоимость посылки. Если посылка предоплачена, значение установить = реальной стоимости посылки	Double	Да	1000.00 (Разделитель – всегда точка)
OrderPlacementTimestamp	Дата и время оформления получателем заказа в системе клиента	DateTime	Нет	2014-04-01T00:00:01 REST JSON: "\/Date(1450794905000)\/" (см. описание)
ParcelBarcode	Штрих-код посылки. 14-значное число в заданном Hermes диапазоне. Оставить пустым, чтобы номер был сформирован системой Hermes (опция автогенерации/ручной генерации штрих-кода подключается при создании аккаунта клиента), автогенерация происходит при создании предзаказа CreatePreadvice	String(1..40)	Нет	12345678901234
ParcelHeight	Высота посылки, см	Integer	Нет	10
ParcelLength	Длина посылки, см	Integer	Нет	30
ParcelshopCode	Номер ПВЗ	String (6)	Да	900176
ParcelWeight	Вес посылки, гр	Integer	Нет	1000
ParcelWidth	Ширина посылки, см	Integer	Нет	15
ReturnDistributionCenterCode	Номер склада возврата в системе клиента. Если значение указано, будет произведена проверка на доступность выбранного склада для указанного бизнес-юнита, если значение не указано, система попытается найти подходящий номер автоматически.	String (0..256)	Нет	275
Services	Список услуг, которые необходимо оказать по данной посылке (в текущей версии учитывается только первый элемент массива, другие сделаны для дальнейшего расширения сервиса и отбрасываются)	String[] описание  ServiceType	Да	DIRECT_DELIVERY

Если номер телефона получателя один, просьба записывать его значение во все три поля телефона:  CustomerAdditionalPhoneNumber, CustomerMobilePhoneNumber, CustomerLandlinePhoneNumber.