POST Create Carrier
Introduction
Creates a new carrier (transportation company) in the system. Carriers are responsible for transporting containers and trailers to and from the yard. This API allows administrators to register new carriers with their identification details including SCAC code, USDOT number, and MC number. The carrier can be associated with specific organizations and marked as verified for trusted operations.
API Request
POST /carrier/create
Body Request Parameters
{
"carrierName": "string",
"scac": [
"string"
],
"usdot": "string",
"mcNumber": "string",
"carrierStatus": "ACTIVE,INACTIVE,EXCEPTION",
"verified": true,
"knownName": "string",
"orgIds": [
"string"
]
}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 | CarrierCreateCmd | 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 |