CarrierCloud (v1) - Universal Transportation API

Schemas(1.0.1)

TractorActor

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

TractorRequestBody

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*).

TrailerActor

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

TrailerRequestBody

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

AttributesActor

_idstring
typestring
expirationstring · date-time
expiresboolean
createdstring · date-time

updateGps

CreateOrderRequest

OrderNumberstring · maxLength: 100
Unique order number for tracking
Stopsobject[] · minItems: 2
Array of stops (pickup and delivery locations)
FreightDetailsobject[]
Details about the freight being transported
RefNumbersobject[]
Reference numbers (BOL, PRO, etc.)
billToCompanyIdstring
Company ID for billing
specialInstructionsstring · maxLength: 5000
Special handling instructions

OrderStop

StopTypestring · enum · required
Type of stop
Enum values:
Pickup
Delivery
None
Sequenceinteger · int32 · min: 1 · required
Stop sequence number
Citystring · maxLength: 100 · required
City name
Statestring · maxLength: 50 · required
State or province code

ScheduledEarliestDatestring · date-time
Earliest date/time for this stop
ScheduledLatestDatestring · date-time
Latest date/time for this stop
CompanyIdstring
Company identifier at this stop
Companystring · maxLength: 200
Company name at this stop
Address1string · maxLength: 200
Street address line 1
Address2string · maxLength: 200
Street address line 2
ZipCodestring · maxLength: 20
Postal/ZIP code
Countrystring · maxLength: 2
Country code (ISO 3166-1 alpha-2)
Default: US
Latitudenumber · double
Latitude coordinate
Longitudenumber · double
Longitude coordinate
contactNamestring · maxLength: 200
Contact person name
contactPhonestring · maxLength: 50
Contact phone number
specialInstructionsstring · maxLength: 2000
Special instructions for this stop

FreightDetail

Weightnumber · double · min: 0
Weight of freight
WeightUnitstring · enum
Unit of weight measurement
Enum values:
lbs
kg
tons
Default: lbs
Volumenumber · double · min: 0
Volume of freight
VolumeUnitstring · enum
Unit of volume measurement
Enum values:
gal
L
Lengthnumber · double · min: 0
Length dimension
Widthnumber · double · min: 0
Width dimension
Heightnumber · double · min: 0
Height dimension
DimensionUnitstring · enum
Unit for length, width, height
Enum values:
in
ft
Default: in
ItemCountinteger · int32 · min: 0
Number of pieces/items
ItemCountUnitstring · min: 0 · maxLength: 10
Unit for ItemCount
CommodityCodestring · maxLength: 50
Commodity classification code
Descriptionstring · maxLength: 500
Description of freight
isHazardousboolean
Indicates if freight is hazardous
Default: false
HazardClassstring · maxLength: 50
Hazardous material class
TemperatureControlledboolean
Indicates if temperature control is required
Default: false
MinimumTemperaturenumber · double
Minimum temperature requirement
MaximumTemperaturenumber · double
Maximum temperature requirement

ReferenceNumber

RefTypestring · enum · required
Type of reference number
Enum values:
BL#
PRO
PO
SO
BOL
REF
RefNumberstring · maxLength: 100 · required
Reference number value

OrderResponse

orderIdstring
Unique identifier for the created order
orderGuidstring
GUID identifier for the order
orderNumberstring
Order number
statusstring
Current status of the order
createdAtstring · date-time
Timestamp when order was created

equipmentCapacity

Weightnumber
Volumenumber
Lengthnumber
Widthnumber
Heightnumber
HandlingItemsnumber
DimensionsUnitstring
Dimension unit abbreviation; must match company dimensionunits options
WeightUnitstring
Must match company weightunits options
VolumeUnitstring
Must match company volumeunits options

MaintenanceActor

idstring
namestring
dueInnumber
dueInUnitstring · enum
Interval unit for dueIn
Enum values:
days
miles
kilometers
dueDatestring · date-time
createdstring · date-time

TractorActor

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

TractorRequestBody

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*).

TrailerActor

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

TrailerRequestBody

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

CreateOrderRequest

OrderNumberstring · maxLength: 100
Unique order number for tracking
Stopsobject[] · minItems: 2
Array of stops (pickup and delivery locations)
FreightDetailsobject[]
Details about the freight being transported
RefNumbersobject[]
Reference numbers (BOL, PRO, etc.)
billToCompanyIdstring
Company ID for billing
specialInstructionsstring · maxLength: 5000
Special handling instructions

OrderStop

StopTypestring · enum · required
Type of stop
Enum values:
Pickup
Delivery
None
Sequenceinteger · int32 · min: 1 · required
Stop sequence number
Citystring · maxLength: 100 · required
City name
Statestring · maxLength: 50 · required
State or province code

ScheduledEarliestDatestring · date-time
Earliest date/time for this stop
ScheduledLatestDatestring · date-time
Latest date/time for this stop
CompanyIdstring
Company identifier at this stop
Companystring · maxLength: 200
Company name at this stop
Address1string · maxLength: 200
Street address line 1
Address2string · maxLength: 200
Street address line 2
ZipCodestring · maxLength: 20
Postal/ZIP code
Countrystring · maxLength: 2
Country code (ISO 3166-1 alpha-2)
Default: US
Latitudenumber · double
Latitude coordinate
Longitudenumber · double
Longitude coordinate
contactNamestring · maxLength: 200
Contact person name
contactPhonestring · maxLength: 50
Contact phone number
specialInstructionsstring · maxLength: 2000
Special instructions for this stop

FreightDetail

Weightnumber · double · min: 0
Weight of freight
WeightUnitstring · enum
Unit of weight measurement
Enum values:
lbs
kg
tons
Default: lbs
Volumenumber · double · min: 0
Volume of freight
VolumeUnitstring · enum
Unit of volume measurement
Enum values:
gal
L
Lengthnumber · double · min: 0
Length dimension
Widthnumber · double · min: 0
Width dimension
Heightnumber · double · min: 0
Height dimension
DimensionUnitstring · enum
Unit for length, width, height
Enum values:
in
ft
Default: in
ItemCountinteger · int32 · min: 0
Number of pieces/items
ItemCountUnitstring · min: 0 · maxLength: 10
Unit for ItemCount
CommodityCodestring · maxLength: 50
Commodity classification code
Descriptionstring · maxLength: 500
Description of freight
isHazardousboolean
Indicates if freight is hazardous
Default: false
HazardClassstring · maxLength: 50
Hazardous material class
TemperatureControlledboolean
Indicates if temperature control is required
Default: false
MinimumTemperaturenumber · double
Minimum temperature requirement
MaximumTemperaturenumber · double
Maximum temperature requirement