API v1.0 - 4. Заявки
4.4. Создание заявки на доставку груза
Создание заявки на доставку груза до дверей получателя
Параметры запроса
Заголовки
Текст запроса
Допустимые поля (жирным выделены поля, правила заполнения которых отличаются для авторизированных пользователей, имеющих apiKey)
- ID: собственный идентификатор заявки
- orderDate: дата выполнения доставки
- recipientAddress: адрес получателя груза
- contactRecipient: идентификатор контактного лица получателя (для авторизированных пользователей)
- recipientPhone: телефон получателя
- documentRef: идентификатор или массив идентификаторов накладных на груз (для авторизованных пользователей)
- documentNumber: номер или массив номеров накладных на груз
- deliveryCondition: дополнительное условие доставки
- payerType: идентификатор типа плательщика
- paymentMethod: идентификатор вида оплаты
Request URL
https://api.sat.ua/study/hs/api/v1.0/documents/order/delivery/{format}/save
Содержимое ответа
URL-адрес запроса
Параметры запроса
| format | string | Формат данных для получения ответа (xml, json) | |
|
apiKey |
(дополнительный) |
string |
Ключ пользователя ТК САТ. Для получения ключа нужно пройти регистрацию. Ключ может быть передан как через параметр URL, так и в заголовке HTTP запроса В режиме тестирования без регистрации используйте ключ: devApiKey |
Текст запроса
Допустимые поля (жирным выделены поля, правила заполнения которых отличаются для авторизированных пользователей, имеющих apiKey)
- ID: собственный идентификатор заявки
- orderDate: дата выполнения доставки
- recipientAddress: адрес получателя груза
- contactRecipient: идентификатор контактного лица получателя (для авторизированных пользователей)
- recipientPhone: телефон получателя
- documentRef: идентификатор или массив идентификаторов накладных на груз (для авторизованных пользователей)
- documentNumber: номер или массив номеров накладных на груз
- deliveryCondition: дополнительное условие доставки
- payerType: идентификатор типа плательщика
- paymentMethod: идентификатор вида оплаты
<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>
[
{
"ref": "00581817-4b5a-47f6-b365-922dc3c42d70",
"date": "05-10-2015",
"recipientPhone": "0632323232",
"recipientAddress": "ул О.Бендера 15, оф 3",
"documentRef": "9a0cb936-5709-4956-ad7b-e54e37beefa5"
}
]
Ответ 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>
[
{
"ID": "123",
"ref": "ef588255-3f2e-4c2a-8b86-be8b18f1bb0c",
"number": "009000039"
}
]
