Открыть список пунктов назначения
Можно получать разные типы пунктов назначения для интеграций.
Field Name | Description | Data type |
---|---|---|
Страна | Код страны (EE или FI) | Цепочка |
Тип | Тип пункта назначения: APT = посылочный терминал (по умолчанию) PO = почтовое отделение | Цепочка |
Фильтр | Дополнительная фильтрация: Экспресс = посылочные терминалы в Эстонии с возможностью экспресс-доставки | Цепочка |
ПОЛУЧИТЬ ЗАПРОС
Посылочные терминалы EE
http://iseteenindus.smartpost.ee/api/?request=destinations&country=EE&type=APT
Посылочные терминалы EE с возможностью экспресс-доставки
http://iseteenindus.smartpost.ee/api/?request=destinations&country=EE&type=APT&filter=express
Посылочные терминалы FI
http://iseteenindus.smartpost.ee/api/?request=destinations&country=FI&type=APT
Почтовые отделения FI
http://iseteenindus.smartpost.ee/api/?request=destinations&country=FI&type=PO
ОТВЕТ
Field Name | Description | Data type |
---|---|---|
ID_места | ID посылочного терминала — использовать только для пунктов назначения EE! | Номер |
Имя | Название пункта назначения | Цепочка |
Город | Город в пункте назначения | Цепочка |
Адрес | Адрес получателя | Цепочка |
Страна | Код страны получателя | Цепочка |
Почтовый индекс | Почтовый индекс пункта назначения | Цепочка |
Код маршрутизации | Код маршрутизации в пункте назначения | Цепочка |
Доступность | Период, в течение которого место открыто | Цепочка |
Описание | Краткое описание места | Цепочка |
Шир. | Широта | Номер |
Дол. | Долгота | Номер |
<destinations>
<item>
<place_id>number</place_id>
<name>string</name>
<city>string</city>
<address>string</address>
<country>string</country>
<postalcode>string</postalcode>
<routingcode>string</routingcode>
<availability>string</availability>
<description>string</description>
<lat>number</lat>
<lng>number</lng>
</item>
<item>
…
</item>
</destinations>
Получить список времени посещения курьерами (только посылочные терминалы EE)
ПОЛУЧИТЬ ЗАПРОС
Время посещения курьерами всех посылочных терминалов EE
http://iseteenindus.smartpost.ee/api/?request=courier
Время посещения курьерами посылочных терминалов EE с возможностью экспресс-доставки
http://iseteenindus.smartpost.ee/api/?request=courier&type=express
ОТВЕТ
Field Name | Description | Data type |
---|---|---|
ID_места | ID посылочного терминала | Номер |
День | Номер дня (1= понедельник) | Номер |
В | Время | |
Из | Время | |
Экспресс_в | Время | |
Экспресс_из | Время |
<destinations>
<item>
<place_id>Number</place_id>
<day>Number</day>
<in>Time</in>
<out>Time</out>
<express_in>Time</express_in>
<express_out>Time</express_out>
</item>
<item>
…
</item>
</destinations>
Сохранить данные поставки
АУТЕНТИФИКАЦИЯ
Информация об аутентификации бизнес-клиента — все запросы (кроме пунктов назначения) требуют добавления информации об аутентификации в данные POST.
Field Name | Description | Data type | Errors on |
---|---|---|---|
Пользователь | Имя пользователя | Цепочка | Неизвестный пользователь |
Пароль | Пароль пользователя | Цепочка | Имя пользователя и пароль не совпадают |
ОБЩЕЕ
Информация о поставке. Если графа «Штрихкод» не заполнена, штрихкод будет назначен автоматически. При отправке без услуги кода дверцы размер ячейки не учитывается, поскольку сортировочная станция добавляет соответствующий размер для каждой посылки. Размер ячейки следует добавить только при отправке с услугой кода дверцы.
Field Name | Description | Data type | Errors on |
---|---|---|---|
Штрихкод | Штрихкод поставки | Цепочка | Дубликат; неправильный формат |
Ссылка | Ссылочный номер клиента | Цепочка | |
Содержание | Содержание поставки | Цепочка | |
Старший заказ | Штрихкод старшего заказа (если поставка содержит несколько посылок) | Цепочка | Неизвестный штрихкод (создайте старший заказ перед созданием младших заказов) |
Вес | Вес поставки | Номер | Неизвестный пользователь |
Размер | Размер ячейки (5–8 или 11) 11 — размер XS 5 — размер S 6 — размер M 7 — размер L 8 — размер XL | Номер | Неизвестный размер |
ОТПРАВИТЕЛЬ
Следующие графы следует заполнить при отправке с использованием услуги кода дверцы.
Field Name | Description | Data type | Errors on |
---|---|---|---|
Имя | Имя отправителя | Цепочка | |
Телефон | Телефонный номер отправителя | Цепочка | |
Эл. почта | Адрес эл. почты отправителя | Цепочка | Неправильный формат |
Наличные | Сумма, которую должен заплатить отправитель перед отправкой посылки | Номер | Неправильный формат |
Счет | Идентификатор счета бизнес-клиента | Номер |
ПОЛУЧАТЕЛЬ
Информация о получателе.
Field Name | Description | Data type | Errors on |
---|---|---|---|
Имя | Имя получателя | Цепочка | |
Телефон | Телефонный номер получателя | Цепочка | |
Эл. почта | Адрес эл. почты получателя | Цепочка | Неправильный формат |
Наличные | Сумма, которую должен заплатить получатель перед получением посылки | Номер | Услуга недоступна; неправильный формат |
ID-код | ID-код получателя; нужен если требуется ID-валидация. | Номер | Неправильный формат |
ПУНКТ НАЗНАЧЕНИЯ
Посылки можно отправлять с использованием 3 разных конфигураций:
— при отправке посылки в посылочный терминал EE следует заполнить «ID_места»;
— при отправке посылки в посылочный терминал FI или почтовое отделение FI следует заполнить «Почтовый индекс» и «Код маршрутизации»;
— при отправке посылки с использованием курьерской услуги следует заполнить «Улица», «Дом», «Квартира», «Город», «Страна», «Почтовый индекс», «Подробности» и «Период». Курьерская услуга сейчас доступна только в Эстонии.
— Когда весь адрес введен в графу «Улица», номер дома и/или квартиры выносятся в графы «Дом» и «Квартира», если они не заполнены. Когда графы «Дом» и/или «Квартира» заполнены, их содержание будет добавлено в базу данных вне зависимости от содержания графы «Улица».
Field Name | Description | Data type | Errors on |
---|---|---|---|
ID_места | ID посылочного терминала в Эстонии | Номер | Неизвестный пункт назначения |
Почтовый индекс | Почтовый индекс пункта назначения | Цепочка (15) | |
Код маршрутизации | Код маршрутизации в пункте назначения | Цепочка | |
Улица | Улица в пункте назначения | Цепочка (50) | |
Дом | Номер дома в пункте назначения | Цепочка (5) | |
Квартира | Номер квартиры в пункте назначения | Цепочка (50) | |
Город | Город в пункте назначения | Цепочка | |
Страна | Страна в пункте назначения | Цепочка | |
Подробности | Дополнительные данные о пункте назначения (например, третий этаж) | Цепочка | |
Период | Когда получатель может принять посылку от курьера: 1 = в любое время; 2 = 09.00–17.00; 3 = 17.00–21.00. | Цифра; по умолчанию 1 |
ОГРАНИЧЕННОЕ КОЛИЧЕСТВО (LQ)
В этом разделе описана процедура отправки информации об ограниченном количестве предметов в посылках
Field Name | Description | Data type | Errors on |
---|---|---|---|
продукт | Название продукта | Цепочка | |
номер ООН | Идентификационный номер по перечню опасных веществ ООН | Целое | |
название | Точное транспортное наименование (ADR) | Цепочка | |
класс | Классификационный номер опасного вещества | Цепочка | |
вид ярлыка | Номер модели ярлыков | Цепочка | |
группа упаковки | Номер группы упаковки опасного вещества | Нумерация: I, II, III | |
транспортная категория | Транспортная категория вещества или предмета | Нумерация: 0, 1, 2, 3, 4 | |
значение | Количество опасного вещества в одном продукте | Целое | |
единица | Единица измерения количества | г или мл | |
вес контейнера | Вес порожнего контейнера одной единицы (г) | Целое | |
счет | Общее количество предметов | Целое |
XML-пример одного или нескольких предметов LQ:
…
<lqitems>
<lqitem>
<product>String</product>
<unnumber>Integer</unnumber>
<name>String</name>
<class>String</class>
<labelmodel>String</labelmodel>
<packinggroup>Enumeration:I,II,III</packinggroup>
<transportcategory>Enumeration:0,1,2,3,4</transportcategory>
<amount>
<value>Integer</value>
<unit>g or ml</unit>
</amount>
<containerweight>Integer</containerweight>
<count>Integer</count>
</lqitem>
<lqitem>
…
</lqitem>
<lqitem>
…
</lqitem>
</lqitems>
…
ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ
Дополнительные услуги для клиентов Smartpost
Field Name | Description | Data type | Errors on |
---|---|---|---|
Экспресс | Услуга экспресс-доставки | Булеан | Услуга недоступна |
Проверка ID | Установление личности получателя | Булеан | Услуга недоступна; не заполнена графа «ID-код» в данных получателя |
Проверка возраста | Установление возраста получателя | Булеан | Услуга недоступна |
Эл. извещение | Адрес эл. почты для отправки (отправителю) извещения о доставке | Цепочка | Услуга недоступна; неправильный формат |
Телефонное извещение | Телефонный номер (GSM) для отправки (отправителю) извещения о доставке | Цепочка | Услуга недоступна |
Платит получатель | Получатель оплатит доставку | Булеан | Услуга недоступна |
ОТПРАВКА ЗАПРОСА
URL: http://iseteenindus.smartpost.ee/api/?request=shipment
Необязательная графа рапорта может содержать до 5 адресов эл. почты. Если графа заполнена, на указанные адреса эл. почты будет отправлен рапорт. Если указано более 5 адресов эл. почты то система отправит рапорты на 5 адресов и проигнорирует остальные.
<orders>
<authentication>
<user>string</user>
<password>string</password>
</authentication>
<report>
<email>string</email>
<email>…</email>
</report>
<item>
<barcode>string</barcode>
<reference>string</reference>
<content>string</content>
<orderparent>string</orderparent>
<weight>number</weight>
<size>number</size>
<sender>
<name>string</name>
<phone>string</phone>
<email>string</email>
<cash>number</cash>
<account>number</account>
</sender>
<recipient>
<name>string</name>
<phone>string</phone>
<email>string</email>
<cash>number</cash>
<idcode>number</idcode>
</recipient>
<destination>
<place_id>number</place_id>
<postalcode>string</postalcode>
<routingcode>number</routingcode>
<street>string</street>
<house>string</house>
<apartment>string</apartment>
<city>string</city>
<country>string</country>
<details>string</details>
<timewindow>number</timewindow>
</destination>
<lqitems>
<lqitem>
<product>String</product>
<unnumber>Integer</unnumber>
<name>String</name>
<class>String</class>
<labelmodel>String</labelmodel>
<packinggroup>I,II,III</packinggroup>
<transportcategory>0,1,2,3,4</transportcategory>
<amount>
<value>Integer</value>
<unit>g or ml</unit>
</amount>
<containerweight>Integer</containerweight>
<count>Integer</count>
</lqitem>
<lqitem>
…
</lqitem>
</lqitems>
<additionalservices>
<express>boolean</express>
<idcheck>boolean</idcheck>
<agecheck>boolean</agecheck>
<notifyemail>string</notifyemail>
<notifyphone>string</notifyphone>
<paidbyrecipient>boolean</paidbyrecipient>
</additionalservices>
</item>
<item>
…
</item>
</orders>
ОТВЕТ ПРИ УСПЕХЕ
Если запрос был успешно обработан, вы получите штрихкод предмета, соответствующий ссылочный номер и код дверцы для отправителя (если он воспользовался услугой отправки с кодом дверцы). Для получения кода дверцы следует предоставить данные отправителя.
Код статуса ответа: 200
<orders>
<item>
<barcode>string</barcode>
<reference>string</reference>
<sender>
<doorcode>number</doorcode>
</sender>
</item>
<item>
…
</item>
</orders>
ОТВЕТ ПРИ ОШИБКЕ
Если обязательные графы не будут заполнены (или будут введены неправильные типы данных), появится сообщение об ошибке. Если проблемная поставка является частью более крупной партии, ни одна из поставок в партии не будет обработана. XML-ответ будет содержать информацию об ошибках.
Код статуса ответа: 400
<error>
<item>
<barcode>string</barcode>
<reference>string</reference>
<error>
<code>number</code>
<text>string</text>
<input>string</input>
</error>
</item>
<item>
…
</item>
</error>
Ярлыки
Доступно несколько вариантов (A5, A6, A6 по 4 на страницу, A7, A7 по 8 на страницу).
ОБЩЕЕ
Field Name | Description | Data type |
---|---|---|
Формат | A5 A6 A6-4 A7 A7-8 | Цепочка |
Штрихкод | Штрихкоды поставок | Цепочка |
ОТПРАВКА ЗАПРОСА
URL: http://iseteenindus.smartpost.ee/api/?request=labels
<labels>
<authentication>
<user>string</user>
<password>string</password>
</authentication>
<format>String</format>
<barcode>string</barcode>
<barcode>…</barcode>
</labels>
Отслеживание и контроль
Поставки можно отслеживать индивидуально или в совокупности. Вы можете использовать штрихкод поставки или ссылочный номер для отправки запросов при отслеживании.
ОТПРАВКА ЗАПРОСА
URL: http://iseteenindus.smartpost.ee/api/?request=tracking
<orders>
<authentication>
<user>string</user>
<password>string</password>
</authentication>
<item>
<barcode>string</barcode>
<reference>string</reference>
</item>
<item>
…
</item>
</orders>
ОТВЕТ
<orders>
<item>
<barcode>string</barcode>
<reference>string</reference>
<generated>timestamp</generated>
<doorsize>number</doorsize>
<sourcein>timestamp</sourcein>
<sourceout>timestamp</sourceout>
<termin>timestamp</termin>
<termout>timestamp</termout>
<destinationin>timestamp</destinationin>
<destinationout>timestamp</destinationout>
<returnin>timestamp</returnin>
<returnout>timestamp</returnout>
<returntermin>timestamp</returntermin>
<returntermout>timestamp</returntermout>
</item>
<item>
…
</item>
</orders>
Коды ошибок
000 = нет информации о пункте назначения
001 = нет требуемого ввода (характерное, указано название графы)
002 = штрихкод уже существует
003 = не телефонный номер
004 = не адрес эл. почты
005 = не число
006 = неизвестный пункт назначения (ID_места)
007 = выбрана экспресс-доставка, но эта услуга недоступна в указанном пункте назначения
008 = несколько пунктов назначения
009 = нет периода для курьерской услуги
010 = нет города для курьерской услуги
011 = нет почтового индекса для курьерской услуги
012 = нет адреса для курьерской услуги
013 = выбран наложенный платеж, но услуга недоступна
014 = неправильный размер дверцы
015 = слишком длинная цепочка (предметы LQ)
016 = целое превышает лимиты (предметы LQ)
017 = значения нет в нумерации (предметы LQ)
018 = не активирована услуга отправки с кодом дверцы