CarrierCloud (v1) - Universal Transportation API

Partners (1.0.1)

Endpoint:https://qa.carriercloud.ai

Cloud Network Endpoints for Partner Access

Tractors - Get Tractors

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors

Get a list of active trucks (tractors) for a specific partner.

Tractors - Get Tractors › path Parameters

partnercodestring · required
Partner code identifier

Tractors - Get Tractors › query Parameters

pageinteger · int32
Page number to return results

Tractors - Get Tractors › Headers

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

Tractors - Get Tractors › Responses

A list of active Tractor Actor Objects

idinteger · int32
tractorNumberstring
dataGUIDstring
tractorTypestring
tractorType1string
tractorType2string
tractorType3string
tractorType4string
lastContactCitystring
lastContactStatestring
lastContactZipCodestring
lastContactLatitudestring
lastContactLongitudestring
lastContactDatestring
lastContactTimestring
tractorLastContactProximitystring
lastContactDateTimestring · date-time
etaCitystring
etaStatestring
etaZipCodestring
etaLatitudestring
etaLongitudestring
etaDatestring
etaTimestring
etaDateTimestring · date-time
licensePlatestring
serialNumberstring
vehicleGroupIdstring
lastContactProximityDescriptionstring
terminatedDatestring · date-time
terminalIdstring
tractorMakestring
tractorModelstring
tractorYearinteger · int32
tractorStatusstring
mobileCommIDstring
odometernumber · double
totalHoursnumber · double
alternateIdstring
currentDriverIdstring
lastMessageTimestampstring · date-time
dieselHoursnumber · double
electricHoursnumber · double
licenseStatestring
terminalNamestring
expirationDatestring
attributesobject[]
maintenanceobject[]
Maintenance records for the trailer

Tractors - Create Tractor

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors

Create a tractor

Tractors - Create Tractor › path Parameters

partnercodestring · required
Partner code identifier

Tractors - Create Tractor › Headers

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

Tractors - Create Tractor › Request Body
optional

tractorNumberstring
tractorType1string
tractorType2string
tractorType3string
tractorType4string
tractorStatusstring
tractorMakestring
tractorModelstring
tractorYearinteger · int32
licensePlatestring
serialNumberstring
lastContactDateTimestring · date-time
lastContactCitystring
lastContactStatestring
tractorLastContactProximitystring
licenseStatestring
mobileCommIDstring
odometernumber · double
maintenanceobject[]
Maintenance items mapped to VIA; each object uses keys accepted by the inbound maintenance mapper (camelCase; PascalCase alts in code for id/created/name/due*).

Tractors - Create Tractor › Responses

Success

No data returned

Drivers - Get Driver

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/drivers/{driverid}

Drivers - Get Driver › path Parameters

partnercodestring · required
Partner code identifier
driveridstring · required
Driver identifier

Drivers - Get Driver › Headers

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

Drivers - Get Drivers

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/drivers

Returns a list of active drivers for a specific partner.

Drivers - Get Drivers › path Parameters

partnercodestring · required
Partner code identifier

Drivers - Get Drivers › query Parameters

pageinteger · int32
Page number to return results

Drivers - Get Drivers › Headers

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

Drivers - Get Drivers › Responses

An array of active Driver Actor Objects

Drivers - Get Hours of Service

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/drivers/hos/{date}

Retrieve Hours of Service (ELD) information for a driver.

Drivers - Get Hours of Service › path Parameters

partnercodestring · required
Partner code identifier
datestring · date · required
Date parameter

Drivers - Get Hours of Service › Headers

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

Tractors - Get GPS Positions

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{tractorguid}/positions

Get historical positions for a specific tractor (vehicle).

Tractors - Get GPS Positions › path Parameters

partnercodestring · required
Partner code identifier
tractorguidstring · required
Tractor GUID identifier

Tractors - Get GPS Positions › query Parameters

pageinteger · int32
Page number to return results
startdatestring · date-time
Starting date/time

Tractors - Get GPS Positions › Headers

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

Tractors - Get Performance Events

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{tractorguid}/Event

Get historical performance events for a specific tractor (vehicle).

Tractors - Get Performance Events › path Parameters

partnercodestring · required
Partner code identifier
tractorguidstring · required
Tractor GUID identifier

Tractors - Get Performance Events › query Parameters

pageinteger · int32
Page number to return results
startdatestring · date-time
Starting date/time

