Sign in
ltl

Connect LTL carrier

Connect a new LTL carrier account by providing the required credentials. Use the credential requirements endpoint to determine what fields are needed.

post/v-beta/ltl/carriers

Request body

carrier_codestring required

SCAC code for the carrier

credentialsobject required

Carrier-specific credentials (use credential_requirements endpoint to get required fields)

nicknamestring

Optional friendly name for this carrier connection

Example request

{
  "carrier_code": "FXFE",
  "nickname": "FedEx Freight Production"
}

Response

Carrier successfully connected

carrier_idstring uuid

Unique identifier for the carrier

namestring

Carrier name

countriesstring[]

Countries supported by this carrier

featuresstring[]

Features supported by this carrier

Example response

{
  "carrier_id": "aed2a8c0-7998-4fef-9a82-2cab5f527dc2",
  "name": "Test Carrier",
  "countries": [
    "US",
    "CA",
    "MX"
  ],
  "features": [
    "quote",
    "spot_quote",
    "scheduled_pickup",
    "tracking"
  ],
  "options": [
    {
      "code": "lftp",
      "name": "Lift gate required at pickup"
    }
  ],
  "packages": [
    {
      "code": "PLT",
      "name": "Pallet"
    }
  ]
}

Changes