Версия документа


НазваниеВерсия документа
страница5/11
ТипДокументы
filling-form.ru > бланк заявлений > Документы
1   2   3   4   5   6   7   8   9   10   11

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

Метод GetReturnInfoByBusinessUnit

Описание


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

  • От которых получатель отказался до выкупа

  • Срок хранения которых истек

  • По услуге «Экспресс-возврат»

  • Которые не удалось доставить по другим причинам

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

  1. При первом вызове необходимо передать в параметре DateFrom текущую дату

  2. Далее мы можем гарантировать передачу всех записей без потерь, только если вы будете передавать в параметр 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)

Нет

mymail@mail.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.

PreadviceResult


Параметр

Описание

Тип

Обязательный

Пример

ClientParcelNumber

Номер посылки в системе клиента (может быть равен ParcelBarcode, если генерация штрих-кода посылки идет на стороне клиента)

String(1..40)

Да

12345678901234

ErrorMessage

Текст ошибки

String (0..1024)

Нет

См. список ошибок

OperationResult

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

Integer

Да

  • 0 - Success

  • -1..n - ErrorCode

ParcelBarcode

Штрих-код для наклейки (нужно сохранять в системе клиента, т.к. все дальнейшее взаимодействие идет по этому номеру)

String(1..40)

Да

12345678901234




ParcelShop


Параметр

Описание

Тип

Пример

Address

Адрес ПВЗ

String(1..2048)

Маяковского ул., д.4а

AddressInfo

В текущей версии недоступно, записывается в ExtraParams

Описание маршрута

String(1..5096)

Остановка общественного транспорта ``Станция Лобня``. Транспорт: автобусы №: 1, 2, 9, 21, 48, маршрутные такси №: 1, 2, 9, 21. От остановки пройдите в сторону ТЦ Торговые Ряды. Войдите в Торговый Центр, пункт выдачи находится на втором этаже, в магазине бытовой техники и электроники ``Технотел``.

AddressUrl

Ссылка на схему проезда

String(1..1024)

https://pschooser.hermesrussia.ru/PSChooser/PSDetails?PSId=900223&BUId=1000

City

Город ПВЗ

String(1..256)

Лобня

CityCladrCode

Код города ПВЗ в КЛАДР 4.0

String(1..32)

5000001200000

ExtraParams

Зарезервированные дополнительные параметры для поддержки различных версий текущего API

ExtraParam[]




Latitude

Широта ПВЗ

Double

56.013809

Longitude

Долгота ПВЗ

Double

37.483535

MaxParcelOverallSize

Ограничение по максимальной сумме габаритов (пустое значение – ограничений нет), см

Nullable Integer

150

MaxParcelValue

Ограничение по максимальной сумме, которую получатель может внести для получения посылки (пустое значение – ограничений нет), руб.

Nullable Integer

15000

MaxParcelWeight

Ограничение по максимальному весу посылки(пустое значение – ограничений нет), кг.

Nullable Integer

10

MetroStation

Название ближайшей станции метро

String(1..255)

Сокол

District

Название округа или района ПВЗ

String(1..50)

Восточный

ParcelShopCode

Код ПВЗ в системе Hermes Russia

String(1..32)

900001

ParcelShopName

Название ПВЗ

String(1..64)

магазин Финская одежда

PaymentType

Тип приема платежей

String(1..100)

описание

PaymentType

Cash

RailwayStation

Название ближайшей ж/д станции

String(1..128)

Лобня

Region

Регион ПВЗ

String(1..128)

Московская область

Schedule

График работы ПВЗ

Schedule[]




Services

Массив оказываемых услуг

String[]

описание ServiceType

DIRECT_DELIVERY

UpdateTimestamp

Дата и время последнего обновления информации о ПВЗ. Необходимо анализировать эту дату, чтобы выявить обновившиеся с последнего запроса ПВЗ.

DateTime

2014-04-01T03:17:31;

Возможны варианты передачи даты в ответе в формате /Date(1449672181000+0300)/, как ее распознать, см. здесь


ZipCode

Почтовый индекс ПВЗ

String(1..32)

141730


PreadviceResult


Параметр

Описание

Тип

Обязательный

Пример

OperationResult

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

Integer

Да

  • 0 - Success

  • -1..n - ErrorCode

ErrorMessage

Текст ошибки

String (0..1024)

Нет

См. список ошибок


Status


Параметр

Описание

Тип

Пример

ExtraParams

Зарезервированные дополнительные параметры для поддержки различных версий текущего API

ExtraParam[]




ParcelBarcode

Штрих-код посылки

String(1..40)

12345678901234

RefuseReasonName

Наименование причины отказа

String(0..50)

Посылка повреждена

RefuseReasonSystemName

Системное наименование причины отказа

String(0..255)

REFUSED_BY_CUSTOMER_DAMAGED

StatusDeleteTimestamp

Дата и время удаления статуса

Nullable DateTime

2014-07-18T23:59:59.000

Возможны варианты передачи даты в ответе в формате /Date(1449672181000+0300)/, как ее распознать, см. здесь


StatusName

Название статуса

String (1..128)

Принята в пункте выдачи

StatusSystemName

Системное название статуса

String (1..128)

ARRIVED_AT_PARCEL_SHOP

StatusTimestamp

Дата и время проставления статуса

DateTime