Tractors - Get Performance Events › Headers

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

Trailers - Get by Id

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers/{id}

Get a trailer by id

Trailers - Get by Id › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The trailer card id

Trailers - Get by Id › Headers

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

Trailers - Get by Id › Responses

Success

idinteger · int32
trailerIdstring
dataGUIDstring
trailerNumberstring
trailerModelstring
trailerMakestring
trailerOwnerstring
trailerType1string
trailerType2string
trailerType3string
trailerType4string
trailerYearinteger · int32
trailerCompanyIdstring
trailerStatusstring
trailerLastContactLatstring
trailerLastContactLngstring
trailerLastContactProximitystring
lastContactedDateTimestring · date-time
trailerLastContactCitystring
trailerLastContactStatestring
trailerLastContactCountrystring
trailerLastContactDirectionstring
zone1SetPointnumber · double
zone1ReturnAirnumber · double
zone2SetPointnumber · double
zone2ReturnAirnumber · double
zone3SetPointnumber · double
zone3ReturnAirnumber · double
batteryVoltagenumber · double
fuelLevelnumber · double
operatingModestring
movingboolean
refrigerationRunningboolean
lastUpdatedstring · date-time
licensePlatestring
terminatedDatestring · date-time
mobileCommIDstring
odometernumber · double
totalHoursnumber · double
dieselHoursnumber · double
electricHoursnumber · double
licenseStatestring
terminalIdstring
terminalNamestring
zone1Dischargenumber · double
zone2Dischargenumber · double
zone3Dischargenumber · double
sensor1number · double
sensor2number · double
sensor3number · double
sensor4number · double
sensor5number · double
sensor6number · double
expirationDatestring
attributesobject[]
mobileComStatusstring
unitModestring
zone1AuxiliaryTempnumber · double
zone2AuxiliaryTempnumber · double
zone3AuxiliaryTempnumber · double
zone1SupplyAirnumber · double
zone2SupplyAirnumber · double
zone3SupplyAirnumber · double
zone1OperatingModestring
zone2OperatingModestring
zone3OperatingModestring
ambientTempnumber · double
receivedDateTimestring · date-time
divisionstring
fleetstring
additionalValuesstring[]
maintenanceobject[]
Maintenance records for the trailer

Trailers - Update Trailer

PUT

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers/{id}

Update a trailer by id

Trailers - Update Trailer › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The trailer card id

Trailers - Update Trailer › Headers

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

Trailers - Update Trailer › Request Body
optional

trailerIdstring
trailerNumberstring
trailerModelstring
trailerMakestring
trailerOwnerstring
trailerType1string
trailerType2string
trailerType3string
trailerType4string
trailerYearinteger · int32
trailerCompanyIdstring
trailerStatusstring
trailerLastContactLatstring
trailerLastContactLngstring
trailerLastContactProximitystring
lastContactedDateTimestring · date-time
trailerLastContactCitystring
trailerLastContactStatestring
licensePlatestring
licenseStatestring
terminalIdstring
maintenanceobject[]
Maintenance records for the trailer

Trailers - Update Trailer › Responses

Success

No data returned

Trailers - Delete Trailer

DELETE

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers/{id}

Delete a trailer by id

Trailers - Delete Trailer › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The trailer card id

Trailers - Delete Trailer › Headers

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

Trailers - Delete Trailer › Responses

Success

No data returned

Trailers - Get by Trailer Number

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers/byNumber/{trailerNumber}

Get trailer by trailer number

Trailers - Get by Trailer Number › path Parameters

partnercodestring · required
Partner code identifier
trailerNumberstring · required
Trailer number to look up.

Trailers - Get by Trailer Number › Headers

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

Trailers - Get by Trailer Number › Responses

Success

