Опис формування полів для введення у форму представлено у Таблиці 2.2.

Приклади:

Приклад XML-коду для одного відправлення:
Приклад виконання запиту
<?xmlversion="1.0"encoding="UTF-8"?>
<param>
<login>login</login>
<function>CreateShipments</function>
<request>
 
<Shipments>
<CreateShipment>
<Calculate>true</Calculate>
<ClientsShipmentRef>000-
00000001</ClientsShipmentRef>
<ClientUID>62f66c7c-cd19-11df-bb67-00215aee3ebe
</ClientUID>
<Sender>Відправник</Sender>
<SenderService>0</SenderService>
<SenderBranch_UID>75ec298e-a8dd-11de-bac3-
0030485903e8</SenderBranch_UID>
<SenderStreet_UID/>
<SenderTel>0673405775</SenderTel>
<Receiver>Отримувач</Receiver>
<ReceiverService>1</ReceiverService>
<ReceiverBranch_UID/>
<ReceiverStreet_UID>6e23d513-e0d2-11df-9b37-
00215aee3ebe</ReceiverStreet_UID>
<ReceiverHouse>2</ReceiverHouse>
<ReceiverFlat>66</ReceiverFlat>
<ReceiverFloor></ReceiverFloor>
<ReceiverTel>123123123</ReceiverTel>
<COD>1000</COD>
<Notation>ТестуванняАПІ</Notation>
<Receiver_Pay>1</Receiver_Pay>
<TypePay>0</TypePay>
<Conditions_items>
<ContitionsName>6e23d513-e0d2-11df-9b37-
00215aee3ebe</ContitionsName>
</Conditions_items>
<Places_items>
<SendingFormat>PAX</SendingFormat>
<Quantity>1</Quantity>
<Volume>0,012</Volume>
<Weight>6</Weight>
<Packaging/>
<Insurance>300</Insurance>
<Length></Length>
<Width></Width>
<Height></Height>
</Places_items>
<DescriptionOfContents_items> 
<ContentName>Футболка</ContentName>
<ContentQuantity>1</ContentQuantity> -
<ContentWeight>0.6</ContentWeight >
<ContentValue>12</ContentValue>
<CustomsCode>1111111111</CustomsCode>
<ContentCountry>UA</ContentCountry>
</DescriptionOfContents_items>
<PlanDeliveryDate>22.10.2015</PlanDeliveryDate>
<PlanDeliveryTimeFrom>10:00</PlanDeliveryTimeFrom><PlanDeliveryTimeTo>14:00</PlanDeliveryTimeTo>
</CreateShipment>
</Shipments>
</request>
<sign>sign*</sign>
</param>
<?xmlversion="1.0"encoding="UTF-8" standalone="yes"?>
<return>
<api>API-1C</api>
<apiversion>1</apiversion>
<result_table>
<items>
<ClientsShipmentRef>000-
00000001</ClientsShipmentRef>
<BarCode>000-8302714</BarCode>
<PriceOfDelivery>25</PriceOfDelivery>
<Error>000</Error>
</items>
</result_table>
<result_uuid>24288</result_uuid>
<errors>
<code>000</code>
<name></name>
</errors>
</return>
 
 

Таблиця 2.2. Опис вмісту тега <request>XML-коду .

Поле
Опис
Тип
CreateShipment
Блок для опису відправлення
Calculate
true/false
Якщо true то у відповідь буде повертатись вартість доставки в тег PriceOfDelivery
Text
ClientsShipmentRef
Код (номер) відправлення, присвоюється контрагентом
Text
ClientUID
Унікальний ідентифікатор клієнта, присвоюється після внесення контрагента в систему (Обов’язковий)
Uniqueidentifier
Поля для опису реквізитів Відправника
Sender
Відправник
Text
SenderService
Вид сервісу, якщо
«0» - склад
«1» - двері
(Обов’язковий)
Boolean (1/0)
SenderBranch_UID
Унікальний ідентифікатор підрозділу Відправника,  результат виконання функції«Branch» п.1.7. Встановлюється,  якщо
[SenderService]=0(Якщо сервіс відправника склад -
Обов’язковий)
Uniqueidentifier
SenderStreet_UID
Унікальний ідентифікатор вулиці (адреси) Відправника,  результат виконання функції«Аddress» п.1.6. Встановлюється,  якщо [SenderService]=1та [SenerAdressType]=0 (Якщо сервіс відправника двері - Обов’язковий)
Uniqueidentifier
SenderHouse
Номер будинку адреси Відправника. Встановлюється,  якщо
[SenderService]=1 (Якщо сервіс
відправника двері -
Обов’язковий)
Text
SenderFlat
Номер квартири Відправника.
Text
 
Встановлюється,  якщо
[SenderService]=1
 
