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

Schemas

Download schema

TractorActor

id
​integer · int32
tractorNumber
​string
dataGUID
​string
tractorType
​string
tractorType1
​string
tractorType2
​string
tractorType3
​string
tractorType4
​string
lastContactCity
​string
lastContactState
​string
lastContactZipCode
​string
lastContactLatitude
​string
lastContactLongitude
​string
lastContactDate
​string
lastContactTime
​string
tractorLastContactProximity
​string
lastContactDateTime
​string · date-time
etaCity
​string
etaState
​string
etaZipCode
​string
etaLatitude
​string
etaLongitude
​string
etaDate
​string
etaTime
​string
etaDateTime
​string · date-time
licensePlate
​string
serialNumber
​string
vehicleGroupId
​string
lastContactProximityDescription
​string
terminatedDate
​string · date-time
terminalId
​string
tractorMake
​string
tractorModel
​string
tractorYear
​integer · int32
tractorStatus
​string
mobileCommID
​string
odometer
​number · double
totalHours
​number · double
alternateId
​string
currentDriverId
​string
lastMessageTimestamp
​string · date-time
dieselHours
​number · double
electricHours
​number · double
licenseState
​string
terminalName
​string
expirationDate
​string
​AttributesActor[]
​MaintenanceActor[]

Maintenance records for the tractor

​NoteActor[]

Notes associated with the tractor

TractorRequestBody

Tractor create/update request: only fields read by the inbound truck-card payload mapper (see format-inbound-tractoractor-via / tractor-actor-to-truck-card-payload).
tractorNumber
​string
tractorType1
​string
tractorType2
​string
tractorType3
​string
tractorType4
​string
tractorStatus
​string
tractorMake
​string
tractorModel
​string
tractorYear
​integer · int32
licensePlate
​string
serialNumber
​string
lastContactDateTime
​string · date-time
lastContactCity
​string
lastContactState
​string
tractorLastContactProximity
​string
licenseState
​string
mobileCommID
​string
odometer
​number · double
​MaintenanceActor[]

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

Notes for the tractor

TrailerActor

id
​integer · int32
trailerId
​string
dataGUID
​string
trailerNumber
​string
trailerModel
​string
trailerMake
​string
trailerOwner
​string
trailerType1
​string
trailerType2
​string
trailerType3
​string
trailerType4
​string
trailerYear
​integer · int32
trailerCompanyId
​string
trailerStatus
​string
trailerLastContactLat
​string
trailerLastContactLng
​string
trailerLastContactProximity
​string
lastContactedDateTime
​string · date-time
trailerLastContactCity
​string
trailerLastContactState
​string
trailerLastContactCountry
​string
trailerLastContactDirection
​string
zone1SetPoint
​number · double
zone1ReturnAir
​number · double
zone2SetPoint
​number · double
zone2ReturnAir
​number · double
zone3SetPoint
​number · double
zone3ReturnAir
​number · double
batteryVoltage
​number · double
fuelLevel
​number · double
operatingMode
​string
moving
​boolean
refrigerationRunning
​boolean
lastUpdated
​string · date-time
licensePlate
​string
terminatedDate
​string · date-time
mobileCommID
​string
odometer
​number · double
totalHours
​number · double
dieselHours
​number · double
electricHours
​number · double
licenseState
​string
terminalId
​string
terminalName
​string
zone1Discharge
​number · double
zone2Discharge
​number · double
zone3Discharge
​number · double
sensor1
​number · double
sensor2
​number · double
sensor3
​number · double
sensor4
​number · double
sensor5
​number · double
sensor6
​number · double
expirationDate
​string
​AttributesActor[]
mobileComStatus
​string
unitMode
​string
zone1AuxiliaryTemp
​number · double
zone2AuxiliaryTemp
​number · double
zone3AuxiliaryTemp
​number · double
zone1SupplyAir
​number · double
zone2SupplyAir
​number · double
zone3SupplyAir
​number · double
zone1OperatingMode
​string
zone2OperatingMode
​string
zone3OperatingMode
​string
ambientTemp
​number · double
receivedDateTime
​string · date-time
division
​string
fleet
​string
additionalValues
​string[]
​MaintenanceActor[]

Maintenance records for the trailer

​NoteActor[]

Notes associated with the trailer

TrailerRequestBody

Create trailer: fields accepted and mapped to the carrier API (see trailer-actor-to-trailer-card-payload).
trailerId
​string
trailerNumber
​string
trailerModel
​string
trailerMake
​string
trailerOwner
​string
trailerType1
​string
trailerType2
​string
trailerType3
​string
trailerType4
​string
trailerYear
​integer · int32
trailerCompanyId
​string
trailerStatus
​string
trailerLastContactLat
​string
trailerLastContactLng
​string
trailerLastContactProximity
​string
lastContactedDateTime
​string · date-time
trailerLastContactCity
​string
trailerLastContactState
​string
licensePlate
​string
licenseState
​string
terminalId
​string
​MaintenanceActor[]

