Tranztec CarrierCloud
CarrierCloud (v1) - Universal Transportation API
CarrierCloud (v1) - Universal Transportation API

Dropdown Options

Download schema

Tenant-specific lookup values used in other requests, such as equipment types, service types, commodities, statuses and units.

Dropdown Options - Get Equipment Types

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/equipmenttypes

Returns a list of valid Options / Dropdown Options for Equipment Type for a specific partner.

Dropdown Options - Get Equipment Types › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Equipment Types › 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.

Dropdown Options - Get Equipment Types › Responses

The partner's equipment types. Send Abbr in requests.

​object[]
A lookup value configured for the partner company.
Abbr
​string · required

Code to send in requests.

Name
​string · required

Display name.

systemState
​string | null

For status lists: the platform state the option maps to.

Dropdown Options - Get Service Types

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/servicetypes

Returns a list of valid Options / Dropdown Options for Service Type for a specific partner.

Dropdown Options - Get Service Types › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Service Types › 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.

Dropdown Options - Get Service Types › Responses

The partner's service types. Send Abbr in requests.

​object[]
A lookup value configured for the partner company.
Abbr
​string · required

Code to send in requests.

Name
​string · required

Display name.

systemState
​string | null

For status lists: the platform state the option maps to.

Dropdown Options - Get Reference Types

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/referencetypes

Returns a list of valid Options / Dropdown Options for Reference Type for a specific partner.

Dropdown Options - Get Reference Types › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Reference Types › 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.

Dropdown Options - Get Reference Types › Responses

The partner's reference types. Send Abbr in requests.

​object[]
A lookup value configured for the partner company.
Abbr
​string · required

Code to send in requests.

Name
​string · required

Display name.

systemState
​string | null

For status lists: the platform state the option maps to.

Dropdown Options - Get Note Types

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/notetypes

Returns a list of valid Options / Dropdown Options for Note Type for a specific partner.

Dropdown Options - Get Note Types › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Note Types › 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.

Dropdown Options - Get Note Types › Responses

The partner's note types. Send Abbr in requests.

​object[]
A lookup value configured for the partner company.
Abbr
​string · required

Code to send in requests.

Name
​string · required

Display name.

systemState
​string | null

For status lists: the platform state the option maps to.

Dropdown Options - Get Trailer Statuses

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/trailerstatuses

Returns a list of valid Options / Dropdown Options for Trailer Status for a specific partner.

Dropdown Options - Get Trailer Statuses › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Trailer Statuses › 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.

Dropdown Options - Get Trailer Statuses › Responses

The partner's trailer statuses. Send Abbr in requests.

​object[]
A lookup value configured for the partner company.
Abbr
​string · required

Code to send in requests.

Name
​string · required

Display name.

systemState
​string | null

For status lists: the platform state the option maps to.

Dropdown Options - Get Tractor Statuses

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/tractorstatuses

Returns a list of valid Options / Dropdown Options for Tractor Status for a specific partner.

Dropdown Options - Get Tractor Statuses › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Tractor Statuses › 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.

Dropdown Options - Get Tractor Statuses › Responses

The partner's tractor statuses. Send Abbr in requests.

​object[]
A lookup value configured for the partner company.
Abbr
​string · required

Code to send in requests.

Name
​string · required

Display name.

systemState
​string | null

For status lists: the platform state the option maps to.

Dropdown Options - Get Commodities

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/commodities

Returns a list of valid commodities for a specific partner.

Dropdown Options - Get Commodities › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Commodities › 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.

Dropdown Options - Get Commodities › Responses

The partner's commodities list.

​object[]

Lookup values as configured for the partner.

Dropdown Options - Get Accessorials

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/accessorials

Returns a list of valid accessorials for a specific partner.

Dropdown Options - Get Accessorials › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Accessorials › 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.

Dropdown Options - Get Accessorials › Responses

The partner's accessorials list.

​object[]

Lookup values as configured for the partner.

Dropdown Options - Get Weight Units

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/weightunits

Returns a list of valid weight units for a specific partner.

Dropdown Options - Get Weight Units › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Weight Units › 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.

Dropdown Options - Get Weight Units › Responses

The partner's weightunits list.

​object[]

Lookup values as configured for the partner.

Dropdown Options - Get Quantity Units

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/quantityunits

Returns a list of valid quantity units for a specific partner.

Dropdown Options - Get Quantity Units › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Quantity Units › 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.

Dropdown Options - Get Quantity Units › Responses

The partner's quantityunits list.

​object[]

Lookup values as configured for the partner.

Dropdown Options - Get Volume Units

GET
https://carriercloud.ai
/v1/partner/{partnercode}/options/volumeunits

Returns a list of valid volume units for a specific partner.

Dropdown Options - Get Volume Units › path Parameters

partnercode
​string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

Dropdown Options - Get Volume Units › 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.

Dropdown Options - Get Volume Units › Responses

The partner's volumeunits list.

​object[]

Lookup values as configured for the partner.

RelationshipsUtilities