WebAPI. Руководство по интеграции.

Оглавление.

Аннотация.

Документ содержит описание API методов, необходимых для интеграции с отправителями.

Версия 2.29

Список изменений

Версия	Дата	Изменение	Автор
0.1	12.02.2018	Документ создан.	Маишев П.Ю.
1.0	20.04.2018	Первая версия.	Маишев П.Ю.
1.1	21.05.2018	Добавлен метод HWB.Validate	Маишев П.Ю.
1.1	21.06.2018	Добавлены методы обновления информации о HWB	Маишев П.Ю.
2.0	16.07.2018	Стандартизированы названия методов	Маишев П.Ю.
2.1	28.08.2018	Добавлен метод LOC.GetLockers для получения списка постаматов и пунктов выдачи	Маишев П.Ю.
2.2	11.10.2018	Исправлена ошибка в описании HWB/Parcels/Items/UnitWeight (в описании было кг вместо грамм)	Маишев П.Ю.
2.3	15.10.2018	Убран протокол http	Маишев П.Ю.
2.4	15.11.2018	Изменен метод AUTH.Info	Маишев П.Ю.
2.5	15.01.2019	Дополнен метод LOC.GetLockers1) Вывод и возможность фильтрации по региону 2) Возможность фильтрации по нескольким состояниям постамата/пункта выдачи одновременно.	Маишев П.Ю.
2.6	08.02.2019	Исправлена ошибка в тексте с названием метода получения списка постаматов (было HWB.GetLockers вместо LOC.GetLockers)	Маишев П.Ю.
2.7	16.04.2019	Добавлен атрибут MaxSize для метода LOC.GetLockers	Маишев П.Ю.
2.8	17.04.2019	Добавлен новый код события (PCD)	Маишев П.Ю.
2.9	01.05.2019	Добавлены параметры подключения к тестовому серверу.	Маишев П.Ю.
2.10	08.05.2019	Добавлены новые коды событий (IDOK, IDCE, RIC, RPR)	Маишев П.Ю.
2.11	30.05.2019	Добавлен новый код событий (PDA)	Маишев П.Ю.
2.12	01.11.2019	Добавлены новые коды событий (CR2, CR3, HBA41, HBA42, HBA43, HBA44, HBA45, HBA46)	Маишев П.Ю.
2.13	06.11.2019	Добавлена информация по последней миле в HWB	Маишев П.Ю.
2.14	09.01.2020	В методы работы с манифестами добавлено поле ContractNumber.	Маишев П.Ю.
2.15	15.04.2021	Добавлены новые коды событий (CSW, ASF4, DOCOK, NWC, OH, SIR)Полностью обновлен метод получения списка постоматов и пунктов выдачи LOC.GetLockers
2.16	08.02.2022	Исправлены опечатки в названии статуса и номере ISO для кодов стран	Маишев П.Ю.
2.17	28.02.2022	Добавлен метод по печати этикеток	Маишев П.Ю.
2.18	05.03.2022	Добавлен ConsigmentNumber в передачу манифеста	Маишев П.Ю.
2.19	06.06.2022	Добавлен RewriteAll в метод HWB.UpdateSKUInfo	Маишев П.Ю.
2.20	30.06.2022	Добавлен атрибут Files в описание структуры JSON HWB, секция PersonalID	Маишев П.Ю.
2.21	11.07.2022	Добавлен почтовый индекс в вывод постаматов	Маишев П.Ю.
2.22	07.10.2022	Исправлено название поля для веса манифеста	Маишев П.Ю.
2.23	13.10.2022	Добавлен атрибут Files в описание структуры JSON HWB	Маишев П.Ю.
2.24	04.10.2023	Добавлено правило использования для всех методов обновления данных	Маишев П.Ю.
2.25	05.10.2023	Убраны лишние атрибуты из структуры HWB	Маишев П.Ю.
2.26	17.10.2023	Добавлены новые коды событий (ASF1, ASF2, ASF3, ASF5, CF1, CF3, CNP5, DS, NWCFG, NWCFM, NWCHM, OH, PIB, RPC, RPI, RSW, SPD, UT, WD, WFR)	Маишев П.Ю.
2.27	22.11.2023	Добавлен новый метод - HWB.GetWeight	Маишев П.Ю.
2.28	29.01.2024	Добавлен новый аттрибут для Items (HTSCodeExport)	Маишев П.Ю.
2.29	04.06.2024	Добавлен новый аттрибут для HWB - Incoterms	Маишев П.Ю.

Используемые термины и сокращения

Термин	Определение
JSON	Java Script Object Notation. Представляет собой формат, который использует текст, понятный человеку, для передачи данных, состоящих из пар атрибут – значение.
HWB	Home waybill
MAWB	Master avia waybill
Манифест	Документ, по которому передаются HWB. От отправителя принимаются входящие манифесты.
TBD	To be determined
Токен	текстовый ключ, который некоторый временной промежуток дает возможность вызывать методы API от имени получившего этот ключ пользователя.
–>	данные отсылаемые на сервер. (data sent to service)
<–	данные приходящие с сервера. (data coming from service)
Date	Дата в формате YYYY-MM-DD
DateTime	Дата и время в формате YYYY-MM-DDTHH:mm:ss или YYYY-MM-DDTHH:mm:ssTZ

Общее описание

Для клиентов существует возможность интеграции с ИС «Parcel Engine» для передачи данных по отправлениям (манифесты и пре-манифесты), а также для получения состояния отправлений. Для этого используется web-сервис Parcel Engine 2.0 (далее WebAPI).

WebAPI работает по протоколу https посредством POST запросов с данными в формате JSON. В данном руководстве все примеры приведены для подключения по протоколу http.

Сервера для доступа к функциям WebAPI:

Тестовый сервер: apitest.spsr.tech.

Адрес запросов к тестовому серверу: https://apitest.spsr.tech/

При тестировании необходимо использовать тестовый сервер и следующие данные для авторизации:

Логин: test

Пароль: test

Для загрузки отправлений и манифестов на тестовый сервер необходимо использовать следующие параметры:

ServiceCode: tst

ContractNumber: 9900000000

Для тестирования эти учетные данные и параметры одинаковы для всех клиентов. После тестирования, чтобы получить логин, пароль и другие параметры от рабочего сервера необходимо обратиться к персональному менеджеру.

Запрос.

Передаваемые данные должны иметь кодировку UTF-8.

В заголовке HTTP-запроса в параметре Content-Type необходимо указывать значение “application/json”.

Все передаваемые данные — простые объекты, сериализованные в JSON. Запрос — вызов определённого метода, предоставляемого WebAPI . Он должен содержать четыре обязательных свойства:

jsonrpc — всегда “2.0”.
method — Строка с именем вызываемого метода.
params — Массив объектов, которые должны быть переданы методу, как параметры.
id — Значение типа GUID, которое используется для установки соответствия между запросом и ответом.

В “params” передается необходимая информация для вызываемого метода.