idinteger · int32
trailerIdstring
dataGUIDstring
trailerNumberstring
trailerModelstring
trailerMakestring
trailerOwnerstring
trailerType1string
trailerType2string
trailerType3string
trailerType4string
trailerYearinteger · int32
trailerCompanyIdstring
trailerStatusstring
trailerLastContactLatstring
trailerLastContactLngstring
trailerLastContactProximitystring
lastContactedDateTimestring · date-time
trailerLastContactCitystring
trailerLastContactStatestring
trailerLastContactCountrystring
trailerLastContactDirectionstring
zone1SetPointnumber · double
zone1ReturnAirnumber · double
zone2SetPointnumber · double
zone2ReturnAirnumber · double
zone3SetPointnumber · double
zone3ReturnAirnumber · double
batteryVoltagenumber · double
fuelLevelnumber · double
operatingModestring
movingboolean
refrigerationRunningboolean
lastUpdatedstring · date-time
licensePlatestring
terminatedDatestring · date-time
mobileCommIDstring
odometernumber · double
totalHoursnumber · double
dieselHoursnumber · double
electricHoursnumber · double
licenseStatestring
terminalIdstring
terminalNamestring
zone1Dischargenumber · double
zone2Dischargenumber · double
zone3Dischargenumber · double
sensor1number · double
sensor2number · double
sensor3number · double
sensor4number · double
sensor5number · double
sensor6number · double
expirationDatestring
attributesobject[]
mobileComStatusstring
unitModestring
zone1AuxiliaryTempnumber · double
zone2AuxiliaryTempnumber · double
zone3AuxiliaryTempnumber · double
zone1SupplyAirnumber · double
zone2SupplyAirnumber · double
zone3SupplyAirnumber · double
zone1OperatingModestring
zone2OperatingModestring
zone3OperatingModestring
ambientTempnumber · double
receivedDateTimestring · date-time
divisionstring
fleetstring
additionalValuesstring[]
maintenanceobject[]
Maintenance records for the trailer

Trailers - Create Trailer

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers

Create a trailer

Trailers - Create Trailer › path Parameters

partnercodestring · required
Partner code identifier

Trailers - Create Trailer › Headers

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

Trailers - Create Trailer › Request Body
optional

trailerIdstring
trailerNumberstring
trailerModelstring
trailerMakestring
trailerOwnerstring
trailerType1string
trailerType2string
trailerType3string
trailerType4string
trailerYearinteger · int32
trailerCompanyIdstring
trailerStatusstring
trailerLastContactLatstring
trailerLastContactLngstring
trailerLastContactProximitystring
lastContactedDateTimestring · date-time
trailerLastContactCitystring
trailerLastContactStatestring
licensePlatestring
licenseStatestring
terminalIdstring
maintenanceobject[]
Maintenance records for the trailer

Trailers - Create Trailer › Responses

Success

No data returned

Tractors - Get by Id

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{id}

Get a tractor by id

Tractors - Get by Id › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The tractor card id

Tractors - Get by Id › Headers

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

Tractors - Get by Id › Responses

Success

No data returned

Tractors - Update Tractor

PUT

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{id}

Update a tractor by id

Tractors - Update Tractor › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The tractor card id

Tractors - Update Tractor › Headers

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

Tractors - Update Tractor › Request Body
optional

tractorNumberstring
tractorType1string
tractorType2string
tractorType3string
tractorType4string
tractorStatusstring
tractorMakestring
tractorModelstring
tractorYearinteger · int32
licensePlatestring
serialNumberstring
lastContactDateTimestring · date-time
lastContactCitystring
lastContactStatestring
tractorLastContactProximitystring
licenseStatestring
mobileCommIDstring
odometernumber · double
maintenanceobject[]
Maintenance items mapped to VIA; each object uses keys accepted by the inbound maintenance mapper (camelCase; PascalCase alts in code for id/created/name/due*).

Tractors - Update Tractor › Responses

Success

No data returned

Tractors - Delete Tractor

DELETE

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{id}

Delete a tractor by id

Tractors - Delete Tractor › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The tractor card id

Tractors - Delete Tractor › Headers

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

Tractors - Delete Tractor › Responses

Success

No data returned

Tractors - Get by Tractor Number

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/byNumber/{tractorNumber}

Get tractor by tractor number

Tractors - Get by Tractor Number › path Parameters

partnercodestring · required
Partner code identifier
tractorNumberstring · required
Tractor number to look up.

Tractors - Get by Tractor Number › Headers

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

Tractors - Get by Tractor Number › Responses

Success

No data returned

Carriers - Get Carriers

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/carriers

Get a list of active carriers for a specific partner.

Carriers - Get Carriers › path Parameters

partnercodestring · required
Partner code identifier

Carriers - Get Carriers › query Parameters

pageinteger · int32
Page number to return results

Carriers - Get Carriers › Headers

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

Carriers - Get Carrier

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/carriers/{carrierid}

