API V1.0 - 4.4. СОЗДАНИЕ ЗАЯВКИ НА ДОСТАВКУ ГРУЗА

Создание заявки на доставку груза до дверей получателя

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

https://api.sat.ua/study/hs/api/v1.0/documents/order/delivery/{format}/save[?apiKey]

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

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

Текст запроса (доступные поля):

  • Допустимые поля:

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

  • ID:

    собственный идентификатор заявки

  • orderDate:

    дата выполнения доставки

  • recipientAddress:

    адрес получателя груза

  • townRecipient:

    город получения (если в накладной другой город получения). Этот город должен быть в зоне доставки РСП получения

  • contactRecipient:

    идентификатор контактного лица получателя (для авторизованных пользователей)

  • recipientPhone:

    телефон получателя

  • documentRef:

    идентификатор или массив идентификаторов накладных на груз (для авторизованных пользователей)

  • documentNumber:

    номер или массив номеров накладных на груз или массив номеров накладных на груз

  • deliveryCondition:

    дополнительное условие доставки

  • payerType:

    идентификатор типа плательщика

  • paymentMethod:

    идентификатор вида оплаты

  • departureTimeFrom:

    время доставки из

  • departureTimeTo:

    время доставки за

  • additionalInformation::

    примечание

пример запроса

текст/xml | application/json

<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:

    номер созданной заявки

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

текст/xml | application/json
                        
<response>
	<success>true</success>
	<data>
		<item>
			<ID>123</ID>
			<ref>ef588255-3f2e-4c2a-8b86-be8b18f1bb0c</ref>
			<number>009000039</number>
		</item>
	</data>
</response>                        
                    

 

 

интерфейсы API

выберите регион

1 какие грузы запрещены к перевозке?

Поиск по сайту