Maintenance records for the trailer

Notes for the trailer; mapped inbound to TripNotes for the partner API

AttributesActor

_id
​string
type
​string
expiration
​string · date-time
expires
​boolean
created
​string · date-time

updateGps

lat
​string
lng
​string
eventDateTime
​string · date-time

ISO-8601 UTC timestamp. Must be in UTC and end with 'Z' (e.g. 2025-01-26T18:45:00Z)

city
​string
state
​string
zip
​string
proximity
​string
trackingStatus
​string
trackingMsg
​string
heading
​number

CreateOrderRequest

​OrderStop[] · minItems: 2 · required

Array of stops (pickup and delivery locations)

OrderNumber
​string · maxLength: 100

Unique order number for tracking

EquipmentSelection
​string · maxLength: 50

Equipment type abbreviation for the order

ServiceType
​string · maxLength: 50

Service type abbreviation for the order

Driver1
​string · maxLength: 200

Primary driver name for brokered carrier

Driver2
​string · maxLength: 200

Secondary driver name for brokered carrier

DriverPhone
​string · maxLength: 50

Driver phone number for brokered carrier

Tractor
​string · maxLength: 100

Tractor identifier for brokered carrier

Trailer
​string · maxLength: 100

Trailer identifier for brokered carrier

​FreightDetail[]

Details about the freight being transported

​ReferenceNumber[]

Reference numbers (BOL, PRO, etc.)

BillToCompanyId
​string · maxLength: 100

Company ID for billing

specialInstructions
​string · maxLength: 5000

Special handling instructions

OrderStop

StopType
​string · enum · required

Type of stop

Enum values:
Pickup
Delivery
None
Sequence
​integer · int32 · min: 1 · required

Stop sequence number

City
​string · maxLength: 100 · required

City name

State
​string · maxLength: 50 · required

State or province code

ScheduledEarliestDate
​string · date-time

Earliest date/time for this stop

ScheduledLatestDate
​string · date-time

Latest date/time for this stop

CompanyId
​string

Company identifier at this stop

Company
​string · maxLength: 200

Company name at this stop

Address1
​string · maxLength: 200

Street address line 1

Address2
​string · maxLength: 200

Street address line 2

ZipCode
​string · maxLength: 20

Postal/ZIP code

Country
​string · maxLength: 2

Country code (ISO 3166-1 alpha-2)

Default: US
Latitude
​number · double

Latitude coordinate

Longitude
​number · double

Longitude coordinate

contactName
​string · maxLength: 200

Contact person name

contactPhone
​string · maxLength: 50

Contact phone number

specialInstructions
​string · maxLength: 2000

Special instructions for this stop

FreightDetail

Weight
​number · double · min: 0

Weight of freight

WeightUnit
​string · enum

Unit of weight measurement

Enum values:
lbs
kg
tons
Default: lbs
Volume
​number · double · min: 0

Volume of freight

VolumeUnit
​string · enum

Unit of volume measurement

Enum values:
gal
L
Length
​number · double · min: 0

Length dimension

Width
​number · double · min: 0

Width dimension

Height
​number · double · min: 0

Height dimension

DimensionUnit
​string · enum

Unit for length, width, height

Enum values:
in
ft
Default: in
ItemCount
​integer · int32 · min: 0

Number of pieces/items

ItemCountUnit
​string · min: 0 · maxLength: 10

Unit for ItemCount

CommodityCode
​string · maxLength: 50

Commodity classification code

Description
​string · maxLength: 500

Description of freight

isHazardous
​boolean

Indicates if freight is hazardous

Default: false
HazardClass
​string · maxLength: 50

Hazardous material class

ReferenceNumber

RefType
​string · enum · required

Type of reference number

Enum values:
BL#
PRO
PO
SO
BOL
REF
RefNumber
​string · maxLength: 100 · required

Reference number value

OrderResponse

status
​string

Result status

messsage
​string

Human-readable result message

objectId
​string

Unique identifier for the created order card

orderId
​string

Unique identifier for the created order (same value as objectId)

orderGuid
​string

GUID identifier for the order

orderNumber
​string

Order number

createdAt
​string · date-time

Timestamp when order was created

warnings
​string[]

Permission or field warnings when the order was created with partial field updates

UpdateOrderResponse

status
​string

Result status

warnings
​string[]

Permission warnings when some requested fields were not updated

UpdateOrderStop

_id
​string · required

Stop document identifier from the existing order

