API Docs
YMS API
Data Models
Carrier
Carrier Create CMD

CarrierCreateCmd

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

Properties

NameTypeRequiredConstraintsChinese NameDescription
carrierNamestringtruenoneThe name of the carrier
scac[string]falsenoneStandard Carrier Alpha Code (SCAC) - unique 4-character identification codes assigned to transportation companies
usdotstringtruenoneUnited States Department of Transportation (USDOT) identification number assigned to the carrier
mcNumberstringfalsenoneMotor Carrier (MC) number issued by the Federal Motor Carrier Safety Administration. Format examples: 'MC123456', 'MC-123456', or '1234567'
carrierStatusstringfalsenoneCurrent operational status of the carrier in the system
verifiedbooleanfalsenoneIndicates whether the carrier's information has been verified and confirmed as accurate
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