Attach a document to an order response
How to attach a document to an order or line response
You can attach documents using three methods:
- 1.Upload your document to the Tradecloud object-storage and attach the
objectIdto the order or line
- 2.Upload your document to your company's content server and attach the
urlto the order line
- 3.Only attach document meta data, such as document code/number, revision and name
Your integration should only upload documents and images with supported Media Types and File Extensions
Upload a new document
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.
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: 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.
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.
/api-connector/order-response/documentsAPI 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.
Upload documents to your company's content server and remember the returned document
Use Step 2. in method 1, but use
Only provide document meta data like code, revision, name, description and type.
Use Step 2. in method 1, but do not provide an