API V1.0 - 4.1. СОЗДАНИЕ ЗАЯВКИ НА ВЫЕЗД ЗА ГРУЗОМ
Оформление заявки на выезд экспедитора ТК САТ к отправителю.
Для получения ключа нужно пройти регистрацию. Ключ может быть передан как через параметр URL, так и в заголовке HTTP запроса В режиме тестирования без регистрации используйте ключ: devApiKey
URL-Адрес запроса:
https://api.sat.ua/study/hs/api/v1.0/documents/order/departure/{format}/save[?apiKey]Параметры запроса:
Текст запроса (доступные поля):
-
(жирным выделены поля, правила заполнения которых отличаются для авторизованных пользователей, имеющих apiKey):
-
ID:
собственный идентификатор заявки. Возвращается после создания
-
orderDate:
планируемая дата и время отправки груза (в формате DD-MM-YYYYY HH:mm:ss)
-
sender:
наименование отправителя груза (не требуется при передаче apiKey)
-
rspSender:
идентификатор отделения отправителя (не требуется при передаче apiKey)
-
townSender:
идентификатор города отправителя (не требуется при передаче apiKey)
-
senderAddress:
адрес отправителя (можно не указывать при передаче apiKey)
-
contactSender:
идентификатор контактного лица отправителя (для авторизованных пользователей) или ФИО контактного лица
-
senderPhone:
телефон отправителя (можно не указывать при передаче apiKey)
-
seatsAmount:
общее количество мест отправления
-
addServices:
дополнительные услуги
service: идентификатор дополнительной услуги
count: количество -
description:
идентификатор описания груза
-
weight:
вес груза (всех мест общий)
-
width:
ширина (максимальная 1го места)
-
length:
длина (максимальная 1го места)
-
height:
высота (максимальная 1го места)
-
volume:
объем груза (всех мест общий)
-
additionalInformation::
примечание
-
departureCondition:
дополнительное условие выезда
-
payerType:
идентификатор типа плательщика
-
paymentMethod:
идентификатор вида оплаты
-
recipients:
получатель груза
delivery: признак доставки груза до дверей получателя
rspRecipient: идентификатор отделения получателя
townRecipient:идентификатор города получателя
recipientAddress: адрес получателя
recipient: идентификатор получателя (только для авторизованных пользователей)
contactRecipient: идентификатор контактного лица получателя (только для авторизованных пользователей)
recipientPhone: телефон получателя
seatsAmount: количество мест для этого получателя
cargoType: идентификатор типа груза
weight: вес отправления для этого получателя
width: ширина
height:высота
deliveryCondition: дополнительное условие доставки
addServices: дополнительные условия при доставке груза этому получателю
service: идентификатор дополнительной услуги
count:количество
units:таблица мест груза
rows: массив мест груза в таблице
weight: вес места
height: высота места
length: длина места
width: ширина места
declaredCost: задекларированная стоимость места
description: идентификатор описания груза
cargoType: идентификатор типа груза
пример запроса
<request>
<ID>123</ID>
<sender>ТОВ Аллигатор-Плюс</sender>
<senderAddress>ул.Петлюры 6, оф 12</senderAddress>
<senderPhone>0632323232</senderPhone>
<contactSender>Петр</contactSender>
<townSender>8d7f5ea4-9436-11dd-98c6-001cc0108cd1</townSender>
<weight>5</weight>
<seatsAmount>5</seatsAmount>
<description>106c69c5-fe17-4107-a211-ba9f0032e2c5</description>
<addServices>
<service>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</service>
<count>2</count>
</addServices>
<recipients>
<rspRecipient>bbf8e497-33a7-11dd-a17a-001a4d3b885e</rspRecipient>
<cargoType>Стандарт</cargoType>
<declaredCost>300</declaredCost>
<units>
<rows>
<declaredCost>300</declaredCost>
<description>80ca645c-51d4-11e8-9403-00505601031c</description>
<weight>2</weight>
<width>1</width>
<length>1</length>
<height>1</height>
<volume>1</volume>
<cargoType>Базовый</cargoType>
</rows>
<rows>
<declaredCost>300</declaredCost>
<description>80ca645c-51d4-11e8-9403-00505601031c</description>
<weight>24</weight>
<width>1</width>
<length>11</length>
<height>1</height>
<volume>1</volume>
<cargoType>Базовый</cargoType>
</rows>
</units>
</recipients>
</request>
Ответ 200
Идентификатор (только для авторизованных пользователей) и номер созданной заявки.
-
ID:
собственный идентификатор заявки, переданный в запросе
-
ref:
идентификатор созданной заявки
-
number:
номер созданной заявки
пример ответа
<response>
<success>true</success>
<data>
<item>
<ID>123</ID>
<ref>f324ef75-33e3-4127-a8b9-d24dd3188784</ref>
<number>009866819</number>
</item>
</data>
</response>
интерфейсы API