Item Logo
Yms apiData modelsCarrier

Carrier Update CMD

CarrierUpdateCmd

Properties

Name

Type

Required

Constraints

Chinese Name

Description

carrierName

string

true

none


The name of the carrier

scac

[string]

false

none


Standard Carrier Alpha Code (SCAC) - unique 4-character identification codes assigned to transportation companies

usdot

string

true

none


United States Department of Transportation (USDOT) identification number assigned to the carrier

mcNumber

string

false

none


Motor Carrier (MC) number issued by the Federal Motor Carrier Safety Administration. Format examples: 'MC123456', 'MC-123456', or '1234567'

carrierStatus

string

false

none


Current operational status of the carrier in the system

verified

boolean

false

none


Indicates whether the carrier's information has been verified and confirmed as accurate

knownName

string

false

none


Alternative or commonly known name of the carrier that may differ from the official name

orgIds

[string]

false

none


List of organization identifiers associated with this carrier for cross-reference purposes

Enum Values

Property

Value

carrierStatus

ACTIVE

carrierStatus

INACTIVE

carrierStatus

EXCEPTION