Update an existing order

As buyer you can send either a new or updated purchase order to Tradecloud.

Order process

Danger

Most supplier ERP integrations do not have the capability to automatically process an updated order. It will be processed manually by the supplier and the order will have a longer human response time.

• If an order line has order process status Issued or In Progress and it is updated, it will keep the same status.
• If the line has status Rejected (by supplier) and it is reissued, it will become In Progress.
• If the line has status Confirmed and it is reopened, it will become In Progress.
• If the line is In Progress with an open buyer reopen request and your update makes the requested delivery schedule, prices and charge lines equal to the confirmed values again, Tradecloud reverts that reopen request. See Revert a reopen request.
• If the line has status Completed and the line-level indicator completed=false is set explicitly, the completion is reverted. See Revert completion.
• If the line has status Cancelled and the line-level indicator cancelled=false is set explicitly, the cancellation is reverted. See Revert cancellation.
• Omitting the completed or cancelled indicator leaves the line unchanged and is not the same as sending false. An indicator false on order level does not revert.

Endpoints

Use the Send order endpoint when your ERP system supports a delivery schedule natively.

Or use the Send single delivery order endpoint for the single delivery per order line feature.

Please see this page to choose between the delivery schedule or single delivery per order line:

Send a delivery scheduleChoose between delivery schedule or single delivery per order line

Tradecloud will update the order based on the purchaseOrderNumber and will add or update lines, delivery schedules and delivery histories where needed.

Order lines will be matched based on lines.position, deliverySchedule.position and deliveryHistory.position.

Note

The order update should preferable only contain order lines that are new or changed. But you can also send all lines anyway.

Additional fields

Actual delivery history

The actual delivery history may be added in an order update when your ERP system supports a delivery schedule natively. These will be used to calculate the line Overdue indicator.

The actual delivery history is matched against the delivery schedule by date and quantity, not by delivery line position. deliveryHistory.position and deliverySchedule.position do not have to use the same values.

Note

For stock items with delivery tolerances, you may additionally set indicators.delivered on the line to mark it delivered when the received quantity is within tolerance. Unlike the delivery history, the delivered indicator is applied by order line or delivery line position. When set on the order line, all its delivery schedule lines become delivered, including delivery schedule lines without a position. A logistics status sent per delivery schedule line (deliverySchedule.status) is matched by position, so delivery schedule lines without a position are not changed by it. See Delivered indicator.

• lines.deliveryHistory: the historical actual delivery schedule. Provide zero, one or multiple delivery history lines. Provide all delivery history lines in an update. The total number of delivery history lines is limited to 100 lines per order line.
• deliveryHistory.position: the position in the delivery schedule. Not to be confused with the line.position. deliverySchedule.position versus deliveryHistory.position do not have to use the same values.
• deliveryHistory.date: the actual delivery date of this delivery schedule position. Date has ISO 8601 date yyyy-MM-dd format. See also Standards.
• deliveryHistory.quantity: the actual delivered quantity of this delivery schedule position. Quantity has a decimal 1234.56 format with any number of digits.

Actual delivery

Or use the actual delivery field when using the single delivery per order line:

• lines.actualDelivery: the actual delivery at the buyer for this order line.
• actualDelivery.date: the actual delivery date of this delivery. Date has ISO 8601 date yyyy-MM-dd format. See also Standards.
• actualDelivery.quantity: the actual delivered quantity of this delivery. Quantity has a decimal 1234.56 format with any number of digits.

Caution

The deliveryHistory (multiple actual deliveries) field is not supported when using the single delivery feature. Let support know when you need deliveryHistory for single delivery.

Additional order and line indicators

Additional indicators may be set in an order update:

• indicators:

Receive goodsHow to announce the buyer has received goods

Complete an orderHow to complete an order or line

Cancel an orderHow to request the supplier to cancel an order or line

Reopen an orderHow to request the supplier to reopen an order line

Updated order meta data

• erpLastChangeDateTime: Date and time the order was updated in your ERP system. DateTime has ISO 8601 local date/time format yyyy-MM-ddThh:mm:ss. See also Standards.
• erpLastChangedBy: the user email or user name as known in your ERP system who updated this order