Despatch-advice

Version: 2.0, Date: 2025-06-27

Revision history

Date	Version	Description
2025-05-21	1.0	Initial version.
2025-06-27	2.0	added View the Despatch-Advice API schema documentation

Purpose

Confirm what was actually shipped to the carrier.

Integration touch points

State

• The endpoint will be available for testing latest 1-sep-2025.

Despatch advice

Request & Response

For the request, response and samples: see the Despatch-advice API schema documentation.

Functional exceptions

• Add or Remove handlingUnit after despatch-advice is communicated with carrier:
  • Existing shipments/despatch-advice cannot be changed anymore: the despatch-advice is final.
  • Recovery action:
    • Manually inform the carrier of shipment communicated but not loaded
    • Relabel affected shipment (if despatch-advice contains multiple shipments, only the affected shipment should be re-processed) with new shipment references and sent despatch-advice again.

Technical exceptions

• Despatch-advice already confirmed with same hundlingUnits: response will still be 200
  • Recovery action: No action required
• Despatch-advice reference already used with other handlingUnits and ordered with carrier: 400 error response
  • Recovery action: resubmit the complete Despatch-advice with new reference
• Despatch-advice reference already used with other handlingUnits and not yet ordered: 200 response
  • Recovery action: No action required, it will overwrite old Despatch-advice
• HandlingUnit not found: 400 error response,
  • Recovery action:
    • If handlingUnit should be included: do a label request for that missing handlingUnit
    • Resubmit the complete Despatch-advice with correct handlingUnits
• Carrier integration failed: 400 error response
  • This should not happen as the label generation should then already have stopped the process. This must be an incident on communication.
  • Recovery action: resubmit the complete Despatch-advice with correct handlingUnits