API V1.0 – 4.4. СТВОРЕННЯ ЗАЯВКИ НА ДОСТАВКУ ВАНТАЖУ
Створення заявки на доставку вантажу до дверей одержувача
URL-Адреса запиту:
https://api.sat.ua/study/hs/api/v1.0/documents/order/delivery/{format}/save[?apiKey]Параметри запиту:
Текст запиту (доступні поля):
-
Допустимі поля:
(жирним виділено поля, правила заповнення яких відрізняються для авторизованих користувачів, що мають apiKey)
-
ID:
власний ідентифікатор заявки
-
orderDate:
дата виконання доставки
-
recipientAddress:
адреса одержувача вантажу
-
townRecipient:
місто отримання (якщо в накладній інше місто отримання). Це місто має бути в зоні доставки РСП отримання
-
contactRecipient:
ідентифікатор контактної особи одержувача (для авторизованих користувачів)
-
recipientPhone:
телефон одержувача
-
documentRef:
ідентифікатор або масив ідентифікаторів накладних на вантаж (для авторизованих користувачів)
-
documentNumber:
номер або масив номерів накладних на вантаж
- deliveryCondition:
- payerType:
- paymentMethod:
-
departureTimeFrom:
час доставки з
-
departureTimeTo:
час доставки за
-
additionalInformation:
примітка
приклад запиту
<request>
<item>
<ID>123</ID>
<date>05-10-2015</date>
<recipientPhone>0632323232</recipientPhone>
<recipientAddress>ул О.Бендера 15, оф 3</recipientAddress>
<documentRef>9a0cb936-5709-4956-ad7b-e54e37beefa5</documentRef>
</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