API Docs
YMS API
Data Models
Carrier
Carrier Query

CarrierQuery

{
  "currentPage": 0,
  "pageSize": 0,
  "sortingFields": [
    {
      "field": "string",
      "orderBy": "NONE"
    }
  ],
  "carrierId": "string",
  "carrierIds": [
    "string"
  ],
  "carrierName": "string",
  "carrierNames": [
    "string"
  ],
  "scac": "string",
  "regexScac": "string",
  "scacList": [
    "string"
  ],
  "verified": true,
  "usdot": "string",
  "usdots": [
    "string"
  ],
  "regexUsdot": "string",
  "mcNumber": "string",
  "regexMcNumber": "string",
  "carrierStatus": "ACTIVE,INACTIVE,EXCEPTION"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
currentPageintegerfalsenonenone
pageSizeintegerfalsenonenone
sortingFields[SortingField]falsenonenone
carrierIdstringfalsenoneSpecific carrier identifier
carrierIds[string]falsenoneList of carrier identifiers for batch query
carrierNamestringfalsenoneCarrier name for fuzzy search
carrierNames[string]falsenoneList of carrier names for batch query
scacstringfalsenoneStandard Carrier Alpha Code (SCAC) for exact match
regexScacstringfalsenoneSCAC code for fuzzy search
scacList[string]falsenoneList of SCAC codes for batch query
verifiedbooleanfalsenoneFilter by verification status
usdotstringfalsenoneUnited States Department of Transportation (USDOT) number for exact match
usdots[string]falsenoneList of USDOT numbers for batch query
regexUsdotstringfalsenoneUSDOT number for fuzzy search
mcNumberstringfalsenoneMotor Carrier (MC) number for exact match
regexMcNumberstringfalsenoneMC number for fuzzy search
carrierStatusstringfalsenoneCurrent operational status of the carrier

Enum Values

PropertyValue
carrierStatusACTIVE
carrierStatusINACTIVE
carrierStatusEXCEPTION