Receive an order
How to receive a purchase order sent by the buyer.
Tradecloud will send a new purchase order to the supplier when an order event has been triggered.
First choose either the webhook API or the polling API to receive order messages:
If you choose the POST webhook API, you may choose between the native or simple delivery schedule:
id
(in case of an Order): the Tradecloud order identifierorderId
(in case of an OrderEvent): the Tradecloud order identifierbuyerOrder
: the buyer part of the order, see below.supplierOrder
: the supplier part of the order.indicators.deliveryOverdue
is true when at least one order line is overdue.version
: the Tradecloud order version number.eventDates
: some key order event date/times.meta
: meta information, including source and trace info, about this messsagelastUpdatedAt
: is the latest date time the order has been changed, useful for polling orders.
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
orForecast
.
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.lines
contains one or more order lines:id
: the Tradecloud line identifier.deliveryScheduleIncludingRequests
: the current aggregated delivery schedule including requests, see Current delivery schedule.pricesIncludingRequests
: the actual prices, including any open supplier or buyer requests, see Prices.indicators.deliveryOverdue
is true when the order line is overdue.eventDates
: some key line event date/times.lastUpdatedAt
: is the latest date time the order line has been changed, useful for polling.
deliverySchedule
: the current aggregated delivery schedule with logistics info, see Native Delivery Schedule below.deliveryScheduleIncludingRequests
: the current aggregated delivery schedule including any open supplier or buyer requests, see Native Delivery Schedule below.
It is strongly advised to use the
lines.deliverySchedule
together with the lines.prices
fields, which are the current delivery schedule and prices. It gives a simpler alternative for the deliverySchedule
and prices
fields in different places like buyerLine
, buyerLine.requests
, supplierLine.requests
and confirmedLine
.The
lines.deliveryScheduleIncludingRequests
together with lines.pricesIncludingRequests
fields include any open supplier or buyer request. You can use the IncludingRequests
fields when you need the deliverySchedule
and prices
fields in the proposal or reopen requests as soon as possible, before approving, in your ERP.The
deliveryScheduleIncludingRequests
, prices
and pricesIncludingRequests
fields are only available in the new webhook, using the "Orders Webhook Integration" configuration in your company settings page, and are also available in the order-search
API when using polling.scheduledDelivery
: the current aggregated delivery line with logistics info, see Simple Delivery Schedule below.
The
scheduledDelivery
field includes any open supplier or buyer request, there is no separate scheduledDeliveryIncludingRequests
variant available.Order and line process status is one of:
Issued
: (re)issued by the buyer.InProgress
: under negotiation between buyer and supplierConfirmed
: agreed between buyer and supplierRejected
: rejected by supplierCompleted
: completed at the buyerCancelled
: cancelled by either buyer or supplier
Order, line and delivery line logistics status is one of:
Open
: no or partial quantity Produced, ReadyToShip, Shipped or DeliveredProduced
: full quantity produced by the supplierReadyToShip
: full quantity ready to be shipped by the supplierShipped
: full quantity shipped by the supplierDelivered
: full quantity delivered at the buyer
buyerLine
contains the buyer order line fields:position
: the line position within the purchase order
item
: the item (or article, goods) to be deliverednumber
: 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.
lines.itemDetails
: detailed part information initially provided by buyer.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.
The
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
lines.deliverySchedule
: the current delivery schedule, either Issued
or Confirmed
.The
deliverySchedule
field does NOT include any open supplier or buyer request. Be aware that the Issued
or Confirmed
values are returned, dependent on the line status.lines.deliveryScheduleIncludingRequests
: the current delivery schedule, including any open supplier or buyer request, either Issued
, In Progress
or Confirmed
values.The
deliveryScheduleIncludingRequests
field does include any open supplier or buyer request. Be aware that either the Issued
, proposal or reopen request or Confirmed
values are returned, dependent on the line and request status.position
: the optional position in the delivery schedule. Not to be confused with theline.position
date
: the delivery date of this delivery schedule position. Date has ISO 8601 dateyyyy-MM-dd
format. See also Standards.quantity
: the quantity of this delivery schedule position. Quantity has a decimal1234.56
format with any number of digits.
These additional logistics fields are only available in the order line level delivery schedule:
etd
: The optional logistics Estimated Time of Departure (local date without time zone). Date has ISO 8601 dateyyyy-MM-dd
format.eta
: The optional logistics Estimated Time of Arrival (local date without time zone). Date has ISO 8601 dateyyyy-MM-dd
format.
lines.scheduledDelivery
: the current delivery line, including open proposal or reopen requests, when using the simple delivery schedule.The
scheduledDelivery
field does include any open supplier or buyer request. Be aware that either the Issued
, proposal or reopen request or Confirmed
values are returned, dependent on the line and request status.date
: the delivery date of this delivery line. Date has ISO 8601 dateyyyy-MM-dd
format. See also Standards.quantity
: the quantity of this delivery line. Quantity has a decimal1234.56
format with any number of digits.
etd
: The optional logistics Estimated Time of Departure (local date without time zone). Date has ISO 8601 dateyyyy-MM-dd
format.eta
: The optional logistics Estimated Time of Arrival (local date without time zone). Date has ISO 8601 dateyyyy-MM-dd
format.
lines.prices
: the requested price. Buyers are advised to provide only netPrice
for its simplicity, or alternatively grossPrice
together with discountPercentage
.grossPrice
: the gross price. Used together withdiscountPercentage
.discountPercentage
: the discount percentage. Used together withgrossPrice
.netPrice
: the net price.priceInTransactionCurrency
: the price in the transaction currency, 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
: optional price in the buyer's 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
.
priceUnitOfMeasureIso
: the price unit according to ISO 80000-1. The purchase unit and price unit may be different.priceUnitQuantity
: the item quantity at which the price applies. Typically this is 1 (unit price) or 100 (the price applies to 100 items)
lines.chargeLines
: the requested additional cost lines of an order line, independent of the order line prices, like transport, packing, administration, inspection and certification costs.position
: the position used to identify a charge line.chargeDescription
: a mandatory free text description, like "Transport costs".quantity
: the mandatory quantity of this charge line.price
: the mandatory price of this charge line.priceInTransactionCurrency
: the mandatory 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 optional price in your base currency, likeEUR
in the EU.
priceUnitOfMeasureIso
: the 3-letter price unit according to ISO 80000-1 which applies to the charge line price.
requests.reopenRequest
: the buyer requests to reopen the confirmed order line. The buyer has requested a different delivery schedule, prices and/or charge lines compared to the confirmed order line.deliverySchedule
: requested alternative delivery schedule, see belowprices
: requested alternative prices, see belowchargeLines
: requested alternative charge lines, see belowreason
: the reason of this request given by the buyer
The request status is one of:
Open
: Requested by the buyer. To be approved or rejected by the supplier.Approved
: The request is approved by the supplier.Rejected
: The request is approved by the supplier.Closed
: The request is closed because it is not relevant anymore.
If the request status is
Open
the supplier must approve or reject it.description
: a free format additional description of this lineterms
: 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:
salesOrderNumber
: the sales order number as known in your ERP systemsalesOrderPosition
: the position within the sales order
confirmedLine
: the agreed order line between buyer and supplier.deliverySchedule
: agreed delivery schedule, see belowprices
: agreed prices, see belowchargeLines
: agreed charge lines, see below
deliverySchedule
: the actual delivery schedule, either Issued
or Confirmed
.deliveryScheduleIncludingRequests
: the actual delivery schedule, either Issued
, In Progress
(having an open Proposal
or Reopen Request
) or Confirmed
.position
: the optional position in the delivery schedule. Not to be confused with theline.position
date
: the delivery date of this delivery schedule position. Date has ISO 8601 dateyyyy-MM-dd
format. See also Standards.quantity
: the quantity of this delivery schedule position. Quantity has a decimal1234.56
format with any number of digits.
These additional logistics fields are only available in the order line level delivery schedule:
deliverySchedule
: the requested or confirmed delivery schedule.etd
: The optional logistics Estimated Time of Departure (local date without time zone). Date has ISO 8601 dateyyyy-MM-dd
format.eta
: The optional logistics Estimated Time of Arrival (local date without time zone). Date has ISO 8601 dateyyyy-MM-dd
format.
prices
: the actual prices, either Issued
or Confirmed
.pricesIncludingRequests
: the actual prices, either Issued
, In Progress
(having an open Proposal
or Reopen Request
) or Confirmed
.grossPrice
: the gross price. Used together withdiscountPercentage
.discountPercentage
: the discount percentage. Used together withgrossPrice
.netPrice
: the net price.priceInTransactionCurrency
: the price in the transaction currency, 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 optional 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
.
priceUnitOfMeasureIso
: the 3-letter price unit according to ISO 80000-1. The purchase unit and price unit may be different.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
.chargeLines
: the requested or confirmed additional cost lines of an order line, independent of the order line prices, like transport, packing, administration, inspection and certification costs.position
: the position used to identify a charge line.chargeDescription
: a mandatory free text description, like "Transport costs".quantity
: the mandatory quantity of this charge line.price
: the mandatory price of this charge line.priceInTransactionCurrency
: the mandatory 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 optional 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
.
priceUnitOfMeasureIso
: the 3-letter price unit according to ISO 80000-1 which applies to the charge line price.
Last modified 15d ago