API V1.0 - 4.2. ИЗМЕНЕНИЕ ОФОРМЛЕННОЙ ЗАЯВКИ НА ВЫЕЗД
Изменение заявки на выезд экспедитора ТК САТ к отправителю (только для авторизованных пользователей)
URL-Адрес запроса:
https://api.sat.ua/study/hs/api/v1.0/documents/order/departure/{format}/update[?apiKey]Параметры запроса:
Текст запроса (доступные поля):
-
Допустимые поля:
(жирным выделены поля, правила заполнения которых отличаются для авторизованных пользователей, имеющих apiKey)
-
ID:
собственный идентификатор заявки. Возвращается после создания ref: идентификатор заявки
- ref:
-
orderDate:
планируемая дата и время отправки груза (в формате DD-MM-YYYYY HH:mm:ss)
-
отправитель:
наименование отправителя груза (не требуется при передаче apiKey)
-
rspSender:
идентификатор отделения отправителя (не требуется при передаче apiKey)
-
городОтправитель:
идентификатор города отправителя (не требуется при передаче apiKey)
-
senderAddress:
адрес отправителя (можно не указывать при передаче apiKey)
-
contactSender:
идентификатор контактного лица отправителя (для авторизованных пользователей) или ФИО контактного лица
-
senderPhone:
телефон отправителя (можно не указывать при передаче apiKey)
-
seatsAmount:
общее количество мест отправления
-
addServices:
дополнительные услуги
service: идентификатор дополнительной услуги
count: количество -
description:
идентификатор описания груза
-
weight:
общий вес груза
-
length:
длина всех мест отправления
-
width:
ширина всех мест отправления
-
height:
высота всех мест отправления
-
volume:
общий объём груза
-
additionalInformation::
примечание
-
departureCondition:
дополнительное условие выезда
-
payerType:
идентификатор типа плательщика
-
paymentMethod:
идентификатор вида оплаты
-
recipients:
массив получателей или один получатель груза
- delivery: признак доставки груза до дверей получателя
- rspSender: идентификатор отделения получателя
- townRecipient: идентификатор города получателя
- recipientAddress: адрес получателя
- recipient: идентификатор получателя (только для авторизованных пользователей)
- contactRecipient: идентификатор контактного лица получателя (только для авторизованных пользователей)
- recipientPhone: телефон получателя
- seatsAmount: количество мест для этого получателя
- cargoType: идентификатор типа груза
- weight: вес отправления для этого получателя
- width: ширина
- height: высота
- deliveryCondition: дополнительное условие доставки
- addServices: дополнительные условия при доставке груза этому получателю
-- service: идентификатор дополнительной услуги
-- count: количество
пример запроса
<request>
<item>
<ID>123</ID>
<ref>ef588255-3f2e-4c2a-8b86-be8b18f1bb0c</ref>
<sender>ТОВ Аллигатор-Плюс</sender>
<senderAddress>ул.Петлюры 6, оф 12</senderAddress>
<senderPhone>0632323232</senderPhone>
<contactSender>Петр</contactSender>
<townSender>bbf8e4a1-33a7-11dd-a17a-001a4d3b885e</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>
<recievers>
<rspReciever>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</rspReciever>
<cargoType>Стандарт</cargoType>
</recievers>
</item>
</request>
Ответ 200
Идентификатор и номер измененной заявки.
-
ID:
собственный идентификатор заявки, переданный в запросе
-
ref:
идентификатор созданной заявки
-
number:
номер созданной заявки
пример ответа
<response>
<success>true</success>
<data>
<item>
<ID>123</ID>
<ref>ef588255-3f2e-4c2a-8b86-be8b18f1bb0c</ref>
<number>009000039</number>
</item>
</data>
</response>
интерфейсы API