Отримання конкретного ланцюжка документів

Для роботи з цим методом користувач повинен бути авторизованим .

Підказка

Документи пов’язуються в один ланцюжок, в тому випадку якщо у них ідентичні значення полів «Відправник», «Одержувач», «Покупець», «Точка доставки» (GLN-и) і «Номер замовлення» (якщо відсутній, то «Номер документа»).

../../../_images/EdsChain_01.png

За допомогою методу api/eds/chain і заданих параметрів можливо отримати (вивантажити) необхідні дані вказаного ланцюжка документів.

URL

Метод запиту

GET

URL запиту

/api/eds/chain?gln=9864065702429&chain_uuid=9fe45d32-35c7-44d0-9131-7257fc0c0f39&load_docs=true&load_bodies=true&load_package=true&load_comments=true&load_tags=true&load_statuses=true

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

chain_uuid - рядок; ID ланцюжка

Опціональні url-параметри (boolean фільтри):

load_docs - чи завантажувати документи, що відносяться до ланцюжка

load_bodies - чи завантажувати тіла документів

load_package - чи завантажувати пакети

load_comments - чи завантажувати коментарі

load_tags - чи завантажувати теги до документів

load_statuses - чи завантажувати статуси до документів

Headers

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

Приклади url-запитів:

Отримати перелік документів за визначеним ланцюжком без завантаження їхніх тіл, пакетів, коментарів, тегів і статусів

Отримати перелік документів за визначеним ланцюжком з завантаженням тіл і коментарів без завантаження їхніх пакетів, тегів і статусів

Отримати перелік документів за визначеним ланцюжком з завантаженням пакетів, тегів без завантаження їхніх тіл і коментарів і статусів

Отримати перелік документів за визначеним ланцюжком з завантаженням статусів без завантаження їхніх тіл, коментарів, пакетів, тегів

RESPONSE

В тілі відповіді передається ланцюжок документів (об’єкт XChain).