Get a specific carrier's details for a given partner.

Carriers - Get Carrier › path Parameters

partnercodestring · required
Partner code identifier
carrieridstring · required
Carrier identifier

Carriers - Get Carrier › Headers

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

Customers Dropdown Options

CarrierCloud (v1) - Universal Transportation API

Partners (1.0.1)

Endpoint:https://qa.carriercloud.ai

Cloud Network Endpoints for Partner Access

Tractors - Get Tractors

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors

Get a list of active trucks (tractors) for a specific partner.

Tractors - Get Tractors › path Parameters

partnercodestring · required
Partner code identifier

Tractors - Get Tractors › query Parameters

pageinteger · int32
Page number to return results

Tractors - Get Tractors › Headers

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

Tractors - Get Tractors › Responses

A list of active Tractor Actor Objects

idinteger · int32
tractorNumberstring
dataGUIDstring
tractorTypestring
tractorType1string
tractorType2string
tractorType3string
tractorType4string
lastContactCitystring
lastContactStatestring
lastContactZipCodestring
lastContactLatitudestring
lastContactLongitudestring
lastContactDatestring
lastContactTimestring
tractorLastContactProximitystring
lastContactDateTimestring · date-time
etaCitystring
etaStatestring
etaZipCodestring
etaLatitudestring
etaLongitudestring
etaDatestring
etaTimestring
etaDateTimestring · date-time
licensePlatestring
serialNumberstring
vehicleGroupIdstring
lastContactProximityDescriptionstring
terminatedDatestring · date-time
terminalIdstring
tractorMakestring
tractorModelstring
tractorYearinteger · int32
tractorStatusstring
mobileCommIDstring
odometernumber · double
totalHoursnumber · double
alternateIdstring
currentDriverIdstring
lastMessageTimestampstring · date-time
dieselHoursnumber · double
electricHoursnumber · double
licenseStatestring
terminalNamestring
expirationDatestring
attributesobject[]
maintenanceobject[]
Maintenance records for the trailer

Tractors - Create Tractor

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors

Create a tractor

Tractors - Create Tractor › path Parameters

partnercodestring · required
Partner code identifier

Tractors - Create Tractor › Headers

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

Tractors - Create Tractor › Request Body
optional

tractorNumberstring
tractorType1string
tractorType2string
tractorType3string
tractorType4string
tractorStatusstring
tractorMakestring
tractorModelstring
tractorYearinteger · int32
licensePlatestring
serialNumberstring
lastContactDateTimestring · date-time
lastContactCitystring
lastContactStatestring
tractorLastContactProximitystring
licenseStatestring
mobileCommIDstring
odometernumber · double
maintenanceobject[]
Maintenance items mapped to VIA; each object uses keys accepted by the inbound maintenance mapper (camelCase; PascalCase alts in code for id/created/name/due*).

Tractors - Create Tractor › Responses

Success

No data returned

Drivers - Get Driver

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/drivers/{driverid}

Drivers - Get Driver › path Parameters

partnercodestring · required
Partner code identifier
driveridstring · required
Driver identifier

Drivers - Get Driver › Headers

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

Drivers - Get Drivers

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/drivers

Returns a list of active drivers for a specific partner.

Drivers - Get Drivers › path Parameters

partnercodestring · required
Partner code identifier

Drivers - Get Drivers › query Parameters

pageinteger · int32
Page number to return results

Drivers - Get Drivers › Headers

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

Drivers - Get Drivers › Responses

An array of active Driver Actor Objects

Drivers - Get Hours of Service

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/drivers/hos/{date}

Retrieve Hours of Service (ELD) information for a driver.

Drivers - Get Hours of Service › path Parameters

partnercodestring · required
Partner code identifier
datestring · date · required
Date parameter

Drivers - Get Hours of Service › Headers

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

Tractors - Get GPS Positions

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{tractorguid}/positions

Get historical positions for a specific tractor (vehicle).

Tractors - Get GPS Positions › path Parameters

partnercodestring · required
Partner code identifier
tractorguidstring · required
Tractor GUID identifier

Tractors - Get GPS Positions › query Parameters

pageinteger · int32
Page number to return results
startdatestring · date-time
Starting date/time

Tractors - Get GPS Positions › Headers

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

Tractors - Get Performance Events

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{tractorguid}/Event

Get historical performance events for a specific tractor (vehicle).

