API v1.0 - 4. Заявки

4.1. Создание заявки на выезд за грузом

Оформление заявки на выезд экспедитора ТК САТ к отправителю.

Параметры запроса

Заголовки

Текст запроса

Допустимые поля (жирным выделены поля, правила заполнения которых отличаются для авторизированных пользователей, имеющих apiKey)

Request URL

https://api.sat.ua/v1.0/documents/order/departure/{format}/save

Содержимое ответа

URL-адрес запроса

Параметры запроса

format string Формат данных для получения ответа (xml, json)
apiKey
(дополнительный)
string Ключ пользователя ТК САТ. Для получения ключа нужно пройти регистрацию.
Ключ может быть передан как через параметр URL, так и в заголовке HTTP запроса
В режиме тестирования без регистрации используйте ключ: devApiKey

Текст запроса

Допустимые поля (жирным выделены поля, правила заполнения которых отличаются для авторизированных пользователей, имеющих apiKey)

<request> <item> <ID>123</ID> <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>
[ { "ID": "123", "sender": "ТОВ Аллигатор-Плюс", "senderAddress": "ул.Петлюры 6, оф 12", "senderPhone": "0632323232", "contactSender": "Петр", "townSender": "bbf8e4a1-33a7-11dd-a17a-001a4d3b885e", "weight": "5", "seatsAmount": "5", "description": "106c69c5-fe17-4107-a211-ba9f0032e2c5", "addServices": { "service": "4293056e-4cb1-406d-a2cd-e8f6d2ae6721", "count": "2" }, "recievers": { "rspReciever": "4293056e-4cb1-406d-a2cd-e8f6d2ae6721", "cargoType": "Стандарт" } } ]

Ответ 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" } ]
ЧИТАТЬ ВСЕ