Carriers
Create a new carrier
Create a new carrier within an organization.
The carrier type must be specified and determines which fields are available:
- TRUCKLOAD: Includes insurance, safety rating, and FMCSA inspection fields
- AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL: Include only base carrier fields
Note: In the backend, null carrier type is represented as TRUCKLOAD in the public API.
post/carriers
Request body
Example request
{
"name": "Swift Transportation Co",
"type": "TRUCKLOAD",
"dbaName": "Swift Logistics",
"key": "ERP-CARRIER-SWIFT-001",
"email": "dispatch@swifttrans.com",
"phone": "+1-555-987-6543",
"website": "https://swifttrans.com",
"status": "ACTIVE",
"statusReason": "Active and in good standing",
"notes": "Preferred carrier for midwest routes",
"corporateAddress": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Chicago",
"country": "USA",
"market": "CHI",
"latitude": "41.8781",
"longitude": "-87.6298",
"isSmartyValidated": true,
"obeysDst": true
},
"billingAddress": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Chicago",
"country": "USA",
"market": "CHI",
"latitude": "41.8781",
"longitude": "-87.6298",
"isSmartyValidated": true,
"obeysDst": true
},
"mcNumber": "MC-123456",
"dotNumber": "1234567",
"scac": "SWFT",
"einNumber": "12-3456789",
"ffNumber": "FF-123456",
"mxNumber": "MX-123456",
"rfcNumber": "ABCD123456XYZ",
"iataCode": "AA",
"equipments": [
"VAN",
"REEFER"
],
"tsaApproved": true,
"trucks": 50,
"trailers": 100,
"drivers": 75,
"powerUnits": 50,
"currency": "USD",
"paymentTermId": "550e8400-e29b-41d4-a716-446655440002",
"goldenCarrierId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"insuranceCompany": "State Farm Insurance",
"insuranceAgent": "John Smith",
"insuranceAgentPhone": "+1-555-123-4567",
"insuranceAuthorityDate": "2025-01-01T00:00:00Z",
"insuranceExpirationDate": "2025-12-31T23:59:59Z",
"insuranceAutoLiabilityLimit": 1000000,
"insuranceCargoLiabilityLimit": 100000,
"insuranceGeneralLiabilityLimit": 1000000,
"rating": "SATISFACTORY",
"ratingDate": "2025-01-15",
"reviewType": "COMPLIANCE_REVIEW",
"reviewDate": "2025-01-15",
"operatingAbility": "AUTHORIZED",
"inFmcsa": true,
"usDriverInspections": 100,
"usDriverInspectionsOos": 5,
"usDriverInspectionsOosPct": 5,
"usVehicleInspections": 150,
"usVehicleInspectionsOos": 8,
"usVehicleInspectionsOosPct": 5.33
}Response
Carrier created successfully
Example response
{
"object": "CARRIER",
"id": "550e8400-e29b-41d4-a716-446655440000",
"friendlyId": "C123456",
"type": "TRUCKLOAD",
"name": "Swift Transportation Co",
"dbaName": "Swift Logistics",
"key": "ERP-CARRIER-SWIFT-001",
"email": "dispatch@swifttrans.com",
"phone": "+1-555-987-6543",
"website": "https://swifttrans.com",
"status": "ACTIVE",
"statusReason": "Active and in good standing",
"notes": "Preferred carrier for midwest routes",
"corporateAddress": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Chicago",
"country": "USA",
"market": "CHI",
"latitude": "41.8781",
"longitude": "-87.6298",
"isSmartyValidated": true,
"obeysDst": true
},
"billingAddress": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Chicago",
"country": "USA",
"market": "CHI",
"latitude": "41.8781",
"longitude": "-87.6298",
"isSmartyValidated": true,
"obeysDst": true
},
"mcNumber": "MC-123456",
"dotNumber": "1234567",
"scac": "SWFT",
"einNumber": "12-3456789",
"ffNumber": "FF-123456",
"mxNumber": "MX-123456",
"rfcNumber": "ABCD123456XYZ",
"iataCode": "AA",
"equipments": [
"VAN",
"REEFER"
],
"tsaApproved": true,
"trucks": 50,
"trailers": 100,
"drivers": 75,
"powerUnits": 50,
"currency": "USD",
"paymentTerm": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-PAYTERM-NET30",
"name": "Net 30",
"description": "Payment due 30 days from invoice date",
"days": 30,
"quickPayFee": 0.05,
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"goldenCarrierId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"paymentMethods": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "CARRIER-PM-001",
"paymentRecipientType": "DIRECT",
"paymentMethodType": "ACH",
"status": "ACTIVE",
"isPreferred": true,
"email": "payments@carrier.com",
"phone": "+1-555-123-4567",
"companyName": "Carrier Payments LLC",
"username": "carrier_payments",
"bankName": "Chase Bank",
"bankAddress": "123 Bank Street, Dallas, TX 75201",
"accountName": "Carrier Transport Inc",
"accountNumber": "****1234",
"abaAch": "021000021",
"wire": "026009593",
"swiftCode": "CHASUS33",
"eftInstitution": "001",
"eftTransit": "00010",
"clabe": "012180001234567897",
"currency": "USD",
"carrierFactor": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-FACTOR-001",
"companyName": "Capital Factoring Services Inc",
"email": "accounting@capitalfactoring.com",
"phoneNumber": "+1-555-234-5678",
"currency": "USD",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"paymentTerm": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-PAYTERM-NET30",
"name": "Net 30",
"description": "Payment due 30 days from invoice date",
"days": 30,
"quickPayFee": 0.05,
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z",
"deletedBy": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
}
],
"contacts": [
{
"object": "CARRIER_CONTACT",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-CARRIER-CONTACT-001",
"name": "Jane Dispatcher",
"contactInfo": {
"name": "John Smith",
"email": "john.smith@example.com",
"phoneNumber": "+1-555-0100",
"title": "Operations Manager"
},
"contactTypes": [
"DISPATCH",
"AFTER_HOURS"
],
"invitedUser": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"deletedBy": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"createdAt": "2025-01-15T10:00:00Z"
}
],
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z",
"insuranceCompany": "State Farm Insurance",
"insuranceAgent": "John Smith",
"insuranceAgentPhone": "+1-555-123-4567",
"insuranceAuthorityDate": "2025-01-01T00:00:00Z",
"insuranceExpirationDate": "2025-12-31T23:59:59Z",
"insuranceAutoLiabilityLimit": 1000000,
"insuranceCargoLiabilityLimit": 100000,
"insuranceGeneralLiabilityLimit": 1000000,
"rating": "SATISFACTORY",
"ratingDate": "2025-01-15",
"reviewType": "COMPLIANCE_REVIEW",
"reviewDate": "2025-01-15",
"operatingAbility": "AUTHORIZED",
"inFmcsa": true,
"usDriverInspections": 100,
"usDriverInspectionsOos": 5,
"usDriverInspectionsOosPct": 5,
"usVehicleInspections": 150,
"usVehicleInspectionsOos": 8,
"usVehicleInspectionsOosPct": 5.33
}