Documentation Index
Fetch the complete documentation index at: https://docs.cargado.com/llms.txt
Use this file to discover all available pages before exploring further.
You can sync carrier relationships and statuses from your TMS to Cargado. This has several benefits including:
- Preventing do not dispatch carriers from seeing your freight
- Carriers who are not onboarded will be offered an onboarding link upon match.
- Carriers who are active can be immediately assigned to freight.
How it works
You can upsert a carrier relationship by providing the carrier identifiers, their relationship status, and their onboarding status.
POST /carrier-relationships/upsert
Api-Key: <API Key>
Content-Type: application/json
{
"carrierRelationships": [
{
"carrier": {
"dotNumber": "1234567",
"mcNumber": "2342342"
},
"status": "ACTIVE",
"onboardingStatus": "ONBOARDED"
},
{
"carrier": {
"rfcNumber": "012345678912"
},
"status": "DO_NOT_DISPATCH",
"onboardingStatus": "ONBOARDED"
}
]
}