StopType
​string · enum · required
Enum values:
Pickup
Delivery
ScheduledEarliestDate
​string · date-time
ScheduledLatestDate
​string · date-time
Company
​string · maxLength: 200
Address1
​string · maxLength: 200
Address2
​string · maxLength: 200
City
​string · maxLength: 100
State
​string · maxLength: 50
ZipCode
​string · maxLength: 20
Contact
​string · maxLength: 200
PrimaryPhone
​string · maxLength: 50
Email
​string · maxLength: 200

UpdateOrderRefNumber

DataGUID
​string · required

Reference number DataGUID from the existing order

RefType
​string · enum · required
Enum values:
BL#
PRO
PO
SO
BOL
REF
RefNumber
​string · maxLength: 100 · required

UpdateOrderFreightDetail

DataGUID
​string · required

Freight detail DataGUID from the existing order

Weight
​number · min: 0
WeightUnit
​string
Volume
​number · min: 0
VolumeUnit
​string
ItemCount
​integer · min: 0
ItemCountUnit
​string
Description
​string · maxLength: 500
CommodityCode
​string · maxLength: 50

UpdateOrderRequest

EquipmentSelection
​string · maxLength: 50
ServiceType
​string · maxLength: 50
Driver1
​string · maxLength: 200
Driver2
​string · maxLength: 200
DriverPhone
​string · maxLength: 50
Tractor
​string · maxLength: 100
Trailer
​string · maxLength: 100

UpdateSegmentRequest

EquipmentSelection
​string · maxLength: 50
ServiceType
​string · maxLength: 50
TripStatus
​string · maxLength: 50
Driver1
​string · maxLength: 200
Driver2
​string · maxLength: 200
DriverPhone
​string · maxLength: 50
Tractor
​string · maxLength: 100
Trailer
​string · maxLength: 100

UpdateSegmentResponse

status
​string

Result status

warnings
​string[]

Permission warnings when some requested fields were not updated

equipmentCapacity

Weight, volume, and dimension capacity (carddata.Capacity)
Weight
​number
Volume
​number
Length
​number
Width
​number
Height
​number
HandlingItems
​number
DimensionsUnit
​string

Dimension unit abbreviation; must match company dimensionunits options

WeightUnit
​string

Must match company weightunits options

VolumeUnit
​string

Must match company volumeunits options

CustomerContactActor

Customer contact Actor
id
​integer · int32
contactId
​string
contactName
​string
address1
​string
address2
​string
city
​string
state
​string
zipcode
​string
title
​string
primaryPhone
​string
mobilPhone
​string
fax
​string
email
​string
contactType
​string
defaultContact
​string
lastUpdated
​string · date-time
accountId
​string
primaryPhoneExtension
​string
secondaryPhone
​string
secondaryPhoneExtension
​string
country
​string
carrierId
​string

InsurancePolicyActor

Carrier insurance policy Actor
policyNumber
​string
companyId
​string
companyName
​string
type
​string
description
​string
amount
​number
currency
​string · enum

CurrencyType enum

Enum values:
USD
CAD
EURO
MXN
unit
​string
effectiveDate
​string · date-time
expireDate
​string · date-time
newUsed
​string
_id
​string

CarrierActor

Carrier Actor
id
​integer · int32
company
​string
integrationId
​string
carrierId
​string
dataGUID
​string
carrierName
​string
scac
​string
address1
​string
address2
​string
city
​string
state
​string
zipCode
​string
countryCode
​string
primaryPhone
​string
secondaryPhone
​string
fax
​string
fedId
​string
mcNumber
​string
dotNumber
​string
contact
​string
lastUpdated
​string · date-time
status
​string
carrierType1
​string
carrierType2
​string
carrierType3
​string
carrierType4
​string
misc1
​string
misc2
​string
misc3
​string
misc4
​string
​AttributesActor[]
email
​string
currency
​string
​InsurancePolicyActor[]
alternateId
​string

MaintenanceActor

Maintenance schedule entry on trailer or tractor
id
​string
name
​string
dueIn
​number
dueInUnit
​string · enum

Interval unit for dueIn

Enum values:
days
miles
kilometers
dueDate
​string · date-time
created
​string · date-time

NoteActor

Note on a trailer
id
​integer · int32
noteId
​integer · int32
dataGUID
​string
note
​string
viaNoteType
​string
type
​string
expires
​string · date-time
table
​string
tableKey
​string
lastUpdated
​string · date-time
noteExpanded
​string
sequence
​integer · int32
createdBy
​string
createdByUsername
​string

NoteRequestActor

Note fields accepted on create/update requests (type is not user-settable)
id
​integer · int32
noteId
​integer · int32
dataGUID
​string
note
​string
viaNoteType
​string
expires
​string · date-time
table
​string
tableKey
​string
lastUpdated
​string · date-time
noteExpanded
​string
sequence
​integer · int32
createdBy
​string
createdByUsername
​string

ProblemDetails

Problem details (RFC 9457) returned by the gateway's own policies.
type
​string
title
​string
status
​integer
detail
​string
instance
​string