Например, номер договора, номер отправления и другая информация, необходимая для успешной обработки запроса.

Для передачи информации необходимо послать запрос на специальный адрес (по протоколу https).

Ответ.

WebAPI должна отослать правильный ответ на каждый полученный запрос. Ответ должен содержать следующие свойства:

jsonrpc — всегда “2.0”.
result — Данные, которые вернул метод при корректном выполнении запроса. Если произошла ошибка во время выполнения метода, это свойство должно быть установлено в null.
error – объект содержащий ошибку при ошибочном результате обработки запроса. Если запрос был выполнен корректно, это свойство должно быть установлено в null.
id — То же значение, что и в запросе, к которому относится данный ответ.

Объект error:

code — Код ошибки. Коды ошибок перечислены в Приложении 2.
message — Текстовое сообщение об ошибке, если произошла ошибка во время выполнения метода, иначе null. Необязательное поле.
data — необязательное поле

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

Пример вызова метода.

Успешный:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “AUTH.Login”, “params”:{“username”:“test”,“password”:“test”}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}
<–	{“jsonrpc”:“2.0”, “error”: null, “result”: { “token”:“eyJleHAiOjE1MTMwMDQ0NTUsImlhdCI6MTUxMjk5ODQ1NSwiYWxnIjoiSFMyNTYifQ .eyJpZCI6NX0.OMxJDVWtQjdtqTv_GzxC0KQK1BcH8asJy9a7sgaPt0c”}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Не успешный:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “AUTH.Login”, “params”:{“username”:“test”,“password”:“tst”}, “id”: “dcff7921-7070-4318-b215-a54f77486101”}
<–	{“jsonrpc”:“2.0”, “error”: {“code”: -32003},“id”: “dcff7921-7070-4318-b215-a54f77486101”, “result”: null}

Последовательность вызова запросов WebAPI.

Общая схема работы.

Авторизация.

Получение сессии

Данный метод предназначен для получения JWT (JSON Web Token) токена для дальнейших запросов.

Название метода: AUTH.Login

Входные параметры:username" – имя пользователя, “password” - пароль

Пример успешного вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “AUTH.Login “, “params”:{“username”:“test”,“password”:“test”}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}
<–	{“jsonrpc”:“2.0”, “result”: { “token”:“eyJleHAiOjE1MTMwMDQ0NTUsImlhdCI6MTUxMjk5ODQ1NSwiYWxnIjoiSFMyNTYifQ .eyJpZCI6NX0.OMxJDVWtQjdtqTv_GzxC0KQK1BcH8asJy9a7sgaPt0c”}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

сервер вернул данные в result.token.

Пример неуспешного вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “AUTH.Login”, “params”:{“username”:“test”,“password”:“tst”}, “id”: “dcff7921-7070-4318-b215-a54f77486101”}
:-	:-
<–	{“jsonrpc”:“2.0”, “error”:{“code”: -32003},“id”: “dcff7921-7070-4318-b215-a54f77486101”, “result”: null}

Пример https запроса получения сессии при помощи curl.

curl -X POST -H “Content-Type: application/json” -d ‘{“jsonrpc”:“2.0”, “method”: “AUTH.Login”, “params”:{“username”:“test”,“password”:“test”}, “id”:“dcff7921-7070-4318-b215-a54f77486101”}’ https://apitest.spsr.tech/

Время жизни полученного токена 60 минут от момента получения.

При использовании функций, требующих авторизации, результат работы будет зависеть от прав владельца токена. При неправильном логине или пароле, токен получен не будет, метод вернет ошибку code -32003. При вызове методов, требующих авторизации, токен используется в Authorization header используя Bearer schema.

Authorization: Bearer

Завершение сессии.

Название метода: AUTH.Logout

Требует авторизации токеном.

Пример успешного вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “AUTH.Logout”, “params”:{}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}
<–	{“jsonrpc”:“2.0”, “result”: null, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Функция прекращает действие переданного токена, далее этот токен не может использоваться при вызове функций с ограниченным доступом.

Информация о сессии

Название метода: AUTH.Info

Требует авторизации токеном.

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “AUTH.Info”, “params”:{}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}
<–	{“jsonrpc”:“2.0”, “result”: { “email”:“test”, “id”: 519136, “username”: “API Test”}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Возвращает json с информацией о пользователе, для которого выдан токен.

При некорректном или просроченном токене возвращается ошибка.

API передачи информации по HWB и манифестам.

Загрузка информации по HWB

Требует авторизации токеном.

Параметр method может принимать следующие значения:

HWB.Validate
HWB.Upload
HWB.UpdateReceiverInfo
HWB.UpdateReceiverID
HWB.UpdateParcelInfo
HWB.UpdateSKUInfo

HWB.Validate

Метод предназначен для проверки (необязательной) HWB перед загрузкой.

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “HWB.Validate”, “params”:{<Параметры>}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Параметры содержат следующие аргументы:

Параметр	Описание	M	Тип
{
HWB:[]	Список проверяемых HWB. Формат JSON для HWB описан в Приложении 3.	Y	JSON
}

HWB.Upload

Метод предназначен загрузки HWB.

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “HWB.Upload”, “params”:{<Параметры>}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}
Параметры содержат следующие аргументы:

Параметр	Описание	M	Тип
{
Synch	False - асинхронная обработка. Возвращается только информация (id документа, md5) по входному JSON. Дальше по id документа можно получить состояние обработки.True – Синхронная обработка. Возвращается сразу вся информацию (включая трек-номер и его соответствие номеру клиента). При синхронной обработке существует ограничение на количество HWB – не более 50000.	Y	Bool
ContractNumber	Индивидуальный номер договора.	Y	Char(20)
Author	Автор запроса.	N	Char(128)
TotalWeigth	Общий вес HWB, грамм	Y	Int
TotalVolume	Общий объем HWB, м3	Y	Float
TotalCOD	Общая сумма HWB, RUB	Y	Numeric(10,3)
HWBQty	Количество HWB.	Y	Int
Sender	Отправитель груза.	N	Char(128)
Receiver	Получатель груза.	N	Char(128)
HWB:[]	Список загружаемых HWB. Формат JSON для HWB описан в Приложении 3.	Y	JSON
}

Ответ на асинхронный запрос:

Направление	Запрос/ответ
<–	{“jsonrpc”:“2.0”, “result”: { “DocId”:“5”, “md5”:” 8928d0a9e0f5d9fcd2a4b466707f0b11”}, “id”: " c52f1b33-b0d9-41a6-ae54-57f0e4aef17b"}

DocId - служит для последующего запроса состояния обработки. md5 - хеш JSON params. Хеш рассчитывается по очищенному JSON и служит, в том числе для исключения дублирования информации.

Ответ на синхронный запрос:

