Despatch-advice v2

Version: 1.0, Date: 2026-10-01

Revision history

DateVersionDescription
2026-10-011.0Initial version.

Purpose

Confirm what was actually shipped to the carrier.

Integration touch points

Diagram

State

  • The endpoint is under development.

Despatch advice

Request & Response

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

Technical exceptions

  • Despatch-advice reference already exists: 409 error response
    • Recovery action: resubmit the complete Despatch-advice with new reference
  • Consignment not found: 400 error response,
    • Recovery action:
      • If consignment should be included: do a label request for that missing consignment
      • Resubmit the complete Despatch-advice with correct consignments
  • Consignment Collection AddressMismatch: 400 error response
    • Recovery action:
      • Ensure that all shipments have the same collection address and that it matches the one in the Despatch-advice request
      • Resubmit the complete Despatch-advice with correct address/shipments
  • Consignment Carrier Mismatch: 400 error response
    • Recovery action:
      • Ensure that all shipments have the same carrier reference
      • Resubmit the complete Despatch-advice
  • Consignments Already In Pickup: : 400 error response
    • Recovery action:
      • Remove the reported consignments from Despatch-advice request
      • Resubmit the corrected Despatch-advice