Skip to content
Tradecloud API v2 manual

Download a document attached to an order

You can download documents using two methods:

  1. If the webhook order or line document contains an objectId: Download the buyer’s document from the Tradecloud object-storage using the objectId and downloadUrl
  2. If the webhook order or line document contains an url: Download the document from the buyer’s content server.

If both objectId and url are missing in the document, no file is available for download.

Method 1. Download the document from the Tradecloud object-storage

Section titled “Method 1. Download the document from the Tradecloud object-storage”

Step 1. Retrieve the objectId from the document

Section titled “Step 1. Retrieve the objectId from the document”

Please check the documents fields in order and lines in:

"documents": [
  {
    "code": "123456789",
    "revision": "B",
    "name": "Tradecloud API Manual",
    "objectId": "67aa8ece-5d41-496f-a94c-483e360b833b",
    "type": "General",
    "description": "General document"
  }
],

In this example the objectId is:

67aa8ece-5d41-496f-a94c-483e360b833b

Step. 2. Retrieve the downloadUrl from the object storage

Section titled “Step. 2. Retrieve the downloadUrl from the object storage”

Apply the objectId in the GET document metadata endpoint to retrieve the downloadUrl from the object storage.

Step 3. Download the document using the downloadUrl

Section titled “Step 3. Download the document using the downloadUrl”

Just GET the downloadUrl

Method 2. Download the document from the supplier content server

Section titled “Method 2. Download the document from the supplier content server”

Step 1. Retrieve the url from the document

Section titled “Step 1. Retrieve the url from the document”

Please check the documents fields in order and lines in:

"documents": [
  {
    "code": "123456789",
    "revision": "B",
    "name": "Tradecloud API Manual",
    "url": "http://buyer.com/content/manual.pdf",
    "type": "General",
    "description": "General document"
  }
],

In this example the url is:

http://buyer.com/content/manual.pdf

Step 2. Download the document using the url

Section titled “Step 2. Download the document using the url”

Just GET the url