CarrierCloud (v1) - Universal Transportation API

Relationships

Download schema

Partner Network relationships: list the partners you can act for and request new partnerships.

Partners - Request Partnership

POST

https://carriercloud.ai

/v1/partners/request

Initiate a request through the partner network for access to their network environment

Partners - Request Partnership › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Partners - Request Partnership › Request Body

identifier

string · enum · required

Type of identifier used to request partnership

Enum values:

companycode

dot

mcnumber

ein

scac

value

string · required

email

string

requiredIntegrationTypes

string[]

Optional list of integration types required by the partner

Enum values:

telematics

Partners - Request Partnership › Responses

Request submitted (plain text).

string

Partners - Get Active Partners

GET

https://carriercloud.ai

/v1/partners

Get a list of active partners in your network.

Partners - Get Active Partners › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Partners - Get Active Partners › Responses

Companies in your Partner Network.

object[]

A company in your Partner Network. Every key is present; unknown values are null.

Id

string | null

Partner company identifier.

Code

string | null

Partner code to use as {partnercode} on every partner-scoped route.

Name

string | null

Address

string | null

City

string | null

State

string | null

Zipcode

string | null

Phone

string | null

Email

string | null

Website

string | null

AccessApproved

boolean | null

True when the partnership is approved for API access.

Partners Dropdown Options