Obtaining a chain of documents

To work with this method, the user must be authorized.

Hint

Documents are linked in one chain, if they have identical values of the fields “Sender”, “Recipient”, “Buyer”, “Delivery point” (GLNs) and “Order number” (if not then “Document number”).

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

Using the method api/eds/chain and the specified parameters it is possible to obtain (download) the necessary data of the specified document chain.

URL

Method

GET

URL query

/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 parameters

gln - string (13); the GLN number of the organization that is associated with the authorized user of the EDIN 2.0 platform at the account level

chain_uuid - string; Chain ID

Optional url-parameters (boolean filters):

load_docs - whether to download documents related to the chain

load_bodies - whether to download documents body

load_package - whether to download packages

load_comments - whether to download comments

load_tags - whether to download documents tags

load_statuses - whether to download statuses to documents

Headers

Authorization

SID - token obtained during authorization

Content-Type

application/json

Examples of url-requests:

Get a list of documents on a specific chain with the bodies, comments downloading and without downloading their packages, tags and statuses

Get a list of documents on a specific chain with the packages, tags downloading and without downloading their bodies, comments and statuses

Get a list of documents on a specific chain with the statuses downloading and without downloading their bodies, comments, packages and tags

RESPONSE

Response transmits chain of documents (object XChain).