POST Search Carriers
Introduction
Searches and retrieves carriers with pagination support and multiple filter criteria. This API allows filtering by carrier name, SCAC code, USDOT number, MC number, verification status, and carrier status. Supports both exact match and regex pattern matching for flexible searching. Commonly used in carrier selection dropdowns and carrier management interfaces.
API Request
POST /carrier/search-by-paging
Body Request Parameters
{
"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"
}Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| X-Tenant-ID | header | string | No | none |
| X-Yard-ID | header | string | No | none |
| Item-Time-Zone | header | string | No | none |
| Authorization | header | string | No | none |
| body | body | CarrierQuery | No | none |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"list": [
{
"carrierId": "",
"carrierName": "",
"scac": [
""
],
"usdot": "",
"mcNumber": "",
"verified": false,
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": "",
"carrierStatus": "",
"knownName": "",
"orgIds": [
""
]
}
],
"totalCount": 0,
"currentPage": 0,
"pageSize": 0,
"totalPage": 0
}
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RPageResultCarrierView |