API Docs
YMS API
Data Models
Carrier
Carrier View

CarrierView

{
  "carrierId": "string",
  "carrierName": "string",
  "scac": [
    "string"
  ],
  "usdot": "string",
  "mcNumber": "string",
  "verified": true,
  "createdTime": "string",
  "createdBy": "string",
  "updatedTime": "string",
  "updatedBy": "string",
  "carrierStatus": "ACTIVE,INACTIVE,EXCEPTION",
  "knownName": "string",
  "orgIds": [
    "string"
  ]
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
carrierIdstringfalsenoneUnique carrier identifier
carrierNamestringfalsenoneThe name of the carrier
scac[string]falsenoneStandard Carrier Alpha Code (SCAC) - unique 4-character identification codes assigned to transportation companies
usdotstringfalsenoneUnited States Department of Transportation (USDOT) identification number assigned to the carrier
mcNumberstringfalsenoneMotor Carrier (MC) number issued by the Federal Motor Carrier Safety Administration
verifiedbooleanfalsenoneIndicates whether the carrier's information has been verified and confirmed as accurate
createdTimestringfalsenoneRecord creation timestamp
createdBystringfalsenoneUser who created the record
updatedTimestringfalsenoneRecord last update timestamp
updatedBystringfalsenoneUser who last updated the record
carrierStatusstringfalsenoneCurrent operational status of the carrier in the system
knownNamestringfalsenoneAlternative or commonly known name of the carrier that may differ from the official name
orgIds[string]falsenoneList of organization identifiers associated with this carrier for cross-reference purposes

Enum Values

PropertyValue
carrierStatusACTIVE
carrierStatusINACTIVE
carrierStatusEXCEPTION