COconvoy
loads

Unassign a load

The api unassigns a load from a carrier that was matched on Convoy Platform. To unassign a load successfully, the carrier DOT number or MC number is required and must match the assigned carrier. An unassign reason is defaulted to NO_REASON_PROVIDED if not provided. If the load is not currently assigned to a carrier, the api will return a 200 Accepted response.

post/load/unassign

Request

  • Base URL
    https://demo-developer.convoy.com/broker
  • Auth
    HTTP bearer

Headers

X-Convoy-API-Versionstring required

The Convoy API version

Request body

externalIdstring required

Unique ID for the load, recommended to match a unique identifier in the caller's external system. This identifier will only be displayed to the carrier after booking.

unassignReason'CARRIER_RATE_ISSUE' | 'NO_CALL_NO_SHOW' | 'SHIPMENT_ISSUE' | 'BROKER_MATCHED_INTERNALLY' | 'CARRIER_ISSUE_GENERAL' | 'CARRIER_PERFORMANCE_OR_BEHAVIOR' | 'CARRIER_DOES_NOT_WANT_LOAD' | 'CARRIER_UNRESPONSIVE_TO_FOLLOWUP' | 'CARRIER_QUALIFICATION' | 'BROKER_ISSUE' | 'SEVERE_WEATHER_OR_UNFORESEEN_EVENT' | 'NO_REASON_PROVIDED' required

The reason the load is either unassigned or canceled

StatusDescription
CARRIER_RATE_ISSUEThe carrier has an issue with the rate.
NO_CALL_NO_SHOWThe carrier did not call or show up for the load.
SHIPMENT_ISSUEThere was a general issue with the shipment.
BROKER_MATCHED_INTERNALLYThe broker matched the load internally.
CARRIER_ISSUE_GENERALThere was a general issue with the carrier.
CARRIER_PERFORMANCE_OR_BEHAVIORThe carrier's performance or behavior was an issue.
CARRIER_DOES_NOT_WANT_LOADThe carrier does not want the load.
CARRIER_UNRESPONSIVE_TO_FOLLOWUPThe carrier was unresponsive to followup.
CARRIER_QUALIFICATIONThe carrier's qualifications were not sufficient for the load.
BROKER_ISSUEThere was a general issue with the broker.
SEVERE_WEATHER_OR_UNFORESEEN_EVENTSevere weather or unforeseen event occurred.
NO_REASON_PROVIDEDNo reason was provided.
unassignMessagestring

A message from the broker about why they unassigned the load

brokerSelectedReasonstring

The exact wording of what the broker selected in the TMS when unassigning the load

Example request

{
  "externalId": "ABC1234",
  "carrier": {
    "dotNumber": "12345678"
  },
  "unassignReason": "NO_CALL_NO_SHOW",
  "unassignMessage": "Carrier did not respond to outreach",
  "brokerSelectedReason": "Didn't pick up call"
}

Response

Load was accepted for unassignment.

object required

Changes

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