Tradecloud API v2 manual
  • Introduction
    • Welcome
      • Checklist
      • Support
    • API
      • Rules
      • Requests
      • JSON versus XML
      • Environments
      • Standards
      • Compatibility
      • Tools
        • Swagger UI
        • Postman
        • .NET SDK
      • Webhook versus polling
        • Polling usage
        • Polling echo
      • Delivery schedule
    • Security
      • Security overview
      • Authentication
      • Authorization
      • Encryption
      • Document storage
  • Guide
    • 1. Getting an Account
    • 2. Sending your first order
      • Option A: Sending a Delivery Schedule per order line
      • Option B: Sending a Single Delivery per order line
  • Processes
    • Forecasts
      • Issue a new forecast
      • Issue a new Slimstock forecast
    • Orders
      • Buyer order process
        • Issue a new order
          • Delivery schedule
          • Indicators
          • No delivery expected
          • Propose when accepted
          • Attach a document to an order
          • Choose attach document API
        • Update an existing order
        • Receive an order response
          • Download a document attached to an order response
          • Single delivery order response
        • Receive goods
        • Complete an order
        • Reopen an order
        • Cancel an order
      • Supplier order process
        • Receive an order
          • Download a document attached to an order
          • Single delivery order
        • Send order response
          • Attach a document to an order response
        • Reopen an order
        • Cancel an order
    • Shipments
      • Supplier shipment process
        • Send despatch advice
      • Buyer shipment process
        • Receive a shipment event
          • Download a document attached to a shipment
Powered by GitBook
On this page
  • Actual delivery history
  • Send the delivery history by updating an order using the /order endpoint
  • Send delivery events using the /api-connector/order/deliveries endpoint
  • Delivered indicator
  • Mark as delivered by updating an order using the /order endpoint
  • Mark as delivered by sending the delivered indicator using the /order/indicators endpoint
  1. Processes
  2. Orders
  3. Buyer order process

Receive goods

How to announce the buyer has received goods

PreviousSingle delivery order responseNextComplete an order

Last updated 3 months ago

There are two ways to announce the buyer has received goods:

  • using the actual delivery, which is preferred over the delivered indicator, as it is more precise regarding partial deliveries.

  • using the delivered indicator

Actual delivery history

The delivery history contains the actual physical deliveries. With the actual deliveries versus the planned deliveries, Tradecloud can calculate which goods should still be delivered or are overdue.

There are two ways to send the delivery history to Tradecloud:

Send the delivery history by updating an order using the /order endpoint

Send the actual delivery schedule by setting the lines.deliveryHistory field when your ERP system supports a delivery schedule natively, and update the order using the endpoint.

Send the actual delivery by setting the lines.actualDelivery field when using the single delivery per order line feature, and update the order using the endpoint.

Send delivery events using the /api-connector/order/deliveries endpoint

Send delivery events for one or multiple existing order lines using the endpoint. This will append the deliveries to the order line's delivery history.

Before adding a delivery to an order, the order must have been sent to Tradecloud first.

The /order/deliveries endpoint is not supported when using the single delivery feature. Let know when you need this endpoint for single delivery.

Delivered indicator

When an order or line is received, regardless of actual quantity or date, it can be marked as delivered by setting indicators.delivered on either order or line level.

Single delivery behavior:

When the primary or any related split lines is delivered; the corresponding delivery line will become delivered.

Mark as delivered by updating an order using the /order endpoint

If you provide a delivered indicator on order level, ONLY the lines provided in this order message will be marked as delivered.

If you also provide a delivered indicator on line level, it has precedence over the order level delivered indicator.

Mark as delivered by sending the delivered indicator using the /order/indicators endpoint

If you provide a delivered indicator on order level, ALL the lines in the order will be delivered.

If you also provide a delivered indicator on line level, it has precedence over the order level delivered indicator.

The existing order or line can be marked as delivered by setting indicators.delivered on either order or line level and updating the order using the endpoint:

The order or line can be marked as delivered by setting indicators.delivered on either order or line level and sending this indicator only, using the endpoint.

The /order/indicators endpoint is not supported when using the single delivery feature. Let know when you need this endpoint for single delivery.

Send order
Send single delivery order
Update an existing order
Send order deliveries events
support
Send order
Update an existing order
Send order indicators
support