CAcargoai

Update Shipment

Changed on

Updates an existing shipment record and returns 200 OK with the full record. Only the fields you send change, and version goes up by 1.

patch/shipments/{shipmentId}

Request

  • Base URL
    https://api.cargoai.co/solutions
  • URL
    https://api.cargoai.co/solutions/shipments/{shipmentId}
  • Auth
    API key in header x-api-key

Path parameters

shipmentIdstring required

The shipmentId returned when the shipment was created.

Headers

x-api-keystring required

Your CargoCONNECT API key.

Request body

hawbNumberstring

House air waybill number issued by the forwarder. Required if no Master AWB Number provided in the request.

mawbNumberstring

Master air waybill (AWB) number issued by the airline, format XXX-NNNNNNNN. Used to match booking callbacks. Required if no House AWB Number provided in the request.

status'DRAFT' | 'BOOKED' | 'IN_TRANSIT' | 'AT_DESTINATION' | 'DELIVERED' | 'CANCELLED' | 'EXCEPTION'

Overall status of the shipment.

Response

OK. The full merged shipment.

shipmentIdstring required

Unique ID of the record, used in PATCH calls. UUID set by the server.

versioninteger required

Revision number of the record. 1 on create, +1 on each PATCH.

hawbNumberstring

House air waybill number issued by the forwarder. Required if no Master AWB Number provided in the request.

mawbNumberstring

Master air waybill (AWB) number issued by the airline, format XXX-NNNNNNNN. Used to match booking callbacks. Required if no House AWB Number provided in the request.

status'DRAFT' | 'BOOKED' | 'IN_TRANSIT' | 'AT_DESTINATION' | 'DELIVERED' | 'CANCELLED' | 'EXCEPTION' required

Overall status of the shipment.

createdAtstring required

When the record was created. RFC 3339, UTC. Set by the server.

lastUpdatedAtstring required

When the record was last changed. RFC 3339, UTC. Set by the server.

Changes