2014-07-17T23:59:59.000

Возможны варианты передачи даты в ответе в формате /Date(1449672181000+0300)/, как ее распознать, см. здесь



ReturnInfo


Параметр

Описание

Тип

Пример

ClaimBarcode

Штрих-код на заявлении на возврат

String(0..40)

98312938129

ExtraParams

Зарезервированные дополнительные параметры для поддержки различных версий текущего API

ExtraParam[]




InsuranceValue

Оценочная стоимость посылки

Double

1490.00

ParcelBarcode

Штрих-код посылки. В случае «Экспресс-возврата» это штрих-код на упаковочном пакете

String(14..40)

12345678901234

ParcelshopCode

Номер ПВЗ, из которого возвращается эта посылка

String(0..6)

900176

ReturnTimestamp

Дата и время оформления возврата

Nullable DateTime

2014-07-18T21:59:59.000

Возможны варианты передачи даты в ответе в формате /Date(1449672181000+0300)/, как ее распознать, см. здесь


WaybillNumber

Номер накладной, в которую входит данная посылка

String(0..40)

2014072310460001

Weight

Масса посылки в граммах

Integer

2700


Schedule


Параметр

Описание

Тип

Пример

WeekDay

День недели.
0 – Воскресенье.
1 – Понедельник.
….
6 – Суббота.

Enum WeekDay

Monday

TimeIntervals

Массив временных интервалов

TimeInterval[]

{9:00,13:00}, {14:00,20:00}




From

Время начала периода включительно

DayTime

9:00

To

Время завершения периода включительно

DayTime

21:00


DayTime


Параметр

Описание

Тип

Пример

Hours

Часы

Byte

9

Minutes

Минуты

Byte

13


ExtraParam


Параметр

Описание

Тип

Пример

Name

Наименование параметра

String

SomeExtraParam

Value

Значение параметра

String

9ABC000


CurrencyCode


Код валюты, тип значения - строка

Значение

Описание

RUB

Рубли


PaymentType


Тип оплаты, тип значения - строка

Значение

Описание

Cash

Наличными через кассу

Terminal

Через терминал банка

CashAndCard

Наличными или банковскими картами через кассу




ServiceType


Тип предоставляемой услуги, тип значения - строка

Значение

Описание

Комментарий

DIRECT_DELIVERY

Доставка и выдача в ПВЗ

Указывается при создании/обновлении заказа, используется в услугах заказа

HOME_DELIVERY

Курьерская доставка

Недоступен в текущей версии

CUSTOMER_RETURN

Клиентский возврат из ПВЗ

Недоступен в текущей версии

HOME_RETURN

Возврат с курьерской доставки

Недоступен в текущей версии

HAND_OUT

Выдача в ПВЗ

Используется в услугах ПВЗ

HAND_OUT_IN_PARCEL_AUTOMATE

Выдача в почтомате

Используется в услугах ПВЗ

PARCEL_SHOP_STORAGE

Хранение в ПВЗ

Используется в услугах ПВЗ

PARCEL_AUTOMATE_STORAGE

Хранение в почтомате

Используется в услугах ПВЗ

Модуль API генерации наклеек
1   2   3   4   5   6   7   8   9   10   11

Похожие:

Версия документа iconПрограммно-технический комплекс «Меркурий-150» Версия 3, Версия 31,...
Система менеджмента качества компании-производителя сертифицирована в мировой сертификационной сети iqnet и имеет сертификат ведущего...

Версия документа iconПоложение о служебных командировках работников Челябинского государственного...
Федеральное агентство по образованию Государственное образовательное учреждение высшего профессионального образования «Челябинский...

Версия документа iconI. Формат описания передаваемого документа нбо (Версия 02)
Настоящий документ описывает требования к xml файлам передачи в электронном виде сведений о документе нбо, содержащемся в транспортном...

Версия документа iconМетодика заполнения полей (для библиотек, работающих в аибс, поддерживающих...
Производится полное библиографическое описание каждого документа, представляемого в мэб для размещения в сводном каталоге

Версия документа iconПо «Луч» Версия по 0 Москва, 2013
Настоящее Руководство пользователя лрм сэд нрд (по «Луч») описывает возможности клиентского рабочего места Системы электронного документооборота...

Версия документа iconСовременная Гуманитарная Академия Компьютерное средство обучения...
...

Версия документа iconМаршрут документа «Платежное поручение (пакет платежных поручений)»
«Требования к форматам файлов, используемых при взаимодействии между органами Федерального казначейства и участниками бюджетного...

Версия документа iconАнкета бенефициарного владельца юридического лица
Реквизиты документа, удостоверяющего личность: серия (при наличии) и номер документа, дата выдачи документа, наименование органа,...

Версия документа iconЗаконодательство предусмотрело три вида документа
С начала 2015 года Украина начнет официальный выпуск биометрических паспортов для своих граждан. Основной особенностью документа...

Версия документа iconРуководство Пользователя Редакция 0 2008 Содержание Статус документа 3 Введение 4
Данный документ представляет собой описание Интернет-версии системы Банк+Клиент ielba райффайзенбанка (версия 6). В нем рассматриваются...

Вы можете разместить ссылку на наш сайт:


Все бланки и формы на filling-form.ru




При копировании материала укажите ссылку © 2019
контакты
filling-form.ru

Поиск