LTL

Cancel shipment

This endpoint can be used to cancel an LTL shipment in Freightview. If the LTL shipment was booked with schedulePickup set to true, (i.e. a pickup request was scheduled with the LTL carrier through Freightview) then Freightview will attempt to cancel the associated pickup request as well.

<div class="blockquote alert-important"> <div class="alert-important-title">Important</div> There are cases where Freightview will be unable to cancel the shipment via the carrier's API. Use the <code>method</code> and <code>message</code> fields in the response to determine if any manual intervention is required in order for the LTL pickup request to be fully canceled within the associated LTL carrier's system. </div>
delete/v2.0/shipments/ltl/{shipmentId}

Request

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

Path parameters

shipmentIdstring required

The unique identifier in Freightview for the shipment.

Response

Success

status'ok' | 'pending' | 'error'

The status of the cancellation in Freightview.

method'email' | 'api' | 'manual'

The method used to cancel the shipment's pickup request with carrier (if applicable).

  • If api, then Freightview is using the carrier's "cancel pickup request" API to cancel the pickup request associated with the shipment.
  • If email, then Freightview has sent an email to the carrier to request they cancel the pickup request associated with the shipment.
  • If manual, then you will need to manually reach out to the carrier to cancel the pickup request associated with the shipment.
messagestring

Contains relevant human-readable information regarding the cancellation of the shipment.

Changes

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