Skip to main content

Отримати конкретний ланцюжок документів GET /api/eds/chain

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

EdsChain_01.png

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

URL

 

Метод запиту

GET

URL запиту

/api/eds/chain

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-запитів:

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

https://edo-v2.edin.ua/api/eds/chain?gln=9864232304302&chain_uuid=0fe60377-51db-4b7a-b7eb-cdf5fa91a46a&load_docs=true&load_bodies=false&load_package=false&load_comments=false&load_tags=false&load_statuses=false

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

https://edo-v2.edin.ua/api/eds/chain?gln=9864232304302&chain_uuid=0fe60377-51db-4b7a-b7eb-cdf5fa91a46a&load_docs=true&load_bodies=true&load_package=false&load_comments=true&load_tags=false&load_statuses=false

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

https://edo-v2.edin.ua/api/eds/chain?gln=9864232304302&chain_uuid=0fe60377-51db-4b7a-b7eb-cdf5fa91a46a&load_docs=true&load_bodies=false&load_package=true&load_comments=false&load_tags=true&load_statuses=false

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

https://edo-v2.edin.ua/api/eds/chain?gln=9864232304302&chain_uuid=0fe60377-51db-4b7a-b7eb-cdf5fa91a46a&load_docs=true&load_bodies=false&load_package=false&load_comments=false&load_tags=false&load_statuses=true

RESPONSE

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