Cancel Shipment

Cancel an existing shipment in the warehouse management system.

Direction External System → WMS

HTTP Method POST

Path /inbound/shipment/cancel/{shipmentNumber}

Path Parameters

• shipmentNumber (string) - The unique shipment number to cancel

Response Codes

200: Shipment successfully cancelled

400: Invalid shipment number

401: Authentication required

404: Shipment not found

409: Shipment cannot be cancelled (invalid status)

Success Response (200)

{
  "success": true,
  "shipmentNumber": "SHP-2024-001234",
  "status": "CANCELLED",
  "cancelledAt": "2024-01-20T14:30:00Z",
  "message": "Shipment successfully cancelled"
}

Error Response (404)

{
  "success": false,
  "error": "SHIPMENT_NOT_FOUND",
  "message": "No shipment found with number: SHP-2024-001234"
}

Error Response (409)

{
  "success": false,
  "error": "INVALID_STATUS",
  "message": "Shipment cannot be cancelled - current status: RECEIVED",
  "currentStatus": "RECEIVED",
  "allowedStatuses": ["PENDING", "IN_TRANSIT"]
}

Example Usage

curl -X POST \
  https://api.wms.example.com/inbound/shipment/cancel/SHP-2024-001234 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"