Send despatch advice
How to send a new or updated despatch advice to Tradecloud
As supplier you can send either a new or updated despatch advice to Tradecloud.
When a purchase order number is provided, but the item is not or partly provided, the item in the despatch advice will be enriched if Tradecloud can find the purchase order.
The shipment module is under development. The API and documentation may change.
When sending a despatch advice the provided buyer account number will be verified.
lines
: the despatch advice lines, see Despatch advice line. The total number of lines is limited to 500 lines per shipment.erpIssueDateTime
: local date and time at which the despatch advice of this shipment was issued in the supplier's ERP system
supplierCompanyId
: the optional Tradecloud company identifier of the supplier. You only have to provide a companyId when your integration user account has authorization for multiple companies.buyerAccountNumber
: the buyer account code or number as known in the supplier's ERP systemdespatchAdviceNumber
: the unique despatch advice number as provided by the suppliershipment
: the shipment related to this despatch advice:
shipmentNumber
: the related shipment number as known in the supplier's ERP system.
The
shipmentNumber
must not contain whitespace characters.shipmentCompanyName
: the shipment company name, like the carrier or courier name.trackingNumber
: the tracking number of the shipment as provided by the carrier or courierdestination
: the next destination location and scheduled arrival date/time, see Shipment next destinationfinalDestination
: the final destination location and scheduled arrival date/time, see Shipment final destination
actualDate
: the actual departure local date
Scheduled start and end date/times indicate the scheduled time window of arrival:
scheduledStartDate
: start local date of the arrival time windowscheduledStartTime
: start local time of the arrival time windowscheduledEndDate
: end local date of the arrival time windowscheduledEndTime
: end local time of the arrival time window
Scheduled start and end date/times indicate the scheduled time window of arrival:
scheduledStartDate
: start local date of the arrival time window.scheduledStartTime
: start local time of the arrival time window.scheduledEndDate
: end local date of the arrival time window.scheduledEndTime
: end local time of the arrival time window.
locationType
: a location type according to Incoterms 2020:AgreedPlace
(used with EXW, FCA)PortOfLoading
(used with FAS, FOB)PortOfDestination
(used with CFR, CIF)PlaceOfDestination
(used with CPT, CIP)FinalDestination
(used with DAP, DPU, DDP)
id
: the required identifier for the location, in context ofidSchema
idScheme
: scheme, providing context to the location identifier. For example GLNnames
: one or more location names. It is recommended to provide at least one name.addressLines
: one or more location address linespostalCode
: location postal codecity
: location citycountryCodeIso
: country code
despatchAdviceLinePosition
the position in the despatch advice as provided by the supplier. The position is unique within the despatch advice and immutable.purchaseOrderNumber
: the related purchase order number as provided by the buyerpurchaseOrderLinePosition
: the line position in the purchase order as provided by the buyerdespatchQuantity
the despatched quantity of this purchase order line or delivery schedule position.backorderQuantity
: the backorder quantity of this purchase order line or delivery schedule position.
buyerItemNumber
: the required item code or number as provided by the buyerbuyerItemRevision
: the revision of the item as provided by the buyerbuyerItemName
: the short name of this item as provided by the buyersupplierItemNumber
: the supplier item code or number as known in the supplier's ERP systemsupplierItemRevision
: the revision (or version) as known in the supplier's ERP systemsupplierItemName
: the short name of this item as known in the supplier's ERP systempurchaseUnitOfMeasureIso
: the the 3-letter purchase unit according to ISO 80000-1 which applies to this item
Last modified 20d ago