Tractors - Get Performance Events › path Parameters

partnercodestring · required
Partner code identifier
tractorguidstring · required
Tractor GUID identifier

Tractors - Get Performance Events › query Parameters

pageinteger · int32
Page number to return results
startdatestring · date-time
Starting date/time

Tractors - Get Performance Events › Headers

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

Trailers - Get by Id

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers/{id}

Get a trailer by id

Trailers - Get by Id › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The trailer card id

Trailers - Get by Id › Headers

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

Trailers - Get by Id › Responses

Success

idinteger · int32
trailerIdstring
dataGUIDstring
trailerNumberstring
trailerModelstring
trailerMakestring
trailerOwnerstring
trailerType1string
trailerType2string
trailerType3string
trailerType4string
trailerYearinteger · int32
trailerCompanyIdstring
trailerStatusstring
trailerLastContactLatstring
trailerLastContactLngstring
trailerLastContactProximitystring
lastContactedDateTimestring · date-time
trailerLastContactCitystring
trailerLastContactStatestring
trailerLastContactCountrystring
trailerLastContactDirectionstring
zone1SetPointnumber · double
zone1ReturnAirnumber · double
zone2SetPointnumber · double
zone2ReturnAirnumber · double
zone3SetPointnumber · double
zone3ReturnAirnumber · double
batteryVoltagenumber · double
fuelLevelnumber · double
operatingModestring
movingboolean
refrigerationRunningboolean
lastUpdatedstring · date-time
licensePlatestring
terminatedDatestring · date-time
mobileCommIDstring
odometernumber · double
totalHoursnumber · double
dieselHoursnumber · double
electricHoursnumber · double
licenseStatestring
terminalIdstring
terminalNamestring
zone1Dischargenumber · double
zone2Dischargenumber · double
zone3Dischargenumber · double
sensor1number · double
sensor2number · double
sensor3number · double
sensor4number · double
sensor5number · double
sensor6number · double
expirationDatestring
attributesobject[]
mobileComStatusstring
unitModestring
zone1AuxiliaryTempnumber · double
zone2AuxiliaryTempnumber · double
zone3AuxiliaryTempnumber · double
zone1SupplyAirnumber · double
zone2SupplyAirnumber · double
zone3SupplyAirnumber · double
zone1OperatingModestring
zone2OperatingModestring
zone3OperatingModestring
ambientTempnumber · double
receivedDateTimestring · date-time
divisionstring
fleetstring
additionalValuesstring[]
maintenanceobject[]
Maintenance records for the trailer

Trailers - Update Trailer

PUT

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers/{id}

Update a trailer by id

Trailers - Update Trailer › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The trailer card id

Trailers - Update Trailer › Headers

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

Trailers - Update Trailer › Request Body
optional

trailerIdstring
trailerNumberstring
trailerModelstring
trailerMakestring
trailerOwnerstring
trailerType1string
trailerType2string
trailerType3string
trailerType4string
trailerYearinteger · int32
trailerCompanyIdstring
trailerStatusstring
trailerLastContactLatstring
trailerLastContactLngstring
trailerLastContactProximitystring
lastContactedDateTimestring · date-time
trailerLastContactCitystring
trailerLastContactStatestring
licensePlatestring
licenseStatestring
terminalIdstring
maintenanceobject[]
Maintenance records for the trailer

Trailers - Update Trailer › Responses

Success

No data returned

Trailers - Delete Trailer

DELETE

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers/{id}

Delete a trailer by id

Trailers - Delete Trailer › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The trailer card id

Trailers - Delete Trailer › Headers

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

Trailers - Delete Trailer › Responses

Success

No data returned

Trailers - Get by Trailer Number

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers/byNumber/{trailerNumber}

Get trailer by trailer number

Trailers - Get by Trailer Number › path Parameters

partnercodestring · required
Partner code identifier
trailerNumberstring · required
Trailer number to look up.

Trailers - Get by Trailer Number › Headers

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

Trailers - Get by Trailer Number › Responses

Success

