Single delivery order
How to receive a single delivery order sent by the buyer.
Tradecloud will send a purchase order, either new or updated, to the supplier when an order event has been triggered.
This page assumes you are using the webhook with a single delivery per order line.
When choosing the delivery schedule please continue on:
singleDeliveryOrderEvent
or order
header
singleDeliveryOrderEvent
or order
headerid
(in case of anorder
): the Tradecloud order identifierorderId
(in case of ansingleDeliveryOrderEvent
): the Tradecloud order identifierbuyerOrder
: the buyer part of the order, see Buyer order.supplierOrder
: the supplier part of the order, see Supplier order.indicators.deliveryOverdue
is true when at least one order line is overdue.status.processStatus
: is the aggregate of all lines statuses, see Order process status.status.logisticsStatus
: is the aggregate of all lines statuses, see Order logistics status.version
: the Tradecloud order version number.eventDates
: some key order event date/times.meta
: meta information, including source and trace info, about this messsage.lastUpdatedAt
: is the latest date time the order has been changed.
Buyer order
buyerOrder
contains the buyer order fields:
companyId
: the buyer's Tradecloud company identifier.supplierAccountNumber
: your account number as known in the buyer's ERP system.description
: a free format additional description of this order added by the buyer.contact
: the buyer employee responsible for this order.properties
: are key-value based custom fields, added by the buyer.notes
: are simple custom fields, added by the buyer.labels
: value-added services labels on order level.documents
: contain meta data, objectId or url, of attached documents by the buyer. See:
orderType
: the order type, one ofPurchase
,Forecast
orRFQ
. DefaultPurchase
.
Supplier order
supplierOrder
is mostly an echo of your order fields as explained in Send order response.
buyerAccountNumber
: the buyer account number as known in your ERP system.
The buyerAccountNumber
should be set on forehand in the Tradecloud connection with your buyer. You can set the account code when inviting a new connection or in the connection overview in the portal.
Order status
The order status is the aggregation of all the lines statuses.
Order process status
The order process status is one of:
Issued
: the order is (re)issued by the buyer.InProgress
: the order is under negotiation between buyer and supplierConfirmed
: the order is completely agreed between buyer and supplierRejected
: the order is completely rejected by supplierCompleted
: the order is completed at the buyerCancelled
: the order is cancelled by the buyer
Order logistics status
The order logistics status is one of:
Open
: no or partial quantity Produced, ReadyToShip, Shipped or DeliveredProduced
: the order full quantity is produced by the supplierReadyToShip
: the order full quantity is ready to be shipped by the supplierShipped
: the order full quantity is shipped by the supplierDelivered
: the order full quantity is delivered at the buyerCancelled
: the order is cancelled by the buyer
singleDeliveryOrderEvent
lines
singleDeliveryOrderEvent
lineslines
contains one or more order lines:
id
: the Tradecloud line identifierbuyerLine
: the buyer part of the order line, see Buyer line.supplierLine
: the supplier part of the order line, see Supplier line.confirmedLine
: the order line as agreed between buyer and supplier.statusLine
: the order line values representing the currentIssued
,Confirmed
orInProgess
status, see Status line.indicators.deliveryOverdue
is true when the order line is overdue.status.processStatus
: the order line's Line process status.status.inProgressStatus
the order line's Line in progress status.status.logisticsStatus
: the order line's Line logistics status.eventDates
: some key line event date/timesmergedItemDetails
: detailed part information provided by both buyer and supplier, see Item details.lastUpdatedAt
: is the latest date time the order line has been changed.
Buyer line
buyerLine
contains the buyer order line fields:
position
: the line position within the purchase orderdescription
: a free format additional description of this lineitem
: the item (or article, goods) to be delivered, see Itemrequests
: the buyer can request different delivery schedule, prices and charge lines. Advised is to use thestatusLine.deliveryScheduleInclRequests
andstatusLine.pricesInclRequests
fields instead.terms
: the line terms as agreed with your buyercontractNumber
: the agreed framework contract numbercontractPosition
: the related position within the framework contract
projectNumber
: The buyer's project number referenceproductionNumber
: The buyer's production number referencesalesOrderNumber
: The buyer's sales order number (not be confused with your sales order number)indicators.noDeliveryExpected
: No goods are expected to be delivered to the buyer, for example a service, fee or text line.indicators.delivered
: All goods are delivered at the buyer.properties
: are key-value based custom fields. may be used for a new line in the value.notes
: are simple custom fields. may be used for a new line.labels
: value-added services labels on line level.documents
: contain meta data and link of attached documents, see:
Item
lines.buyerLine.item
: The item (or article, goods) to be delivered.
number
: the item code or number as known in the buyer ERP system.revision
: the revision (or version) of this item numbername
: the item short namepurchaseUnitOfMeasureIso
: the purchase unit according to ISO 80000-1, a typical example isPCE
supplierItemNumber
: the item code or number as known at the supplier.
Supplier line
supplierLine
is an echo of your order line fields as explained in Send order response.
Status line
lines.statusLine
represents the current order line values related to the current Issued
, Confirmed
or InProgress
process status. The InclRequests
fields also include the InProgress
status and related open buyer or supplier request values.
Single delivery
When using singleDeliveryOrderEvent
one single delivery per order line is used:
lines.statusLine.scheduledDelivery
: the current delivery line, either havingIssued
orConfirmed
values.lines.statusLine.scheduledDeliveryInclRequests
: the current delivery line, either havingIssued
,InProgress
requests orConfirmed
values.
Scheduled delivery fields
lines.statusLine.scheduledDelivery[InclRequests].date
: the delivery date of this delivery line. Date has ISO 8601 dateyyyy-MM-dd
format. See also Standards.lines.statusLine.scheduledDelivery[InclRequests].quantity
: the quantity of this delivery line. Quantity has a decimal1234.56
format with any number of digits.
Scheduled delivery logistics fields
These additional logistics fields are only available in the status line scheduled delivery:
lines.statusLine.scheduledDelivery[InclRequests].status
: the optional delivery line's Scheduled delivery logistics status.lines.statusLine.scheduledDelivery[InclRequests].etd
: The optional logistics Estimated Time of Departure (local date without time zone). Date has ISO 8601 dateyyyy-MM-dd
format.lines.statusLine.scheduledDelivery[InclRequests].eta
: The optional logistics Estimated Time of Arrival (local date without time zone). Date has ISO 8601 dateyyyy-MM-dd
format.
Scheduled delivery logistics status
The delivery line logistics status is one of:
Open
: no or partial quantity Produced, ReadyToShip, Shipped or DeliveredProduced
: the delivery line quantity is produced by the supplierReadyToShip
: the delivery line quantity is ready to be shipped by the supplierShipped
: the delivery line quantity is shipped by the supplierDelivered
: the delivery line quantity is delivered at the buyer
Prices
lines.statusLine.prices
: the current prices, either havingIssued
orConfirmed
values.lines.statusLine.pricesInclRequests
: the current delivery line, either havingIssued
,InProgress
requests orConfirmed
values.
Prices fields
lines.statusLine.prices[InclRequests].grossPrice
: the gross price. Used together withdiscountPercentage
.lines.statusLine.prices[InclRequests].discountPercentage
: the discount percentage. Used together withgrossPrice
.lines.statusLine.prices[InclRequests].netPrice
: the net price.priceInTransactionCurrency
: the price in the transaction currency of the supplier, likeCNY
in China.value
: the price value has a decimal1234.56
format with any number of digits.currencyIso
: the 3-letter currency code according to ISO 4217, likeEUR
,USD
andCNY
priceInBaseCurrency
: the price in your base currency, likeEUR
in the EU.value
: the price value has a decimal1234.56
format with any number of digits.currencyIso
: the 3-letter currency code according to ISO 4217, likeEUR
.
lines.statusLine.prices[InclRequests].priceUnitOfMeasureIso
: the 3-letter price unit according to ISO 80000-1. The purchase unit and price unit may be different.lines.statusLine.prices[InclRequests].priceUnitQuantity
: the item quantity at which the price applies. Typically this is 1 (unit price) or 100 (the price applies to 100 items)
It is advised to only use netPrice
for its simplicity, or alternatively use grossPrice
together with discountPercentage
.
Line status
Line process status
The line process status is one of:
Issued
: the line is (re)issued by the buyerInProgress
: the line is under negotiation between buyer and supplierConfirmed
: the line is agreed between buyer and supplierRejected
: the line is rejected by supplierCompleted
: the line is completed at the buyerCancelled
: the line is cancelled by the buyer
Line in Progress status
The line in progress status is a more fine-grained status when an order line processStatus
is InProgress
and is one of:
OpenSupplierProposal
: There is an open proposal from the supplier.RejectedSupplierProposal
: The proposal from the supplier was rejected and no other requests are open.ReissuedRejectedLine
: The rejected order line was reissued by the buyer.OpenSupplierReopenRequest
: There is an open reopen request from the supplier.OpenBuyerReopenRequest
: There is an open reopen request from the buyer.RevertedCompletedLine
: The completion of this line was reverted.
Line logistics status
The line logistics status is one of:
Open
: no or partial quantity Produced, ReadyToShip, Shipped or DeliveredProduced
: the line quantity is produced by the supplierReadyToShip
: the line quantity is ready to be shipped by the supplierShipped
: the line quantity is shipped by the supplierDelivered
: the line quantity is delivered at the buyerCancelled
: the line is cancelled by the buyer
Item details
The buyer may send item details to inform the supplier about part information.
The supplier may check, change and add item details if they are not correct or incomplete.
lines.mergedItemDetails
will contain the original item details added by the buyer merged with the changed or added item details by the supplier.
countryOfOriginCodeIso2
: The ISO 3166-1 alpha-2 country code of manufacture, production, or growth where an article or product comes from.combinedNomenclatureCode
: A tool for classifying goods, set up to meet the requirements both of the Common Customs Tariff and of the EU's external trade statistics.netWeight
: Net weight of one item.netWeightUnitOfMeasureIso
: Net weight unit according to ISO 80000-1.dangerousGoodsCodeUnece
: UN numbers or UN IDs are four-digit numbers that identify dangerous goods, hazardous substances and articles in the framework of international transport.serialNumber
: is an unique identifier assigned incrementally or sequentially to an item, to uniquely identify it.batchNumber
: is an identification number assigned to a particular quantity or lot of material from a single manufacturer
Last updated