Skip to main content

Shipments

Shipment endpoints handle creation, retrieval, and cancellation.

Create shipment​

POST /shipments

Creates a shipment and returns the identifiers needed for operational processing and customer visibility.

Key request fields:

  • externalOrderId
  • quoteId
  • serviceLevel
  • sender
  • recipient
  • parcels
  • codAmount

Headers:

  • X-API-Key
  • Idempotency-Key

Key response fields:

  • shipmentId
  • trackingNumber
  • status
  • labelUrl

Retrieve shipment​

GET /shipments/{shipmentId}

Returns the current shipment record by Aquiline shipment identifier.

Cancel shipment​

POST /shipments/{shipmentId}/cancel

Cancels a shipment when the operational state still allows cancellation.

Integration guidance​

  • Persist both shipmentId and trackingNumber
  • Store idempotency keys with original payloads
  • Surface shipment exceptions to customer support tooling