EndpointsCarriers

Create a carrier

Create a new carrier with Highway verification and fraud checking. Returns existing carrier if MC number matches.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Organization-IDstring or nullOptional

Request

This endpoint expects an object.
namestringRequired>=1 character
Carrier company name
tms_carrier_idstring or nullOptional

TMS carrier service ID (e.g., Salesforce CarrierService ID)

mc_numberstring or nullOptional
MC number
emailstring or nullOptional
Primary email
phonestring or nullOptionalformat: "^\+[1-9]\d{1,14}$"8-16 characters

Primary phone (any common format, stored as E.164)

dispatcher_namestring or nullOptional
Dispatcher name
dispatcher_phonestring or nullOptionalformat: "^\+[1-9]\d{1,14}$"8-16 characters

Dispatcher phone (any common format, stored as E.164)

dispatcher_emailstring or nullOptional
Dispatcher email
contactslist of objects or nullOptional
Typed contacts list
on_time_delivery_pctdouble or nullOptional

On-time delivery percentage

on_time_pickup_pctdouble or nullOptional

On-time pickup percentage

total_loads_hauledinteger or nullOptional
Total loads hauled
is_onboardedbooleanOptionalDefaults to false
Whether carrier is onboarded
equipment_typeslist of enums or nullOptional
Equipment types this carrier can haul
carrier_rep_namestring or nullOptional
Carrier rep owner full name
carrier_rep_emailstring or nullOptional
Carrier rep owner email

Response

Successful Response
idstringformat: "^car_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
namestring
mc_numberstring or null
dot_numberstring or null
emailstring or null
phonestring or null
dispatcher_namestring or null
dispatcher_phonestring or null
dispatcher_emailstring or null
is_activebooleanDefaults to true
providerstring or null
ingestion_methodstring or null
equipment_typeslist of enums or null
insurance_expirationdatetime or null
w9_on_fileboolean or null
authorized_for_hireboolean or null
on_time_pickup_pctdouble or null
on_time_delivery_pctdouble or null
tracking_compliance_pctdouble or null
avg_response_time_mindouble or null
total_loads_hauledinteger or null
is_onboardedbooleanDefaults to false
carrier_rep_user_idstringformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
carrier_rep_namestring or null
carrier_rep_emailstring or null
is_verifiedbooleanDefaults to false
verified_datedatetime or null
created_atdatetime or null
updated_atdatetime or null

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error