Sign in
freight

Cancel a freight shipment

Cancel a booked freight shipment with the carrier. The response indicates whether the associated pickup was also cancelled.

Cancellation windows are set by the carrier. A shipment that has already been picked up usually cannot be cancelled, and the provider's rejection is returned as a 400 Bad Request.

delete/v1/freight/shipments/{freight_shipment_id}

Response

The request was a success.

freight_shipment_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

pickup_cancelledboolean

true when the carrier also voided the associated pickup request. false when the shipment had no pickup or the carrier did not confirm the pickup was cancelled.

Example response

{
  "freight_shipment_id": "se-28529731",
  "pickup_cancelled": true
}

Changes

Changed in 2 of the 6 revisions of this API.12

  • 422fd75e1e3511See the full diff
    • ●

      removed the optional property cancelled_transactions from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property pickup_cancelled to the response with the 200 status

      response-optional-property-added

  • f3a66d2045651See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog