Item Logo
Yms apiData modelsCarrier

Carrier Query

CarrierQuery

Properties

Name

Type

Required

Constraints

Chinese Name

Description

currentPage

integer

false

none


none

pageSize

integer

false

none


none

sortingFields

[SortingField]

false

none


none

carrierId

string

false

none


Specific carrier identifier

carrierIds

[string]

false

none


List of carrier identifiers for batch query

carrierName

string

false

none


Carrier name for fuzzy search

carrierNames

[string]

false

none


List of carrier names for batch query

scac

string

false

none


Standard Carrier Alpha Code (SCAC) for exact match

regexScac

string

false

none


SCAC code for fuzzy search

scacList

[string]

false

none


List of SCAC codes for batch query

verified

boolean

false

none


Filter by verification status

usdot

string

false

none


United States Department of Transportation (USDOT) number for exact match

usdots

[string]

false

none


List of USDOT numbers for batch query

regexUsdot

string

false

none


USDOT number for fuzzy search

mcNumber

string

false

none


Motor Carrier (MC) number for exact match

regexMcNumber

string

false

none


MC number for fuzzy search

carrierStatus

string

false

none


Current operational status of the carrier

Enum Values

Property

Value

carrierStatus

ACTIVE

carrierStatus

INACTIVE

carrierStatus

EXCEPTION