GET Get Carrier by ID
Introduction
Retrieves detailed information about a specific carrier by its unique identifier. This API is used to view complete carrier profile including name, SCAC codes, USDOT number, MC number, verification status, and associated organizations. Commonly used when displaying carrier details or validating carrier information during appointment creation.
API Request
GET /carrier/{carrierId}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| carrierId | path | string | Yes | none |
| 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 |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"carrierId": "",
"carrierName": "",
"scac": [
""
],
"usdot": "",
"mcNumber": "",
"verified": false,
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": "",
"carrierStatus": "",
"knownName": "",
"orgIds": [
""
]
}
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RCarrierView |