Направление	Запрос/ответ
<–	{“jsonrpc”:“2.0”, “result”: { “DocId”:“5”, “md5”:“8928d0a9e0f5d9fcd2a4b466707f0b11”, “HWB”:[{“HWBNumber”: “GBS000000000001”, “HWBRefNumber”: “XXXXXX” }, ….]}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

HWB - служит для передачи соответствия между HWBRefNumber и HWBNumber.

При загрузке информации по HWB возможны следующие ошибки:

TBD.

HWB.UpdateReceiverInfo

Метод предназначен обновления информации о получателе.

Для использования данного метода необходимо согласовать с менеджером СОП (стандартную операционную процедуру), в которой явно должно быть указана необходимость данного метода для взаимодействия между компаниями

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “HWB.UpdateReceiverInfo”, “params”:{<Параметры>}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Параметры содержат следующие аргументы:

Параметр	Описание	M	Тип
{
HWB:[]	Список HWB для обновления информации. Формат JSON для HWB описан в Приложении 3. В данном методе используется секция ReceiverInfo.	Y	JSON
}

HWB.UpdateReceiverID

Метод предназначен обновления информации о паспортных данных получателя.

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “HWB.UpdateReceiverID”, “params”:{<Параметры>}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Параметры содержат следующие аргументы:

Параметр	Описание	M	Тип
{
HWB:[]	Список HWB для обновления информации. Формат JSON для HWB описан в Приложении 3. В данном методе используется секция ReceiverInfo/PersonalData.	Y	JSON
}

HWB.UpdateParcelInfo

Метод предназначен обновления информации о посылках.

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “HWB.UpdateParcelInfo”, “params”:{<Параметры>}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Параметры содержат следующие аргументы:

Параметр	Описание	M	Тип
{
HWB:[]	Список HWB для обновления информации. Формат JSON для HWB описан в Приложении 3. В данном методе используется секция Parcels.	Y	JSON
}

HWB.UpdateSKUInfo

Метод предназначен обновления информации о содержимом посылки.

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “HWB.UpdateSKUInfo”, “params”:{<Параметры>}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Параметры содержат следующие аргументы:

Параметр	Описание	M	Тип
{
RewriteAll	Если true - все старые товары удаляются и создаются новые. Если false - то обновляются товары с таким же Description. По умолчанию - false	N	Bool
HWB:[]	Список HWB для обновления информации. Формат JSON для HWB описан в Приложении 3. В данном методе используется секция Parcels/Items.	Y	JSON
}

Загрузка манифеста

Требует авторизации токеном.

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “”, “params”:{<Параметры>}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

method может принимать значения: MNF.UploadNumbers и MNF.UploadFull.

Параметры для method MNF.UploadNumbers содержат следующие аргументы:

Параметр		Описание	M	Тип
{
ManifestDate		Дата создания манифеста	Y	DateTime
ManifestNumber		Номер манифеста. Для MAWB – номер MAWB.	Y	Char(128)
HaulNumber		Номер рейса. Для MAWB – Flight Number.	N	Char(50)
ContractNumber		Индивидуальный номер договора.	Y	Char(20)
Author		Автор манифеста.	N	Char(128)
ManifestWeight		Общий вес манифеста, грамм	Y	Int
ManifestVolume		Общий объем манифеста, м3	Y	Float
HWBQty		Количество HWB	Y	Int
Sender		Отправитель груза	N	Char(128)
Receiver		Получатель груза	N	Char(128)
HWB:[		Список номеров HWB, включенных в манифест. Должен быть заполнен один из параметров HWBNumber или HWBRefNumber.	Y	JSON
	{		Y
	HWBNumber	Номер HWB	Y*	Char(20)
	HWBRefNumber	Клиентский номер HWB	Y*	Char(50)
	ConsigmentNumber	Номер консолидированного места	N	Char(128)
	}, …
]
}
Все HWB должны быть загружены в систему до вызова данного метода.

Параметры для method MNF.UploadFull содержат следующие аргументы:

Параметр	Описание	M	Тип
{
Synch	False - асинхронная обработка. Возвращается только информация (id документа, md5) по входному JSON. Дальше по id документа можно получить состояние обработки.True – Синхронная обработка. Возвращается сразу вся информацию (включая трек-номер и его соответствие номеру клиента)	Y	Bool
ContractNumber	Индивидуальный номер договора.	Y	Char(20)
ManifestDate	Дата создания манифеста	Y	DateTime
ManifestNumber	Номер манифеста. Для MAWB – номер MAWB.	Y	Char(128)
HaulNumber	Номер рейса. Для MAWB – Flight Number.	N	Char(50)
Author	Автор манифеста.	N	Char(128)
ManifestWeight	Общий вес манифеста, грамм	Y	Int
ManifestVolume	Общий объем манифеста, м3	Y	Float
TotalCOD	Общая сумма HWB по манифесту, RUB	Y	Numeric(10,3)
HWBQty	Количество HWB	Y	Int
HWB:[]	Список HWB, включенных в манифест. Формат JSON для HWB описан в Приложении 3.	Y	JSON
}

Синхронная и асинхронная обработка для method MNF.UploadFull происходит аналогично Загрузке информации по HWB.

API получения событий по HWB.

Получение событий в формате json.

Название метода: HWB.GetEvents Требует авторизации токеном.

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “HWB.GetEvents”, “params”:{<Параметры>}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Параметры содержат следующие аргументы:

Параметр			Описание	M	Тип
{
ContractNumber			ContractNumber по которому запрашиваются события. Если пусто, то запрос происходит по всем ContractNumber, доступным владельцу логина.	N	Char(12)
Filters:{				Y
	UseDates		Использовать или не использовать даты. Если “true” – то промежуток времени берется из параметров StartDate и EndDate. Если “false” – то выводятся события, полученные с последнего запроса с параметром “false”.	Y	Bool
	StartDate		Минимальная дата/время события.	N	Date
	EndDate		Максимальная дата/время события.	N	Date
	HWB:[		Список HWB, по которым запрашивается события. Если заполнено, то параметры UseDates и *Date игнорируются. Должен быть заполнен один из параметров HWBNumber или HWBRefNumber.	N	JSON
		{
		HWBNumber	Номер HWB	Y	Char(20)
		HWBRefNumber	Клиентский номер HWB	Y	Char(50)
		}, …
	]
}
TextLang			Язык на котором возвращается описание событий (ru или en). По умолчанию ru	N	Char(3)
TZ			Включать/не включать временные зоны в формат выходных дат	N	Bool
}

Ответ на запрос:

Направление	Запрос/ответ
<–	{“jsonrpc”:“2.0”, “result”: { [<список событий>]}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Формат списка событий:

Параметр	Описание	Тип
[
HWBNumber	Номер HWB	Char(20)
HWBRefNumber	Клиентский номер HWB	Char(50)
EventCode	Код события (см. Приложение 1)	Char(8)
EventComment	Комментарий к событию	Char(128)
EventText	Текст события на русском или английском языке.	Char(512)
EventPlace	Место события	Char(128)
Partner	Партнер, от которого получено событие	Char(128)
EventTime	Дата/время события.	DateTime
]

API для получения списка постаматов и пунктов выдачи.

Получение списка постаматов и пунктов выдачи в формате json.Название метода: LOC.GetLockers

Требует авторизации токеном.

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “LOC.GetLockers”, “params”:{<Параметры>}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Параметры содержат следующие аргументы:

Параметр		Описание	M	Тип
{
Filters:{			N
	City	Город	N	Char() List
	CountryCode	Код Страны	N	Char() List
	LockerContractorICN	ИКН провайдера постомата или пункта выдачи	N	Char() List
	LockerNumber	Номер постамата или пункта выдачи	N	Char() List
	LockerOwner	Владелец постамата или пункта выдачи	N	Char() List
	LockerType	Постамат или пункт выдачи	N	Char() List
	MaxBoxSize	Максимальный размер коробки	N	Char() List
	RegionCode	Код региона	N	Char() List
	Status	Статус (доступные: New, Open, Closed, Full)	N	Char() List
}
}

Параметры могут передаваться как отдельной строкой, так и списком строк в квадратных скобках. Пример JSON с заполненным фильтром, ниже:

Направление	Запрос/ответ
–>	{ “id”: " c52f1b33-b0d9-41a6-ae54-57f0e4aef17b", “method”: “LOC.GetLockers”, “params”: { “Filters”: { “Status”: “Open”, “City”: [“Белгород”, “Балашиха”], “LockerType”: “ПВЗ” } }}
Ответ на запрос:

Направление	Запрос/ответ
<–	{“jsonrpc”:“2.0”, “result”: [<список постаматов>], “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Формат списка постаматов или пунктов выдачи:

Параметр		Описание	M	Тип
{
	LockerNumber	Номер постамата или пункта выдачи	N	Char()
	Address	Адрес	N	Char()
	PostalCode	Почтовый индекс	N	Char()
	City	Город	N	Char()
	Country	Страна	N	Char()
	CountryCode	Код Страны	N	Char()
	Region	Регион	N	Char()
	RegionCode	Код региона	N	Char()
	LockerContractor	Провайдер постомата или пункта выдачи	N	Char()
	LockerContractorICN	ИКН провайдера постомата или пункта выдачи	N	Char()
	LockerOwner	Владелец постамата или пункта выдачи	N	Char()
	LockerType	Постамат или пункт выдачи	N	Char()
	Latitude	Широта	N	Char()
	Longitude	Долгота	N	Char()
	MaxBoxSize	Максимальный размер коробки	N	Char()
	MaxSize	Максимальный размер ячейки в формате сумма измерений или “длина x ширина x глубина”	N	Char()
	Payments	Возможность COD	N	Char()
	Schedule:	Расписания работы точки	N	Char()
	[
	{
	Close At	Время закрытия	N	Char()
	Day	День недели (1- понедельник, 7- воскресенье)	N	Char()
	OpenAt	Время открытия	N	Char()
	}, …
	]
	Status	Статус (доступные: New, Open, Closed, Full)	N	Char()
}

При использовании данного АПИ для вывода постаматов и точек выдачи на карте необходимо руководствоваться приложением 5 по стилю вывода геометок партнеров в соответствии с LockerContractorICN партнера.

Печать этикеток

Требует авторизации токеном аналогично другим методам. Для печати этикеток используется GET запрос со следующими параметрами:

<base URL>/label?hwbRefNumber=<HWB Ref Number>&template=label_hwb.html

Где:

<base URL> - базовый адрес для вызова АПИ (тестового или рабочего)
<HWB Ref Number> - номер ранее загруженного отправления.

API для получения веса и габаритов отправления.

Получение веса и габаритов отправления в формате json. Название метода: HWB.GetWeight

Требует авторизации токеном.

Для использования данного метода необходимо согласовать с менеджером доступ к данному методу

Пример вызова:

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “HWB.GetWeight”, “params”:{“HWB”: [{“HWBRefNumber”: “refnumber1”}, {“HWBRefNumber”: “refnumber2”}]}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Параметры содержат массив объектов с отправлениями, по которым надо получить вес и габариты. Элемент массива имеет вид: {"HWBRefNumber": "refnumber"}

Направление	Запрос/ответ
<–	{“jsonrpc”:“2.0”, “result”: {“HWB”: [<список отправлений>]}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Формат элемента списка отправлений с весами:

Параметр			Описание	M	Тип
{
	HWBRefNumber		Клиентский номер отправки	Y	Char()
	HWBNumber		Номер отправки	Y	Char()
	Parcels: [			Y	Object() List
		{
		RefBarCode	Штрих код места отправления	Y	Char(50)
		Weight	Вес, грамм	Y	Int
		Width	Ширина, мм	Y	Int
		Depth	Высота, мм	Y	Int
		Length	Длина, мм	Y	Int
		}, …
	]
}

Приложение 1. Список возможных событий с отправлением.

Event place	Code	Описание события RU	Description EN
	NW	Получена информация об отправлении	Waybill’s information accepted
	NWC	Отменен	Cancelled
FM	CSW	Отправлено на склад 1-ой мили.	Sended to the 1st mile warehouse.
FM	WA	Принято на складе 1-ой мили.	Accepted in warehouse of the first mile provider.
FM	WD	Убыло со склада 1-й мили.	Departured from 1-st mile warehouse.
FM	NWCFG	Посылка отклонена перевозчиком, так как содержит запрещённые товары	Parcel rejected by carrier due to forbidden goods.
FM	NWCFM	Отменен на первой миле	Canceled on a first mile
FM	NWCHM	Посылка отклонена перевозчиком, так как содержит опасные материалы	Parcel rejected by carrier due to Hazard Materials.
FF	ZX	Обработано на складе перевозчика.	Processed in the warehouse of the carrier.
FF	ZC	Готово к вылету в страну получателя.	Ready for sending to the destination country
FF	RS	Покинуло страну происхождения	Departed country of origin
CC	AI	Прибыло в страну назначения.	Arrived at the destination country
CC	CF1	Отправление не прилетело	The package didn’t arrive
CC	CF3	Товары изъяты таможенными органами	Goods seized by customs authorities
CC	CNP5	Сбой информационной системы таможенных органов	Failure of the customs information system
CC	DS	Задержка вылета.	Departure delay.
CC	CT	Таможенный транзит	Customs transit
CC	CI	Прибыло на таможню.	Arrived at the customs
CC	OH	Временное хранение	On Hold
CC	CR	Выпущено таможенным органом.	Customs clearance complete
CC	CR2	Выпущено таможенным органом без платежей.	Customs clearance complete without payments
CC	CR3	Выпущено таможенным органом с платежом.	Customs clearance complete with payments
CC	RSW	Отправление готово к отгрузке со склада	The shipment is ready for departure from the warehouse
CC	CO	Убыло из таможни.	Released by customs
CC	PIB	Товар поврежден (повреждение упаковки груза)	The item is damaged(the outer packaging is broken)
CC	RPC	Отказ от уплаты таможенных платежей	Refusal to pay customs duties
CC	RPI	Отказ от предоставления информации получателем	Refusal to provide information by the recipient
CC	ASF	Проблема. Запрет от таможни или секюрити.	Problem. Prohibition from customs or security
CC	ASF1	Проблема. Товары не для личного пользования.	Problem. Products are not for personal usage
CC	ASF2	Проблема. Ссылка на товар не рабочая.	Problem. The URL to the product is incorrect
CC	ASF3	Проблема. Стоимость товара некорректна.	Problem. The product price is incorrect
CC	ASF4	Проблема. Необходимо подтверждение паспортных данных для таможни.	Problem. Passport data confirmation required for custom.
CC	ASF5	Проблема. Запрос документов и сведений от таможенных органов.	Problem. Request for documents and information from Customs
CC	HBA	Проблема. Задержано таможней.	Problem. Detained by customs.
CC	HBA41	Отказ в выпуске. Не для личного пользования.	Refusal to release. Not for personal use.
CC	HBA42	Отказ в выпуске. Не предоставлены документы.	Refusal to release. No necessary documents.
CC	HBA43	Отказ в выпуске технического характера.	Refusal to release. Technical reason.
CC	HBA44	Отказ в выпуске. Некорректные ПД.	Refusal to release. Incorrect ID.
CC	HBA45	Отказ в выпуске. Недействительные ПД.	Refusal to release. Invalid ID.
CC	HBA46	Отказ в выпуске. Иное.	Refusal to release. In other cases.
CC	ERT	Продление срока выпуска.	Extension of release dates.
CC	OH	Временное хранение	On Hold
CC	NOID	Проблема. Нет паспортных данных в момент check in на таможне.	Problem. No passport data on check-in stage
CC	IDOK	Паспортные данные собраны	ID data collected
CC	DOCOK	Документы для подачи в ТО представлены.	Documents for the Customs were submitted.
CC	IDCE	Время для сбора паспортных данных истекло	Time for ID data collecting expired
CC	RIC	Квитанция выставлена таможенным органом	Receipt Issued by the Customs
CC	RPR	Квитанция оплачена получателем	Receipt Paid by Recipient
CC	PCD	Отказ в выпуске(требуется уплата таможенных платежей)	Payment of customs duties is required
CC	PBA	Одобрено таможенным представителем	Broker Approved
CC	SIR	Передано на индивидуальное оформление клиенту.	Submitted for Individual Registration.
	SPD	Посылка подлежит уничтожению/утилизации по причине сильного повреждения	The parcel is subject to destruction/disposal due to severe damage
	UT	Утилизировано	Utilized
	IA	Информация об отправке получена конрагентом.	Waybill’s information accepted by the counterpart.
LM	CL	Принято контрагентом.	Accepted by the domestic currier.
LM	LI	Передано на linehaul	Accepted by linehaul
LM	ED	Планируемая дата доставки	Estimated delivery date
LM	OH	Временное хранение	On Hold
LM	LC	В процессе транспортировки	In transit
LM	LO	Принято с linehaul	Arrived from linehaul
LM	RSP	Прибыло в филиал получателя.	Arrived at the local delivery office
LM	RB	Прибыло в пункт назначения.	Delivered at the town of destination
LM	GD	Изменение на самовывоз при контакте с получателем.	Changed from courier to pickup in call to the recipient
LM	DC	Выдано в доставку.	Accepted by a courier
LM	BA	Не доставлено. Неправильный адрес	Undelivered. Wrong address.
LM	CA	Не доставлено. Офис закрыт.	Undelivered. The office is closed
LM	CM	Не доставлено. Получатель переехал.	Undelivered. The recipient has moved
LM	DD	Доставлено с повреждением.	Delivered with damage
LM	LL	Отправление в пункте выдачи.	Sending is in the pickup point or in the locker
LM	ND	Не доставлено.	Udelivered
LM	NH	Не доставлено. Получателя нет дома	Undelivered. The recipient is not at home
LM	OK	Доставлено.	Delivered
LM	PD	Частичная доставка.	Partial delivery
LM	RD	Отказ от отправления.	Refusal of the parcel
LM	SC	Передано для доставки контрагенту.	Accepted by third party for delivery
LM	UC	Не востребовано в пункте выдачи.	Unclaimed at the pickup office or at the locker
LM	CH	Не доставленное принято на склад.	Undelivered parcel accepted by the warehouse
LM	RE	Сформирован возврат.	Returned waybill is formed
LM	RC	В процессе возврата отправителю	Return in process
LM	RT	Возвращено отправителю	Returned to sender
LM	NOLC	Проблема. Не выбран пункт выдачи на момент прибытия в пункт доставки и услуге C&C.	Problem. No pickup office or locker chosen at time of arrival to the delivery point for waybill with C&C service
LM	WP	Проблема. Некорректный телефон.	Problem. Phone number is incorrect
LM	WFR	Ожидается согласование повторной доставки.	Waiting for repickup.
IN	AC	Звонок получателю. Согласован самовывоз.	Call to the recipient. Pickup agreed.
IN	AD	Согласована дата доставки.	Delivery date agreed
IN	CU	Не удалось дозвониться.	Failed to reach the recipient
IN	PC	Попало на прозвон.	Waiting for the coordination of the delivery date
IN	RBA	Отказ при прозвоне.	Refusal in call to the recipient
	PE	Проблема.	Problem.
	PL	Посылка потеряна.	Parcel is lost.
	ZZ	Направлено повторное оповещение получателю.	Repeated notification sent to the consignee.

Приложение 2. Список кодов ошибок.

Код	Сообщение	Описание
-32700	Ошибка парсинга	Получен некорректный JSON.
-32600	Ошибка запроса	Неправильный формат JSON.
-32601	Метод не найден	Указанного метода не существует.
-32602	Неправильные параметры	Неправильные параметры указанного метода.
-32603	Внутренняя ошибка.	Внутренняя ошибка JSON-RPC.
-32001	Токен просрочен	В запросе используется просроченный токен.
-32002	Неизвестный токен	В запросе используется неизвестный токен.
-32003	Неправильный логин/пароль	AUTH.Login: Неправильный логин/пароль

Приложение 3. Вид JSON HWB.

Структура JSON				Описание	M	Тип
{
HWBRefNumber				Клиентский номер HWB	Y	Char(50)
OrderDate				Дата заказа/HWB	N	DateTime
ConsigmentNumber				Номер консолидированного места (только для method MNF.UploadFull)	N	Char(128)
DeliveryComments				Комментарии по доставке	N	Char(512)
ContractNumber				Клиентский номер договора HWB	Y	Char(12)
CODIndicator				Есть(1)/нет(0) COD	N	Int
ChargeableSum				Сумма COD в валюте страны получателя. Для России всегда в RUB	N	Numeric(10,3)
ServiceCode				Код основной услуги	Y	Char(8)
ParcelQty				Количество посылок в HWB	Y	Int
HWBWeight				Вес HWB, грамм	Y	Int
GoodsCurrency				Валюта стоимости товара HWB ISO4217	Y	Char(3)
DeclaredValue				Оценочная стоимость HWB	Y	Numeric(10,3)
DeclaredCurrency				Валюта оценочной стоимости ISO4217	Y	Char(3)
LastMileInfo: {				Информация по последней миле	N	JSON
	Contractor			Наименование контрагента	Y	Char(128)
	ContractorICN			Номер договора контрагента	N	Char(12)
}
Incoterms				Incoterms - EXW, FCA, FAS, FOB, CFR, CIF, CPT, CIP, DAP, DPU, DDP. По умолчанию DDP	N	Char(3)
AdditionalServices:[				Дополнительные сервисы (массив значений)	N	JSON
	ServiceCode			Код дополнительного сервиса	N	Char(8)
]
HWBExtras:[				Дополнительные параметры в формате: [{ExtraKey:key, ExtraValue:value},…]	N	JSON
	ExtraKey				Y	Char(64)
	ExtraValue				Y	Char(128)
]
Files :[				Изображения документов	N	List
	{
		Data		Стандартный Base64 с изображениями	Char	Y
		FileName		Наиметование файла	Char	Y
		Metadata :{		Дополнительная информация	Y	JSON
			Description	Описание документа	Y	Char
			Source	Должно быть “External”	Y	Char
		}
	}
]
SenderInfo: {				Информация об отправителе	Y	JSON
	Name			ФИО отправителя	Y	Char(128)
	Phone			Телефон	N	Char(20)
	MobilePhone			Мобильный телефон	N	Char(20)
	Email			Email	N	Char(50)
	AddressRB			Справочник, из которого получен код адреса	N	Char(8)
	AddressCode			Код адреса отправителя	N	Char(20)
	ExtraContact: [			Дополнительные контакты. Мессенджеры, соцсети и т.д.	N	JSON
		{
		ContactType		Тип контакта	Y	Char(32)
		ContactNumber		Номер контакта	Y	Char(128)
		}, …
	]
	SenderAddress : {			Адрес отправителя	Y	JSON
		CountryCode		Код страны ISO3166 alpha2	Y	Char(2)
		RegionCode		Код региона ISO3166-2	N	Char(8)
		City		Город	Y	Char(100)
		PostCode		Индекс	N	Char(16)
		District		Район	N	Char(100)
		Street		Улица	Y	Char(256)
		Building		Номер дома	Y	Char(20)
		Company		Компания	N	Char(128)
		Latitude		Широта	N	Float
		Longitude		Долгота	N	Float
		LockerID		ID пункта сбора/постамата	N	Char(16)
	}
}
ReceiverInfo: {				Информация о получателя	Y	JSON
	Name			ФИО получателя	Y	Char(128)
	Phone			Телефон	N	Char(20)
	MobilePhone			Мобильный телефон	Y	Char(20)
	Email			Email	N	Char(50)
	AddressRB			Справочник, из которого получен код адреса	N	Char(5)
	AddressCode			Код адреса получателя	N	Char(20)
	ReceiverCode			Код получателя	N	Char(20)
	ExtraContact: [			Дополнительные контакты. Мессенджеры, соцсети и т.д.	N	List
		{
		ContactType		Тип контакта	Y	Char(32)
		ContactNumber		Номер контакта	Y	Char(128)
		}, …
	]
	ReceiverAddress : {			Адрес получателя	Y	JSON
		CountryCode		Код страны ISO3166 alpha2	Y	Char(2)
		RegionCode		Код региона ISO3166-2	N	Char(8)
		City		Город	Y	Char(100)
		PostCode		Индекс	N	Char(16)
		District		Район	N	Char(100)
		Street		Улица	Y	Char(256)
		Building		Номер дома	Y	Char(20)
		Company		Компания	N	Char(128)
		Latitude		Широта	N	Float
		Longitude		Долгота	N	Float
		LockerID		ID пункта выдачи/постамата	N	Char(16)
	}
	PersonalData : {			Персональные данные для таможенного оформления	N	JSON
		IDNumber		Серия и номер документа	Y	Char(16)
		IDDocType		Тип документа	Y	Char(50)
		IDIssueDate		Дата выдачи документа	Y	Date
		FullName		Полное имя (как в документе)	Y	Char(128)
		IdentityCardGiven		Кем выдан документ	Y	Char(512)
		TaxNumber		ИНН	Y	Char(16)
		BirthDate		Дата рождения	N	Date
		Gender		Пол	N	Char(1)
		Files :[		Изображения документов	N	List
			{
			Data	Стандартный Base64 с изображениями	Char	Y
			FileName	Наиметование файла	Char	Y
			Metadata :{	Дополнительная информация	Y	JSON
			Picid	1 для паспорта, 2 для остальных докуметов	Y	Char
			Doctype	21 для российского паспорта, 10 для остальных документов	Y	Char
			Source	Должно быть “External”	Y	Char
			}
			}
	}
}
Parcels: [				Посылки по HWB	Y	List
	{
	BarCode			Штрих код посылки	N	Char(20)
	RefBarCode			Штрих код отправителя посылки	Y	Char(64)
	Weight			Вес, грамм	Y	Int
	ParcelNo			Номер по порядку	N	Int
	Width			Ширина, мм	N	Int
	Depth			Высота, мм	N	Int
	Length			Длина, мм	N	Int
	Description			Описание	Y	Char(512)
	ParcelExtras:{			Дополнительные параметры в формате	N	JSON
	}
	Items:[			Содержимое посылки	N	List
		{
		Description		Описание товара	Y	Char(128)
		UnitValue		Стоимость единицы товара	Y	Numeric(10,3)
		CountryOfOrigin		Страна происхождения в формате ISO 3166 alpha2	Y	Char(2)
		UnitWeight		Вес одной единицы товара, грамм	Y	Int
		Quantity		Количество единиц товара	Y	Int
		DetailedDescription		Детальное описание товара	N	Char(1024)
		ConstructionComposition		Состав изделия	N	Char(1024)
		URL		Ссылка на товар в интернет-магазине	Y	Char(1024)
		HTSCode		Коды ТНВЭД	N	Char(32)
		HTSCodeExport		HS Код для экспорта	N	Char(32)
		VATRate		Величина налога	N	Int
		SKUBarcode		Штрихкод товара	N	Char(50)
		ItemExtras:{		Дополнительные параметры в формате	N	JSON
		}
		}, …
	]
}, …
]
}

Пример json с данными HWB.

{
    "jsonrpc": "2.0",
    "method": "HWB.Upload",
    "params": {
        "Synch": true,
        "TotalWeight": 7800,
        "TotalVolume": 0,
        "TotalCOD": 0,
        "HWBQty": 5,
        "ContractNumber": "9900000000",
        "HWB": [
            {
                "OrderDate": "2022-11-11 11:11:11+03:00",
                "HWBRefNumber": "SPSR01RU",
                "DeclaredValue": 210.77,
                "DeclaredCurrency": "USD",
                "ServiceCode": "tst",
                "ParcelQty": 1,
                "SenderInfo": {
                    "Name": "Test LLC",
                    "SenderAddress": {
                        "Company": "Test LLC",
                        "CountryCode": "US"
                    }
                },
                "ReceiverInfo": {
                    "Name": "Сидоров Сидор Сидорович",
                    "MobilePhone": "+71111111111",
                    "Phone": "",
                    "Email": "info@spsr.tech",
                    "PersonalData": {
                        "FullName": "Сидоров Сидор Сидорович",
                        "IDDocType": "Паспорт",
                        "IDIssueDate": "2004-08-31",
                        "IDNumber": "1111 111111",
                        "IdentityCardGiven": "ОТДЕЛЕНИЕМ МИЛИЦИИ ГОРОДА Москвы",
                        "TaxNumber": "111111111130",
                        "BirthDate": ""
                    },
                    "ReceiverAddress": {
                        "Building": "",
                        "City": "Москва",
                        "Street": "Партийный проезд, д.1, кор. 11",
                        "District": "",
                        "Company": "",
                        "CountryCode": "RU",
                        "LockerID": "",
                        "PostCode": "",
                        "Region": ""
                    }
                },
                "Parcels": [
                    {
                        "Weight": 1560,
                        "ParcelNo": 1,
                        "RefBarCode": "SPSR01RU",
                        "Items": [
                            {
                                "Quantity": 1,
                                "UnitValue": 26.79,
                                "Description": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "DetailedDescription": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "URL": "https://www.amazon.com/gp/product/B07J5Q4KJN/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 10.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07GX33WVR/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 320,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 7.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07HRYZFN3/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 330,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 90,
                                "Description": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "URL": "http://www.ebay.com/itm/293217815646",
                                "HTSCode": "",
                                "UnitWeight": 290,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 75,
                                "Description": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "URL": "https://www.ebay.com/itm/254342810565",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            }
                        ]
                    }
                ],
                "ContractNumber": "9900000000",
                "HWBWeight": 1560
            },
            {
                "OrderDate": "2022-11-11 11:11:11+03:00",
                "HWBRefNumber": "SPSR02RU",
                "DeclaredValue": 210.77,
                "DeclaredCurrency": "USD",
                "ServiceCode": "tst",
                "ParcelQty": 1,
                "SenderInfo": {
                    "Name": "Test LLC",
                    "SenderAddress": {
                        "Company": "Test LLC",
                        "CountryCode": "US"
                    }
                },
                "ReceiverInfo": {
                    "Name": "Иванов Иван Иванович",
                    "MobilePhone": "+71111111111",
                    "Phone": "",
                    "Email": "info@spsr.tech",
                    "PersonalData": {
                        "FullName": "Иванов Иван Иванович",
                        "IDDocType": "Паспорт",
                        "IDIssueDate": "2004-08-31",
                        "IDNumber": "1234 567890",
                        "IdentityCardGiven": "ОТДЕЛЕНИЕМ МИЛИЦИИ ГОРОДА Москвы",
                        "TaxNumber": "111111111111",
                        "BirthDate": ""
                    },
                    "ReceiverAddress": {
                        "Building": "",
                        "City": "Москва",
                        "Street": "Партийный проезд, д.1, кор. 11",
                        "District": "",
                        "Company": "",
                        "CountryCode": "RU",
                        "LockerID": "",
                        "PostCode": "",
                        "Region": ""
                    }
                },
                "Parcels": [
                    {
                        "Weight": 1560,
                        "ParcelNo": 1,
                        "RefBarCode": "SPSR02RU",
                        "Items": [
                            {
                                "Quantity": 1,
                                "UnitValue": 26.79,
                                "Description": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "DetailedDescription": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "URL": "https://www.amazon.com/gp/product/B07J5Q4KJN/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 10.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07GX33WVR/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 320,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 7.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07HRYZFN3/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 330,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 90,
                                "Description": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "URL": "http://www.ebay.com/itm/293217815646",
                                "HTSCode": "",
                                "UnitWeight": 290,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 75,
                                "Description": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "URL": "https://www.ebay.com/itm/254342810565",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            }
                        ]
                    }
                ],
                "ContractNumber": "9900000000",
                "HWBWeight": 1560
            },
            {
                "OrderDate": "2022-11-11 11:11:11+03:00",
                "HWBRefNumber": "SPSR03RU",
                "DeclaredValue": 210.77,
                "DeclaredCurrency": "USD",
                "ServiceCode": "tst",
                "ParcelQty": 1,
                "SenderInfo": {
                    "Name": "Test LLC",
                    "SenderAddress": {
                        "Company": "Test LLC",
                        "CountryCode": "US"
                    }
                },
                "ReceiverInfo": {
                    "Name": "Петров Петр Петрович",
                    "MobilePhone": "",
                    "Phone": "",
                    "Email": "ceo@spsr.tech",
                    "PersonalData": {
                        "FullName": "Петров Петр Петрович",
                        "IDDocType": "Паспорт",
                        "IDIssueDate": "2004-08-31",
                        "IDNumber": "1111 111111",
                        "IdentityCardGiven": "ОТДЕЛЕНИЕМ МИЛИЦИИ ГОРОДА Москвы",
                        "TaxNumber": "111111111111",
                        "BirthDate": ""
                    },
                    "ReceiverAddress": {
                        "Building": "",
                        "City": "Москва",
                        "Street": "Партийный проезд, д.1, кор. 11",
                        "District": "",
                        "Company": "",
                        "CountryCode": "RU",
                        "LockerID": "",
                        "PostCode": "",
                        "Region": ""
                    }
                },
                "Parcels": [
                    {
                        "Weight": 1560,
                        "ParcelNo": 1,
                        "RefBarCode": "SPSR03RU",
                        "Items": [
                            {
                                "Quantity": 1,
                                "UnitValue": 26.79,
                                "Description": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "DetailedDescription": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "URL": "https://www.amazon.com/gp/product/B07J5Q4KJN/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 10.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07GX33WVR/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 320,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 7.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07HRYZFN3/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 330,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 90,
                                "Description": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "URL": "http://www.ebay.com/itm/293217815646",
                                "HTSCode": "",
                                "UnitWeight": 290,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 75,
                                "Description": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "URL": "https://www.ebay.com/itm/254342810565",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            }
                        ]
                    }
                ],
                "ContractNumber": "9900000000",
                "HWBWeight": 1560
            },
            {
                "OrderDate": "2022-11-11 11:11:11+03:00",
                "HWBRefNumber": "SPSR04RU",
                "DeclaredValue": 210.77,
                "DeclaredCurrency": "USD",
                "ServiceCode": "tst",
                "ParcelQty": 1,
                "SenderInfo": {
                    "Name": "Test LLC",
                    "SenderAddress": {
                        "Company": "Test LLC",
                        "CountryCode": "US"
                    }
                },
                "ReceiverInfo": {
                    "Name": "Сидоров Сидор Сидорович",
                    "MobilePhone": "+71111111111",
                    "Phone": "",
                    "Email": "info@spsr.tech",
                    "PersonalData": {
                        "FullName": "Сидоров Сидор Сидорович",
                        "IDDocType": "Паспорт",
                        "IDIssueDate": "2004-08-31",
                        "IDNumber": "1111 111111",
                        "IdentityCardGiven": "ОТДЕЛЕНИЕМ МИЛИЦИИ ГОРОДА Москвы",
                        "TaxNumber": "111111111130",
                        "BirthDate": ""
                    },
                    "ReceiverAddress": {
                        "Building": "",
                        "City": "Москва",
                        "Street": "Партийный проезд, д.1, кор. 11",
                        "District": "",
                        "Company": "",
                        "CountryCode": "RU",
                        "LockerID": "",
                        "PostCode": "",
                        "Region": ""
                    }
                },
                "Parcels": [
                    {
                        "Weight": 1560,
                        "ParcelNo": 1,
                        "RefBarCode": "SPSR04RU",
                        "Items": [
                            {
                                "Quantity": 1,
                                "UnitValue": 26.79,
                                "Description": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "DetailedDescription": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "URL": "https://www.amazon.com/gp/product/B07J5Q4KJN/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 10.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07GX33WVR/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 320,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 7.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07HRYZFN3/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 330,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 90,
                                "Description": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "URL": "http://www.ebay.com/itm/293217815646",
                                "HTSCode": "",
                                "UnitWeight": 290,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 75,
                                "Description": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "URL": "https://www.ebay.com/itm/254342810565",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            }
                        ]
                    }
                ],
                "ContractNumber": "9900000000",
                "HWBWeight": 1560
            },
            {
                "OrderDate": "2022-11-11 11:11:11+03:00",
                "HWBRefNumber": "SPSR05RU",
                "DeclaredValue": 210.77,
                "DeclaredCurrency": "USD",
                "ServiceCode": "tst",
                "ParcelQty": 1,
                "SenderInfo": {
                    "Name": "Test LLC",
                    "SenderAddress": {
                        "Company": "Test LLC",
                        "CountryCode": "US"
                    }
                },
                "ReceiverInfo": {
                    "Name": "Васильев Василий Васильевич",
                    "MobilePhone": "",
                    "Phone": "",
                    "Email": "integrator@spsr.tech",
                    "PersonalData": {
                        "FullName": "Васильев Василий Васильевич",
                        "IDDocType": "Паспорт",
                        "IDIssueDate": "2004-08-31",
                        "IDNumber": "1111 111111",
                        "IdentityCardGiven": "ОТДЕЛЕНИЕМ МИЛИЦИИ ГОРОДА Москвы",
                        "TaxNumber": "000000000000",
                        "BirthDate": ""
                    },
                    "ReceiverAddress": {
                        "Building": "",
                        "City": "Москва",
                        "Street": "Партийный проезд, д.1, кор. 11",
                        "District": "",
                        "Company": "",
                        "CountryCode": "RU",
                        "LockerID": "",
                        "PostCode": "",
                        "Region": ""
                    }
                },
                "Parcels": [
                    {
                        "Weight": 1560,
                        "ParcelNo": 1,
                        "RefBarCode": "SPSR05RU",
                        "Items": [
                            {
                                "Quantity": 1,
                                "UnitValue": 26.79,
                                "Description": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "DetailedDescription": "Детские джинсы, для девочки. Размер: 10 лет, Цвет: Голубой",
                                "URL": "https://www.amazon.com/gp/product/B07J5Q4KJN/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 10.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 / iPhone XR. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07GX33WVR/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 320,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 7.99,
                                "Description": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "DetailedDescription": "Защитное стекло для мобильного телефона iPhone 11 Pro / iPhone Xs / iPhone X. Упаковка из 2 шт.",
                                "URL": "https://www.amazon.com/gp/product/B07HRYZFN3/ref=ppx_od_dt_b_asin_title_s00?ie=UTF8&psc=1",
                                "HTSCode": "",
                                "UnitWeight": 330,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 90,
                                "Description": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 38 mm, Цвет: Серебристый, комплект ремешков, бывшие в употреблении. +пакетик фруктового мармелада +магнит на холодильник в подарок к заказу",
                                "URL": "http://www.ebay.com/itm/293217815646",
                                "HTSCode": "",
                                "UnitWeight": 290,
                                "CountryOfOrigin": "US"
                            },
                            {
                                "Quantity": 1,
                                "UnitValue": 75,
                                "Description": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "DetailedDescription": "Смарт часы Apple watch Series 1, 44 mm, Цвет: Розовый, бывшие в употреблении",
                                "URL": "https://www.ebay.com/itm/254342810565",
                                "HTSCode": "",
                                "UnitWeight": 310,
                                "CountryOfOrigin": "US"
                            }
                        ]
                    }
                ],
                "ContractNumber": "9900000000",
                "HWBWeight": 1560
            }
        ]
    },
    "id": "019e416c-f9c9-4fd7-47bc-8c668d78"
}

Приложение 4. Примеры обмена данными.

Запрос токена.

Направление	Запрос/ответ
–>	{“jsonrpc”:“2.0”, “method”: “AUTH.Login”, “params”:{“username”:“test”,“password”:“test”}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}
<–	{“jsonrpc”:“2.0”, “error”: null, “result”: { “token”:“eyJleHAiOjE1MTMwMDQ0NTUsImlhdCI6MTUxMjk5ODQ1NSwiYWxnIjoiSFMyNTYifQ .eyJpZCI6NX0.OMxJDVWtQjdtqTv_GzxC0KQK1BcH8asJy9a7sgaPt0c”}, “id”: “c52f1b33-b0d9-41a6-ae54-57f0e4aef17b”}

Приложение 5. Использование геометок партнеров.

PickPoint

Местонахождение всех пунктов выдачи (постаматы и пункты выдачи) посылок «PickPoint» должны быть отмечены фирменной иконкой геолокации.

5Post

Местонахождение всех пунктов выдачи (постаматы и выдача на кассе) посылок «5post» должны быть отмечены фирменной иконкой геолокации. Все постаматы 5post должны быть отмечены иконкой геолокации в форме капли в фирменном сером цвете:

Все пункты выдачи посылок 5post на кассе в магазине «Пятерочка» должны быть отмечены иконкой геолокации в форме капли в белом цвете с серым обводом:

Все пункты выдачи заказов компании 5post должны быть отмечены иконкой геолокации в форме капли в зеленом цвете с серым обводом:

В случае если вариант формы «капля» противоречит общей стилистике карты, клиент может использовать круглые иконки геолокации – в фирменном сером цвете для постаматов, в белом цвете с серым обводом для пунктов выдачи посылок 5Post на кассе в магазине «Пятерочка»: