Tradecloud API v2 manual
1.0.0
Search
⌃K

Attach a document to an order response

How to attach a document to an order or line response
This feature is not available yet. Please contact [email protected] if you need this feature.

Attach a document to an order response

You can attach documents using three methods:
  1. 1.
    Upload your document to the Tradecloud object-storage and attach the objectId to the order or line
  2. 2.
    Upload your document to your company's content server and attach the url to the order line
  3. 3.
    Only attach document meta data, such as document code/number, revision and name

Method 1. Attach a document using the Tradecloud object-storage

Your integration should only upload documents and images with supported Media Types and File Extensions​

Step 1. Upload a document to the Tradecloud object-storage

post
https://api.accp.tradecloud1.com/v2
/object-storage/document
Upload a new document

Step 2. Attach the uploaded document objectId to the order or line

post
https://api.accp.tradecloud1.com/v2
/order-response/documents
TO DO: Attach order documents by supplier OpenAPI specs
When ataching documents the provided buyer account number and purchase order number will be verified.
Response status codes:
  • 200 OK - the buyer account number and purchase order number exist and the documents will be attached.
  • 202 Accepted - the order verification has been skipped due to service unavailability and the document attachment has been queued.
  • 404 Not Found - either the buyer account number or the purchase order number has not been found.

Order response documents body

Order

  • companyId: the optional Tradecloud company identifier. You only have to provide a companyId when your integration user account has multiple company permissions.
  • buyerAccountNumber: the buyer account number as known in your ERP system
  • purchaseOrderNumber: the purchase order number as sent by the buyer
  • documents: the documents to be attached to this order.
The total number of documents is limited to 100 documents per order header.

Lines

  • lines: the purchase order lines having a new document attached
  • position: the purchase order line position within the purchase order
  • documents: the documents to be attached to this line
The total number of documents is limited to 100 documents per order line.

Documents

  • code : optional document code or number. The document code should be unique within your company and immutable.
  • revision: optional document revision (or version) code or number
  • name : optional document short (file) name
  • description : optional document description or long name
  • type: optional document business type
  • objectId: optional Tradecloud object identifier which was returned by the Tradecloud object-storage upload
  • url: optional document location if it is not stored in the Tradecloud object-storage.

Response

When the /api-connector/order-response/documents API method returns HTTP status code 200, the order documents were successfully queued for processing by Tradecloud. Processing takes usually less then a second, after which the order response documents are available in the portal and are forwarded to the buyer ERP integration.

Method 2. Attach a document using your company's content server

Step 1. Upload to your company's content server

Upload documents to your company's content server and remember the returned document url.

Step 2. Attach uploaded document url to the order or line

Use Step 2. in method 1, but use url instead of objectId

Method 3. Only provide document meta data

Only provide document meta data like code, revision, name, description and type.
Use Step 2. in method 1, but do not provide an url or objectId
Previous
Send order response
Next
Reopen an order
Last modified 4mo ago