idinteger · int32
trailerIdstring
dataGUIDstring
trailerNumberstring
trailerModelstring
trailerMakestring
trailerOwnerstring
trailerType1string
trailerType2string
trailerType3string
trailerType4string
trailerYearinteger · int32
trailerCompanyIdstring
trailerStatusstring
trailerLastContactLatstring
trailerLastContactLngstring
trailerLastContactProximitystring
lastContactedDateTimestring · date-time
trailerLastContactCitystring
trailerLastContactStatestring
trailerLastContactCountrystring
trailerLastContactDirectionstring
zone1SetPointnumber · double
zone1ReturnAirnumber · double
zone2SetPointnumber · double
zone2ReturnAirnumber · double
zone3SetPointnumber · double
zone3ReturnAirnumber · double
batteryVoltagenumber · double
fuelLevelnumber · double
operatingModestring
movingboolean
refrigerationRunningboolean
lastUpdatedstring · date-time
licensePlatestring
terminatedDatestring · date-time
mobileCommIDstring
odometernumber · double
totalHoursnumber · double
dieselHoursnumber · double
electricHoursnumber · double
licenseStatestring
terminalIdstring
terminalNamestring
zone1Dischargenumber · double
zone2Dischargenumber · double
zone3Dischargenumber · double
sensor1number · double
sensor2number · double
sensor3number · double
sensor4number · double
sensor5number · double
sensor6number · double
expirationDatestring
attributesobject[]
mobileComStatusstring
unitModestring
zone1AuxiliaryTempnumber · double
zone2AuxiliaryTempnumber · double
zone3AuxiliaryTempnumber · double
zone1SupplyAirnumber · double
zone2SupplyAirnumber · double
zone3SupplyAirnumber · double
zone1OperatingModestring
zone2OperatingModestring
zone3OperatingModestring
ambientTempnumber · double
receivedDateTimestring · date-time
divisionstring
fleetstring
additionalValuesstring[]
maintenanceobject[]
Maintenance records for the trailer

Trailers - Create Trailer

POST

https://qa.carriercloud.ai

/v1/partner/{partnercode}/trailers

Create a trailer

Trailers - Create Trailer › path Parameters

partnercodestring · required
Partner code identifier

Trailers - Create Trailer › Headers

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

Trailers - Create Trailer › Request Body
optional

trailerIdstring
trailerNumberstring
trailerModelstring
trailerMakestring
trailerOwnerstring
trailerType1string
trailerType2string
trailerType3string
trailerType4string
trailerYearinteger · int32
trailerCompanyIdstring
trailerStatusstring
trailerLastContactLatstring
trailerLastContactLngstring
trailerLastContactProximitystring
lastContactedDateTimestring · date-time
trailerLastContactCitystring
trailerLastContactStatestring
licensePlatestring
licenseStatestring
terminalIdstring
maintenanceobject[]
Maintenance records for the trailer

Trailers - Create Trailer › Responses

Success

No data returned

Tractors - Get by Id

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{id}

Get a tractor by id

Tractors - Get by Id › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The tractor card id

Tractors - Get by Id › Headers

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

Tractors - Get by Id › Responses

Success

No data returned

Tractors - Update Tractor

PUT

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{id}

Update a tractor by id

Tractors - Update Tractor › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The tractor card id

Tractors - Update Tractor › Headers

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

Tractors - Update Tractor › Request Body
optional

tractorNumberstring
tractorType1string
tractorType2string
tractorType3string
tractorType4string
tractorStatusstring
tractorMakestring
tractorModelstring
tractorYearinteger · int32
licensePlatestring
serialNumberstring
lastContactDateTimestring · date-time
lastContactCitystring
lastContactStatestring
tractorLastContactProximitystring
licenseStatestring
mobileCommIDstring
odometernumber · double
maintenanceobject[]
Maintenance items mapped to VIA; each object uses keys accepted by the inbound maintenance mapper (camelCase; PascalCase alts in code for id/created/name/due*).

Tractors - Update Tractor › Responses

Success

No data returned

Tractors - Delete Tractor

DELETE

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/{id}

Delete a tractor by id

Tractors - Delete Tractor › path Parameters

partnercodestring · required
Partner code identifier
idstring · required
The tractor card id

Tractors - Delete Tractor › Headers

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

Tractors - Delete Tractor › Responses

Success

No data returned

Tractors - Get by Tractor Number

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/tractors/byNumber/{tractorNumber}

Get tractor by tractor number

Tractors - Get by Tractor Number › path Parameters

partnercodestring · required
Partner code identifier
tractorNumberstring · required
Tractor number to look up.

Tractors - Get by Tractor Number › Headers

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

Tractors - Get by Tractor Number › Responses

Success

