Cargado API is in beta. The API may change in breaking ways.
curl --request POST \
--url https://api.cargado.com/carrier-relationships/upsert \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"carrierRelationships": [
{
"carrier": {
"dotNumber": "<string>",
"mcNumber": "<string>",
"mxNumber": "<string>",
"rfcNumber": "<string>",
"cvorNumber": "<string>",
"nirNumber": "<string>",
"nscNumber": "<string>",
"externalId": "<string>"
},
"status": "ACTIVE",
"onboardingStatus": "ONBOARDED",
"carrierExternalId": "<string>"
}
]
}
'{
"carrierRelationships": [
{
"id": "<string>",
"organizationId": "<string>",
"carrierOrganizationId": "<string>",
"status": "ACTIVE",
"onboardingStatus": "ONBOARDED",
"source": "API",
"carrierExternalId": "<string>"
}
]
}Create or update carrier relationships and statuses from your TMS to Cargado. If a carrier is not found, the relationship will be null. Returns the relationships in the same order and length as the input.
curl --request POST \
--url https://api.cargado.com/carrier-relationships/upsert \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"carrierRelationships": [
{
"carrier": {
"dotNumber": "<string>",
"mcNumber": "<string>",
"mxNumber": "<string>",
"rfcNumber": "<string>",
"cvorNumber": "<string>",
"nirNumber": "<string>",
"nscNumber": "<string>",
"externalId": "<string>"
},
"status": "ACTIVE",
"onboardingStatus": "ONBOARDED",
"carrierExternalId": "<string>"
}
]
}
'{
"carrierRelationships": [
{
"id": "<string>",
"organizationId": "<string>",
"carrierOrganizationId": "<string>",
"status": "ACTIVE",
"onboardingStatus": "ONBOARDED",
"source": "API",
"carrierExternalId": "<string>"
}
]
}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.