API v1.0 - 6. Накладная на груз

6.1. Создание накладной на груз

Создание накладных на груз по передаваемым параметрам.

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

Заголовки

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

Доступные поля:

Request URL

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

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

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

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

format string Формат данных для получения ответа (xml, json)
apiKey

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

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

Доступные поля:

<request> <item> <ID>123</ID> <rspRecipient>bbf8e4a1-33a7-11dd-a17a-001a4d3b885e</rspRecipient> <weight>1</weight> <cargoType>Стандарт</cargoType> <seatsAmount>5</seatsAmount> <payerType>Получатель</payerType> <paymentMethod>NonCash</paymentMethod> <description>106c69c5-fe17-4107-a211-ba9f0032e2c5</description> <recipient>f99c20ea-182e-11e2-89e8-0017a4770440</recipient> <addServices> <service>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</service> <count>2</count> </addServices> <addServices> <service>4fdbcdc1-72ed-4e7b-bd69-6a8cd19ee00b</service> <count>2</count> </addServices> </item> </request>
[ { "ID": "123", "rspRecipient": "bbf8e4a1-33a7-11dd-a17a-001a4d3b885e", "weight": "1", "cargoType": "Стандарт", "seatsAmount": "5", "payerType": "Получатель", "paymentMethod": "NonCash", "description": "106c69c5-fe17-4107-a211-ba9f0032e2c5", "recipient": "f99c20ea-182e-11e2-89e8-0017a4770440", "addServices": [ { "service": "4293056e-4cb1-406d-a2cd-e8f6d2ae6721", "count": "2" }, { "service": "4fdbcdc1-72ed-4e7b-bd69-6a8cd19ee00b", "count": "2" } ] } ]

Ответ 200

Значение полей ответа:

  • ID: свой идентификатор набора параметров, переданный в запросе
  • ref: идентификатор созданной накладной
  • number: номер созданной накладной
  • cost: рассчитанная стоимость перевозки
  • barcode: массив штрихкодов, по количеству мест (поле seatsAmount)
  • addServices: массив дополнительных услуг

Пример ответа

<response> <success>true</success> <data> <item> <ID>123</ID> <ref>ee40d084-3b3d-434f-877a-09fee724a5ed</ref> <number>009000359</number> <cost>69</cost> <barcode>00901385514020</barcode> <barcode>00901385515020</barcode> <barcode>00901385516020</barcode> <barcode>00901385517020</barcode> <barcode>00901385518020</barcode> <addServices> <service>4293056e-4cb1-406d-a2cd-e8f6d2ae6721</service> <cost>50</cost> </addServices> <addServices> <service>4fdbcdc1-72ed-4e7b-bd69-6a8cd19ee00b</service> <cost>6</cost> </addServices> </item> </data> </response>
[ { "ID": "123", "ref": "ee40d084-3b3d-434f-877a-09fee724a5ed", "number": "009000359", "cost": "69", "barcode": [ "00901385514020", "00901385515020", "00901385516020", "00901385517020", "00901385518020" ], "addServices": [ { "service": "4293056e-4cb1-406d-a2cd-e8f6d2ae6721", "cost": "50" }, { "service": "4fdbcdc1-72ed-4e7b-bd69-6a8cd19ee00b", "cost": "6" } ] } ]
ЧИТАТЬ ВСЕ