API V1.0 – 4.5. ЗМІНА ЗАЯВКИ НА ДОСТАВКУ

Зміна створеної заявки на доставку вантажу до дверей одержувача.

URL-Адреса запиту:

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

Параметри запиту:

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

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

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

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

  • ref:

    ідентифікатор раніше створеної заявки на доставку

  • orderDate:

    дата виконання доставки

  • recipientAddress:

    адреса одержувача вантажу

  • contactRecipient:

    ідентифікатор контактної особи одержувача (для авторизованих користувачів)

  • recipientPhone:

    телефон одержувача

  • documentRef:

    ідентифікатор або масив ідентифікаторів накладних на вантаж (для авторизованих користувачів)

  • documentNumber:

    номер або масив номерів накладних на вантаж

  • departureCondition:

    додаткова умова доставки

  • payerType:

    ідентифікатор типу платника

  • paymentMethod:

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

приклад запиту

text/xml | application/json

<request>
	<item>
		<ref>00581817-4b5a-47f6-b365-922dc3c42d70</ref>
		<date>05-10-2015</date>
		<recipientPhone>0632323232</recipientPhone>
		<recipientAddress>ул О.Бендера 15, оф 3</recipientAddress>
		<documentRef>9a0cb936-5709-4956-ad7b-e54e37beefa5</documentRef>
	</item>
</request>
                    

 

Відповідь 200

Ідентифікатор (тільки для авторизованих користувачів) і номер зміненої заявки.

  • ref:

    ідентифікатор створеної заявки

  • number:

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

приклад відповіді

text/xml | application/json
                        
<response>
	<success>true</success>
	<data>
		<item>
			<ref>ef588255-3f2e-4c2a-8b86-be8b18f1bb0c</ref>
			<number>009000039</number>
		</item>
	</data>
</response>                        
                    

 

 

інтерфейси API

виберіть регіон

1 які вантажі заборонені до перевезення?

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