Connect Freight Carrier

Connect a freight carrier account. This is used to supply the appropriate credentials required for connecting to a freight carrier as identified by the SCAC.

Optionally the auth property may be supplied in the request which can be used by an integration to update the credentials for an existing freight carrier connection.

SecurityFreightApiCode
Request
Request Body schema: application/json
transaction_id
required
string
scac
required
string

The NMFTA Standard Carrier Alpha Code is used to identify a freight carrier within the transportation industry.

auth
object

The carrier authorization information needed to fulfill this request.

credentials
required
object

The credentials as required by the carrier. Refer to the integrations registry for the credentials schema supported for each carrier.

Responses
200

OK

400

Bad Request

429

Too Many Requests

500

Internal Server Error

520

External Server Error

post/connect-freight-carrier
Request samples
application/json
{
  • "transaction_id": "string",
  • "scac": "string",
  • "auth": { },
  • "credentials": { }
}
Response samples
application/json
{
  • "transaction_id": "string",
  • "scac": "string",
  • "auth": { }
}