Truckload

Retract awarded shipment

This endpoint can be used to retract an awarded truckload shipment from a carrier. Only shipments that are in status awarded or confirmed can be retracted.

post/v2.0/shipments/truckload/{shipmentId}/retract

Request

  • Base URL: https://api.freightview.dev
  • URL: https://api.freightview.dev/v2.0/shipments/truckload/{shipmentId}/retract
  • Auth: OAuth 2 (client credentials, token URL /v2.0/auth/token)

Path parameters

shipmentIdstring required

The unique identifier in Freightview for the shipment.

Request body

notifyCarrierboolean required

A flag to indicate whether the carrier should be notified of the retraction.

Response

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.