No data returned

Carriers - Get Carriers

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/carriers

Get a list of active carriers for a specific partner.

Carriers - Get Carriers › path Parameters

partnercodestring · required
Partner code identifier

Carriers - Get Carriers › query Parameters

pageinteger · int32
Page number to return results

Carriers - Get Carriers › Headers

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

Carriers - Get Carrier

GET

https://qa.carriercloud.ai

/v1/partner/{partnercode}/carriers/{carrierid}

Get a specific carrier's details for a given partner.

Carriers - Get Carrier › path Parameters

partnercodestring · required
Partner code identifier
carrieridstring · required
Carrier identifier

Carriers - Get Carrier › Headers

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

Customers Dropdown Options

Partners (1.0.1)

Tractors - Get Tractors

Tractors - Get Tractors › path Parameters

Tractors - Get Tractors › query Parameters

Tractors - Get Tractors › Headers

Tractors - Get Tractors › Responses

Tractors - Create Tractor

Tractors - Create Tractor › path Parameters

Tractors - Create Tractor › Headers

Tractors - Create Tractor › Request Body optional

Tractors - Create Tractor › Responses

Drivers - Get Driver

Drivers - Get Driver › path Parameters

Drivers - Get Driver › Headers

Drivers - Get Drivers

Drivers - Get Drivers › path Parameters

Drivers - Get Drivers › query Parameters

Drivers - Get Drivers › Headers

Drivers - Get Drivers › Responses

Drivers - Get Hours of Service

Drivers - Get Hours of Service › path Parameters

Drivers - Get Hours of Service › Headers

Tractors - Get GPS Positions

Tractors - Get GPS Positions › path Parameters

Tractors - Get GPS Positions › query Parameters

Tractors - Get GPS Positions › Headers

Tractors - Get Performance Events

Tractors - Get Performance Events › path Parameters

Tractors - Get Performance Events › query Parameters

Tractors - Get Performance Events › Headers

Trailers - Get by Id

Trailers - Get by Id › path Parameters

Trailers - Get by Id › Headers

Trailers - Get by Id › Responses

Trailers - Update Trailer

Trailers - Update Trailer › path Parameters

Trailers - Update Trailer › Headers

Trailers - Update Trailer › Request Body optional

Trailers - Update Trailer › Responses

Trailers - Delete Trailer

Trailers - Delete Trailer › path Parameters

Trailers - Delete Trailer › Headers

Trailers - Delete Trailer › Responses

Trailers - Get by Trailer Number

Trailers - Get by Trailer Number › path Parameters

Trailers - Get by Trailer Number › Headers

Trailers - Get by Trailer Number › Responses

Trailers - Create Trailer

Trailers - Create Trailer › path Parameters

Trailers - Create Trailer › Headers

Trailers - Create Trailer › Request Body optional

Trailers - Create Trailer › Responses

Tractors - Get by Id

Tractors - Get by Id › path Parameters

Tractors - Get by Id › Headers

Tractors - Get by Id › Responses

Tractors - Update Tractor

Tractors - Update Tractor › path Parameters

Tractors - Update Tractor › Headers

Tractors - Update Tractor › Request Body optional

Tractors - Update Tractor › Responses

Tractors - Delete Tractor

Tractors - Delete Tractor › path Parameters

Tractors - Delete Tractor › Headers

Tractors - Delete Tractor › Responses

Tractors - Get by Tractor Number

Tractors - Get by Tractor Number › path Parameters

Tractors - Get by Tractor Number › Headers

Tractors - Get by Tractor Number › Responses

Carriers - Get Carriers

Carriers - Get Carriers › path Parameters

Carriers - Get Carriers › query Parameters

Carriers - Get Carriers › Headers

Carriers - Get Carrier

Carriers - Get Carrier › path Parameters

Carriers - Get Carrier › Headers

Partners (1.0.1)

Tractors - Get Tractors

Tractors - Get Tractors › path Parameters

Tractors - Get Tractors › query Parameters

Tractors - Create Tractor › Request Body
optional

Trailers - Update Trailer › Request Body
optional

Trailers - Create Trailer › Request Body
optional

Tractors - Update Tractor › Request Body
optional

Tractors - Create Tractor › Request Body
optional

Trailers - Update Trailer › Request Body
optional

Trailers - Create Trailer › Request Body
optional

Tractors - Update Tractor › Request Body
optional