SenderTel
Контактний телефонВідправника
Text
Полядля опису реквізитівОдержувача
 
 
Receiver
Одержувач
Text
ReceiverService
Вид сервісу,якщо
«0» - склад
«1» - двері
(Обов’язковий)
Boolean (1/0)
ReceiverBranch_UID
Унікальний ідентифікатор підрозділу Одержувача,  результат виконання функції«Branch» п.1.7. Встановлюється,  якщо [ReceiverService]=0
(Якщо сервісотримувачасклад-
Обов’язковий)
Uniqueidentifier
ReceiverStreet_UID
Унікальний ідентифікаторвулиці
(адреси) Одержувача, результат виконання функції«Аddress» п.1.6. Встановлюється,  якщо [ReceiverService]=1
(Якщо сервісотримувача двері -
Обов’язковий)
Uniqueidentifier
ReceiverHouse
Номер будинку адреси Одержувача. Встановлюється,  якщо
[ReceiverService]=1
(Якщо сервіс отримувача двері -
Обов’язковий)
Text
ReceiverFlat
Номер квартири адреси Одержувача. Встановлюється,  якщо [ReceiverService]=1
Text
ReceiverFloor
Вказується номер поверху на котрий треба підняти вантаж. Автоматично включається і розраховується послуга "Підйом на поверх" 
Int
ReceiverTel
Контактний телефонОдержувача.
(Обов’язковий)
Text
COD
Оголошена цінність (сума) зворотнього відправлення
Number
Receiver_Pay
Спосіб оплати, якщо
«0» - оплачує Відправник
«1» - оплачує Одержувач
(Обов’язковий)
Boolean (1/0)
TypePay
Тип оплати,якщо
«0» - безготівка
«1» - готівка
(Обов’язковий)
Boolean (1/0)
Notation
Примітка
Text
Блокопису додаткових умов доставки
Conditions_items
У блоці може бути один або декілька записів,  результат виконання функції «ShipmentOptCondition» п.1.10.
ContitionsName
Унікальний ідентифікатор умови
Uniqueidentifier
Блок опису місць відправлення
Places_items
Результат виконання функції «ShipmentFormats» п.1.9.
У блоці може бути один або декілька записів. При формуванні місця слід виконуватип еревірку формату відправлення у відповідності до мінімальних та максимальних параметрів
ваги, об’єму, страхування. (Обов’язковий)
SendingFormat
Код формату відправлення (Обов’язковий)
Text
Quantity
Кількість (Обов’язковий)
Number
Volume
Об’єм
Number
Weight
Вага (Обов’язковий)
Number
Packaging
Упаковка
Uniqueidentifier(отримується з функції  ShipmentPackaging)
Insurance
Страхування (Обов’язковий)
Number
Length Довжина Text
Width Ширина Text
Height Висота Text
 
Блок для передачі товарів
good
Для кожного товару відправлення формується окремий блок <good>. Блок не є обов'язковим.
Товари вносимо для ведення товарного обліку або для реалізації функції часткового доручення.
good_id
Унікальний ідентифікатор товару. Використовується для створення товару у базі перевідника та для подальшої синхронізації
Uniqueidentifier
good_name
Назва товару
Text
goodSN_name
Серійний номер товару
Text
qty
Кількість товару
Int
price
Ціна товару за одну штуку, грн.
Number
summ
Вартість товару, грн.
Number
weight
Вага товару, кг
Number
 
Блок опису вмісту відправлення
DescriptionOfContents_items Поля блоку забезпечують можливість передачі опису вмісту відправлення. Блок не є обов'язковим, жодне з полів блоку не є обов'язковим.
ContentName
Назва товару
Text
ContentQuantity
Кількість одиниць товару
Number
ContentWeight
Вага
Number
ContentValue
Вартість
Number
CustomsCode
Митний код
Text
ContentCountry
Країна виготовлення товару
Text
 
PlanDeliveryDate
Бажана/Планова дата доручення(Не обов'язковий параметр)
Date: dd.MM.yyyy
PlanDeliveryTimeFrom Початок часового діапазону доручення. Заповнюється якщо вказано PlanDeliveryDate. (Не обов'язовий параметр) Time: hh:mm
PlamDeliveryTimeTo Кінець часового діапазону доручення. Заповнюється якщо вказано PlanDeliveryDate.(Не менше як 2 години після PlanDeliveryTimeFrom)(Не обов'язковий параметр) Time: hh:mm

 

Тег[CreateShipment] обмежує одне відправлення. У коді можна формувати як одне так і декілька відправлень.

Якщо Користувач встановлює [Wait]=1, Система не розриває з’єднання (означає примусове очікування результату створення нового запису). При успішному створенні відправлення Система формує штрихкод.  У нашому прикладі штрихкод [BarCode]=000-8302714’.  У випадку помилки, Система вкаже Код помилки  у поле [Error].

Якщо Користувач встановлює [Wait]=0, Система повертає лише унікальний ідентифікатор запиту у полі [uuid], наприклад: [uuid]='24228'.  Користувач може у зручний для нього час отримати інформацію про відправлення за допомогою цього коду.