Skip to content
API Reference/
/
Get carrier bills availab...

MVMNT API (1.0.0)

The MVMNT API enables you to automate freight brokerage workflows by integrating directly with our Transportation Management System.

Authentication

OAuth 2.0 client credentials flow. See Authentication Guide for details.

Token Endpoint

POST https://api.mvmnt.io/oauth2/token

Request

Headers:

Content-Type: application/x-www-form-urlencoded

Body Parameters:

grant_type=client_credentials
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET

Example Request

curl -X POST https://api.mvmnt.io/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Success Response

Status: 200 OK

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Response Fields:

  • access_token: JWT Bearer token to use for API requests
  • token_type: Always Bearer
  • expires_in: Token lifetime in seconds (3600 = 1 hour)
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://docs.mvmnt.io
MVMNT Support
support@mvmnt.io
License
Proprietary
Languages
Servers
Mock server
https://docs.mvmnt.io/_mock/apis/openapi
Production
https://api.mvmnt.io/v1

Carriers

Carrier management operations

Operations

Filter carriers

Request

Query carriers using flexible filter criteria with AND/OR logic.

By default, only non-deleted carriers are returned (deletedAt: { isNull: true }). Override this by explicitly setting deletedAt filter criteria.

Returns carriers of all types (TRUCKLOAD, AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL) with type-specific fields included based on carrier type.

Security
BearerAuth
Bodyapplication/jsonrequired
filterobject(CarrierFilter)

Filter criteria (optional - omit to return all carriers).

Note: deletedAt automatically defaults to { isNull: true } unless explicitly overridden.

Example: {"and":[{"type":{"equalTo":"TRUCKLOAD"}},{"status":{"equalTo":"ACTIVE"}},{"inFmcsa":{"equalTo":true}}]}
pageSizeinteger[ 1 .. 250 ]

Number of results per page

Default 50
Example: 50
cursorstring

Pagination cursor for next page

curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/carriers/filter \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "and": [
        {
          "type": {
            "equalTo": "TRUCKLOAD"
          }
        },
        {
          "status": {
            "equalTo": "ACTIVE"
          }
        },
        {
          "inFmcsa": {
            "equalTo": true
          }
        }
      ]
    },
    "pageSize": 50
  }'

Responses

Filtered carriers with pagination

Bodyapplication/json
dataArray of objects(Carrier)required
One of:

Truckload carrier with insurance, safety rating, and FMCSA data

data[].​objectstringread-only

Object type identifier

Value"CARRIER"
Example: "CARRIER"
data[].​idstring(uuid)read-onlyrequired

Unique carrier identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
data[].​friendlyIdstringread-onlyrequired

Human-readable carrier identifier

Example: "C123456"
data[].​typestringrequired

Carrier operation type (discriminator field)

Enum"TRUCKLOAD""AIR""CARTAGE""LINEHAUL""LTL""OCEAN""RAIL"
Example: "TRUCKLOAD"
data[].​namestringrequired

Carrier legal name

Example: "Swift Transportation Co"
data[].​dbaNamestring or null

Doing Business As name

Example: "Swift Logistics"
data[].​keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-CARRIER-SWIFT-001"
data[].​emailstring or null(email)

Primary email address

Example: "dispatch@swifttrans.com"
data[].​phonestring or null

Primary phone number

Example: "+1-555-987-6543"
data[].​websitestring or null

Company website URL

Example: "https://swifttrans.com"
data[].​statusstringrequired

Carrier status

Example: "ACTIVE"
data[].​statusReasonstring or null

Reason for current status

Example: "Active and in good standing"
data[].​notesstring or null

Internal notes about the carrier

Example: "Preferred carrier for midwest routes"
data[].​corporateAddressAddress (object) or null

Corporate headquarters address

Any of:

Physical address/location details (nested, without id).

This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.

data[].​billingAddressAddress (object) or null

Billing address for invoices

Any of:

Physical address/location details (nested, without id).

This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.

data[].​mcNumberstring or null

Motor Carrier (MC) number

Example: "MC-123456"
data[].​dotNumberstring or null

Department of Transportation (DOT) number

Example: "1234567"
data[].​scacstring or null

Standard Carrier Alpha Code

Example: "SWFT"
data[].​einNumberstring or null

Employer Identification Number

Example: "12-3456789"
data[].​ffNumberstring or null

Freight Forwarder (FF) number

Example: "FF-123456"
data[].​mxNumberstring or null

Mexico carrier registration number

Example: "MX-123456"
data[].​rfcNumberstring or null

RFC (Mexico tax ID) number

Example: "ABCD123456XYZ"
data[].​iataCodestring or null

International Air Transport Association code

Example: "AA"
data[].​equipmentsArray of strings(CarrierEquipment)

Equipment types this carrier operates

Items Enum"CONTAINER""FLATBED""POWER_ONLY""REEFER""SPECIALIZED""TANKER""VAN"
Example: ["VAN","REEFER"]
data[].​isHazmatboolean or null

Whether carrier is certified to transport hazardous materials

Example: false
data[].​tsaApprovedboolean or null

Whether carrier is TSA approved

Example: true
data[].​trucksinteger or null

Number of trucks in fleet

Example: 50
data[].​trailersinteger or null

Number of trailers in fleet

Example: 100
data[].​driversinteger or null

Number of drivers employed

Example: 75
data[].​powerUnitsinteger or null

Number of power units

Example: 50
data[].​currencyCurrency (string) or null

Preferred currency for transactions

Any of:

Currency code (ISO 4217)

string(Currency)
Enum"ARS""AUD""BRL""CAD""CNY""EUR""GBP""IDR""INR""JPY"
data[].​paymentTermPaymentTermReference (object) or null

Payment terms for this carrier

Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

data[].​isFactoringPreferredboolean or null

Whether carrier prefers factoring for payment

Example: false
data[].​goldenCarrierIdstring or null(uuid)

Reference to golden carrier record (for deduplication)

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
data[].​paymentMethodsArray of objects(CarrierPaymentMethodReference)

Payment methods configured for this carrier

data[].​contactsArray of objects(CarrierContactReference)

Contacts for this carrier

data[].​createdAtstring(date-time)read-onlyrequired

When the carrier was created

Example: "2025-01-15T10:00:00Z"
data[].​updatedAtstring(date-time)read-onlyrequired

When the carrier was last updated

Example: "2025-01-15T14:30:00Z"
data[].​deletedAtstring or null(date-time)read-only

When the carrier was soft deleted (null if active)

Example: null
data[].​insuranceCompanystring or null

Insurance company name

Example: "State Farm Insurance"
data[].​insuranceAgentstring or null

Insurance agent name

Example: "John Smith"
data[].​insuranceAgentPhonestring or null

Insurance agent phone number

Example: "+1-555-123-4567"
data[].​insuranceAuthorityDatestring or null(date-time)

Date insurance authority was granted

Example: "2025-01-01T00:00:00Z"
data[].​insuranceExpirationDatestring or null(date-time)

Insurance policy expiration date

Example: "2025-12-31T23:59:59Z"
data[].​insuranceAutoLiabilityLimitnumber or null(float)

Auto liability insurance limit (in dollars)

Example: 1000000
data[].​insuranceCargoLiabilityLimitnumber or null(float)

Cargo liability insurance limit (in dollars)

Example: 100000
data[].​insuranceGeneralLiabilityLimitnumber or null(float)

General liability insurance limit (in dollars)

Example: 1000000
data[].​ratingstring or null

Carrier safety rating

Example: "SATISFACTORY"
data[].​ratingDatestring or null(date)

Date of last safety rating

Example: "2025-01-15"
data[].​reviewTypestring or null

Type of safety review conducted

Example: "COMPLIANCE_REVIEW"
data[].​reviewDatestring or null(date)

Date of last safety review

Example: "2025-01-15"
data[].​operatingAbilitystring or null

FMCSA operating authority status

Example: "AUTHORIZED"
data[].​inFmcsaboolean or null

Whether carrier is registered in FMCSA database

Example: true
data[].​usDriverInspectionsinteger or null

Total number of US driver inspections

Example: 100
data[].​usDriverInspectionsOosinteger or null

Number of US driver inspections resulting in out-of-service

Example: 5
data[].​usDriverInspectionsOosPctnumber or null(float)

Percentage of US driver inspections resulting in out-of-service

Example: 5
data[].​usVehicleInspectionsinteger or null

Total number of US vehicle inspections

Example: 150
data[].​usVehicleInspectionsOosinteger or null

Number of US vehicle inspections resulting in out-of-service

Example: 8
data[].​usVehicleInspectionsOosPctnumber or null(float)

Percentage of US vehicle inspections resulting in out-of-service

Example: 5.33
pageInfoobject(PaginationInfo)required
pageInfo.​pageSizeintegerrequired

Number of items per page

Example: 50
pageInfo.​hasNextPagebooleanrequired

Whether there are more pages

Example: true
pageInfo.​hasPreviousPageboolean

Whether there are previous pages

Example: false
pageInfo.​endCursorstring or null

Cursor for the next page (null if no next page)

Example: "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
Response
application/json
{
  "data": [
    { … }
  ],
  "pageInfo": {
    "pageSize": 50,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}

Create a new carrier

Request

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.

Security
BearerAuth
Bodyapplication/jsonrequired
namestringrequired

Carrier legal name

Example: "Swift Transportation Co"
typestringrequired

Carrier operation type (discriminator field)

Enum"TRUCKLOAD""AIR""CARTAGE""LINEHAUL""LTL""OCEAN""RAIL"
Example: "TRUCKLOAD"
Discriminator
dbaNamestring

Doing Business As name

Example: "Swift Logistics"
keystring<= 512 characters

Client-defined reference identifier

Example: "ERP-CARRIER-SWIFT-001"
emailstring(email)

Primary email address

Example: "dispatch@swifttrans.com"
phonestring

Primary phone number

Example: "+1-555-987-6543"
websitestring

Company website URL

Example: "https://swifttrans.com"
statusstring

Carrier status

Example: "ACTIVE"
statusReasonstring

Reason for current status

Example: "Active and in good standing"
notesstring

Internal notes about the carrier

Example: "Preferred carrier for midwest routes"
corporateAddressobject(AddressInput)

Corporate headquarters address

billingAddressobject(AddressInput)

Billing address for invoices

mcNumberstring

Motor Carrier (MC) number

Example: "MC-123456"
dotNumberstring

Department of Transportation (DOT) number

Example: "1234567"
scacstring

Standard Carrier Alpha Code

Example: "SWFT"
einNumberstring

Employer Identification Number

Example: "12-3456789"
ffNumberstring

Freight Forwarder (FF) number

Example: "FF-123456"
mxNumberstring

Mexico carrier registration number

Example: "MX-123456"
rfcNumberstring

RFC (Mexico tax ID) number

Example: "ABCD123456XYZ"
iataCodestring

International Air Transport Association code

Example: "AA"
equipmentsArray of strings(CarrierEquipment)

Equipment types this carrier operates

Items Enum"CONTAINER""FLATBED""POWER_ONLY""REEFER""SPECIALIZED""TANKER""VAN"
Example: ["VAN","REEFER"]
isHazmatboolean

Whether carrier is certified to transport hazardous materials

Example: false
tsaApprovedboolean

Whether carrier is TSA approved

Example: true
trucksinteger

Number of trucks in fleet

Example: 50
trailersinteger

Number of trailers in fleet

Example: 100
driversinteger

Number of drivers employed

Example: 75
powerUnitsinteger

Number of power units

Example: 50
currencystring(Currency)

Preferred currency for transactions

Enum"ARS""AUD""BRL""CAD""CNY""EUR""GBP""IDR""INR""JPY"
paymentTermIdstring(uuid)

Payment term ID

Example: "550e8400-e29b-41d4-a716-446655440002"
isFactoringPreferredboolean

Whether carrier prefers factoring for payment

Example: false
goldenCarrierIdstring(uuid)

Reference to golden carrier record (for deduplication)

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
insuranceCompanystring

Insurance company name

Example: "State Farm Insurance"
insuranceAgentstring

Insurance agent name

Example: "John Smith"
insuranceAgentPhonestring

Insurance agent phone number

Example: "+1-555-123-4567"
insuranceAuthorityDatestring(date-time)

Date insurance authority was granted

Example: "2025-01-01T00:00:00Z"
insuranceExpirationDatestring(date-time)

Insurance policy expiration date

Example: "2025-12-31T23:59:59Z"
insuranceAutoLiabilityLimitnumber(float)

Auto liability insurance limit (in dollars)

Example: 1000000
insuranceCargoLiabilityLimitnumber(float)

Cargo liability insurance limit (in dollars)

Example: 100000
insuranceGeneralLiabilityLimitnumber(float)

General liability insurance limit (in dollars)

Example: 1000000
ratingstring

Carrier safety rating

Example: "SATISFACTORY"
ratingDatestring(date)

Date of last safety rating

Example: "2025-01-15"
reviewTypestring

Type of safety review conducted

Example: "COMPLIANCE_REVIEW"
reviewDatestring(date)

Date of last safety review

Example: "2025-01-15"
operatingAbilitystring

FMCSA operating authority status

Example: "AUTHORIZED"
inFmcsaboolean

Whether carrier is registered in FMCSA database

Example: true
usDriverInspectionsinteger

Total number of US driver inspections

Example: 100
usDriverInspectionsOosinteger

Number of US driver inspections resulting in out-of-service

Example: 5
usDriverInspectionsOosPctnumber(float)

Percentage of US driver inspections resulting in out-of-service

Example: 5
usVehicleInspectionsinteger

Total number of US vehicle inspections

Example: 150
usVehicleInspectionsOosinteger

Number of US vehicle inspections resulting in out-of-service

Example: 8
usVehicleInspectionsOosPctnumber(float)

Percentage of US vehicle inspections resulting in out-of-service

Example: 5.33
curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/carriers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Swift Transportation Co",
    "type": "TRUCKLOAD",
    "email": "dispatch@swifttrans.com",
    "phone": "+1-555-987-6543",
    "status": "ACTIVE",
    "mcNumber": "MC-123456",
    "dotNumber": "1234567",
    "insuranceCompany": "State Farm Insurance",
    "insuranceAutoLiabilityLimit": 1000000,
    "rating": "SATISFACTORY",
    "inFmcsa": true
  }'

Responses

Carrier created successfully

Bodyapplication/json
objectstringread-only

Object type identifier

Value"CARRIER"
Example: "CARRIER"
idstring(uuid)read-onlyrequired

Unique carrier identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
friendlyIdstringread-onlyrequired

Human-readable carrier identifier

Example: "C123456"
typestringrequired

Carrier operation type (discriminator field)

Enum"TRUCKLOAD""AIR""CARTAGE""LINEHAUL""LTL""OCEAN""RAIL"
Example: "TRUCKLOAD"
Discriminator
namestringrequired

Carrier legal name

Example: "Swift Transportation Co"
dbaNamestring or null

Doing Business As name

Example: "Swift Logistics"
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-CARRIER-SWIFT-001"
emailstring or null(email)

Primary email address

Example: "dispatch@swifttrans.com"
phonestring or null

Primary phone number

Example: "+1-555-987-6543"
websitestring or null

Company website URL

Example: "https://swifttrans.com"
statusstringrequired

Carrier status

Example: "ACTIVE"
statusReasonstring or null

Reason for current status

Example: "Active and in good standing"
notesstring or null

Internal notes about the carrier

Example: "Preferred carrier for midwest routes"
corporateAddressAddress (object) or null

Corporate headquarters address

Any of:

Physical address/location details (nested, without id).

This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.

billingAddressAddress (object) or null

Billing address for invoices

Any of:

Physical address/location details (nested, without id).

This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.

mcNumberstring or null

Motor Carrier (MC) number

Example: "MC-123456"
dotNumberstring or null

Department of Transportation (DOT) number

Example: "1234567"
scacstring or null

Standard Carrier Alpha Code

Example: "SWFT"
einNumberstring or null

Employer Identification Number

Example: "12-3456789"
ffNumberstring or null

Freight Forwarder (FF) number

Example: "FF-123456"
mxNumberstring or null

Mexico carrier registration number

Example: "MX-123456"
rfcNumberstring or null

RFC (Mexico tax ID) number

Example: "ABCD123456XYZ"
iataCodestring or null

International Air Transport Association code

Example: "AA"
equipmentsArray of strings(CarrierEquipment)

Equipment types this carrier operates

Items Enum"CONTAINER""FLATBED""POWER_ONLY""REEFER""SPECIALIZED""TANKER""VAN"
Example: ["VAN","REEFER"]
isHazmatboolean or null

Whether carrier is certified to transport hazardous materials

Example: false
tsaApprovedboolean or null

Whether carrier is TSA approved

Example: true
trucksinteger or null

Number of trucks in fleet

Example: 50
trailersinteger or null

Number of trailers in fleet

Example: 100
driversinteger or null

Number of drivers employed

Example: 75
powerUnitsinteger or null

Number of power units

Example: 50
currencyCurrency (string) or null

Preferred currency for transactions

Any of:

Currency code (ISO 4217)

string(Currency)
Enum"ARS""AUD""BRL""CAD""CNY""EUR""GBP""IDR""INR""JPY"
paymentTermPaymentTermReference (object) or null

Payment terms for this carrier

Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

isFactoringPreferredboolean or null

Whether carrier prefers factoring for payment

Example: false
goldenCarrierIdstring or null(uuid)

Reference to golden carrier record (for deduplication)

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
paymentMethodsArray of objects(CarrierPaymentMethodReference)

Payment methods configured for this carrier

contactsArray of objects(CarrierContactReference)

Contacts for this carrier

createdAtstring(date-time)read-onlyrequired

When the carrier was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

When the carrier was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

When the carrier was soft deleted (null if active)

Example: null
insuranceCompanystring or null

Insurance company name

Example: "State Farm Insurance"
insuranceAgentstring or null

Insurance agent name

Example: "John Smith"
insuranceAgentPhonestring or null

Insurance agent phone number

Example: "+1-555-123-4567"
insuranceAuthorityDatestring or null(date-time)

Date insurance authority was granted

Example: "2025-01-01T00:00:00Z"
insuranceExpirationDatestring or null(date-time)

Insurance policy expiration date

Example: "2025-12-31T23:59:59Z"
insuranceAutoLiabilityLimitnumber or null(float)

Auto liability insurance limit (in dollars)

Example: 1000000
insuranceCargoLiabilityLimitnumber or null(float)

Cargo liability insurance limit (in dollars)

Example: 100000
insuranceGeneralLiabilityLimitnumber or null(float)

General liability insurance limit (in dollars)

Example: 1000000
ratingstring or null

Carrier safety rating

Example: "SATISFACTORY"
ratingDatestring or null(date)

Date of last safety rating

Example: "2025-01-15"
reviewTypestring or null

Type of safety review conducted

Example: "COMPLIANCE_REVIEW"
reviewDatestring or null(date)

Date of last safety review

Example: "2025-01-15"
operatingAbilitystring or null

FMCSA operating authority status

Example: "AUTHORIZED"
inFmcsaboolean or null

Whether carrier is registered in FMCSA database

Example: true
usDriverInspectionsinteger or null

Total number of US driver inspections

Example: 100
usDriverInspectionsOosinteger or null

Number of US driver inspections resulting in out-of-service

Example: 5
usDriverInspectionsOosPctnumber or null(float)

Percentage of US driver inspections resulting in out-of-service

Example: 5
usVehicleInspectionsinteger or null

Total number of US vehicle inspections

Example: 150
usVehicleInspectionsOosinteger or null

Number of US vehicle inspections resulting in out-of-service

Example: 8
usVehicleInspectionsOosPctnumber or null(float)

Percentage of US vehicle inspections resulting in out-of-service

Example: 5.33
Response
application/json
{
  "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",
    "isAirportOrAirbase": false,
    "isConstructionOrUtilitySite": false,
    "isSmartyValidated": true,
    "obeysDst": true,
    "cityId": null
  },
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 400",
    "city": "Chicago",
    "country": "USA",
    "market": "CHI",
    "latitude": "41.8781",
    "longitude": "-87.6298",
    "isAirportOrAirbase": false,
    "isConstructionOrUtilitySite": false,
    "isSmartyValidated": true,
    "obeysDst": true,
    "cityId": null
  },
  "mcNumber": "MC-123456",
  "dotNumber": "1234567",
  "scac": "SWFT",
  "einNumber": "12-3456789",
  "ffNumber": "FF-123456",
  "mxNumber": "MX-123456",
  "rfcNumber": "ABCD123456XYZ",
  "iataCode": "AA",
  "equipments": [
    "VAN",
    "REEFER"
  ],
  "isHazmat": false,
  "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,
    "apOnly": false,
    "doNotUse": false,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "isFactoringPreferred": false,
  "goldenCarrierId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "paymentMethods": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null,
  "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
}

Get a carrier by ID

Request

Retrieve a single carrier by its unique identifier.

The response will include type-specific fields based on the carrier's type:

  • TRUCKLOAD: Includes insurance, safety rating, and FMCSA inspection fields
  • AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL: Include only base carrier fields
Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X GET \
  https://docs.mvmnt.io/_mock/apis/openapi/carriers/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Carrier found

Bodyapplication/json
objectstringread-only

Object type identifier

Value"CARRIER"
Example: "CARRIER"
idstring(uuid)read-onlyrequired

Unique carrier identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
friendlyIdstringread-onlyrequired

Human-readable carrier identifier

Example: "C123456"
typestringrequired

Carrier operation type (discriminator field)

Enum"TRUCKLOAD""AIR""CARTAGE""LINEHAUL""LTL""OCEAN""RAIL"
Example: "TRUCKLOAD"
Discriminator
namestringrequired

Carrier legal name

Example: "Swift Transportation Co"
dbaNamestring or null

Doing Business As name

Example: "Swift Logistics"
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-CARRIER-SWIFT-001"
emailstring or null(email)

Primary email address

Example: "dispatch@swifttrans.com"
phonestring or null

Primary phone number

Example: "+1-555-987-6543"
websitestring or null

Company website URL

Example: "https://swifttrans.com"
statusstringrequired

Carrier status

Example: "ACTIVE"
statusReasonstring or null

Reason for current status

Example: "Active and in good standing"
notesstring or null

Internal notes about the carrier

Example: "Preferred carrier for midwest routes"
corporateAddressAddress (object) or null

Corporate headquarters address

Any of:

Physical address/location details (nested, without id).

This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.

billingAddressAddress (object) or null

Billing address for invoices

Any of:

Physical address/location details (nested, without id).

This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.

mcNumberstring or null

Motor Carrier (MC) number

Example: "MC-123456"
dotNumberstring or null

Department of Transportation (DOT) number

Example: "1234567"
scacstring or null

Standard Carrier Alpha Code

Example: "SWFT"
einNumberstring or null

Employer Identification Number

Example: "12-3456789"
ffNumberstring or null

Freight Forwarder (FF) number

Example: "FF-123456"
mxNumberstring or null

Mexico carrier registration number

Example: "MX-123456"
rfcNumberstring or null

RFC (Mexico tax ID) number

Example: "ABCD123456XYZ"
iataCodestring or null

International Air Transport Association code

Example: "AA"
equipmentsArray of strings(CarrierEquipment)

Equipment types this carrier operates

Items Enum"CONTAINER""FLATBED""POWER_ONLY""REEFER""SPECIALIZED""TANKER""VAN"
Example: ["VAN","REEFER"]
isHazmatboolean or null

Whether carrier is certified to transport hazardous materials

Example: false
tsaApprovedboolean or null

Whether carrier is TSA approved

Example: true
trucksinteger or null

Number of trucks in fleet

Example: 50
trailersinteger or null

Number of trailers in fleet

Example: 100
driversinteger or null

Number of drivers employed

Example: 75
powerUnitsinteger or null

Number of power units

Example: 50
currencyCurrency (string) or null

Preferred currency for transactions

Any of:

Currency code (ISO 4217)

string(Currency)
Enum"ARS""AUD""BRL""CAD""CNY""EUR""GBP""IDR""INR""JPY"
paymentTermPaymentTermReference (object) or null

Payment terms for this carrier

Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

isFactoringPreferredboolean or null

Whether carrier prefers factoring for payment

Example: false
goldenCarrierIdstring or null(uuid)

Reference to golden carrier record (for deduplication)

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
paymentMethodsArray of objects(CarrierPaymentMethodReference)

Payment methods configured for this carrier

contactsArray of objects(CarrierContactReference)

Contacts for this carrier

createdAtstring(date-time)read-onlyrequired

When the carrier was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

When the carrier was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

When the carrier was soft deleted (null if active)

Example: null
insuranceCompanystring or null

Insurance company name

Example: "State Farm Insurance"
insuranceAgentstring or null

Insurance agent name

Example: "John Smith"
insuranceAgentPhonestring or null

Insurance agent phone number

Example: "+1-555-123-4567"
insuranceAuthorityDatestring or null(date-time)

Date insurance authority was granted

Example: "2025-01-01T00:00:00Z"
insuranceExpirationDatestring or null(date-time)

Insurance policy expiration date

Example: "2025-12-31T23:59:59Z"
insuranceAutoLiabilityLimitnumber or null(float)

Auto liability insurance limit (in dollars)

Example: 1000000
insuranceCargoLiabilityLimitnumber or null(float)

Cargo liability insurance limit (in dollars)

Example: 100000
insuranceGeneralLiabilityLimitnumber or null(float)

General liability insurance limit (in dollars)

Example: 1000000
ratingstring or null

Carrier safety rating

Example: "SATISFACTORY"
ratingDatestring or null(date)

Date of last safety rating

Example: "2025-01-15"
reviewTypestring or null

Type of safety review conducted

Example: "COMPLIANCE_REVIEW"
reviewDatestring or null(date)

Date of last safety review

Example: "2025-01-15"
operatingAbilitystring or null

FMCSA operating authority status

Example: "AUTHORIZED"
inFmcsaboolean or null

Whether carrier is registered in FMCSA database

Example: true
usDriverInspectionsinteger or null

Total number of US driver inspections

Example: 100
usDriverInspectionsOosinteger or null

Number of US driver inspections resulting in out-of-service

Example: 5
usDriverInspectionsOosPctnumber or null(float)

Percentage of US driver inspections resulting in out-of-service

Example: 5
usVehicleInspectionsinteger or null

Total number of US vehicle inspections

Example: 150
usVehicleInspectionsOosinteger or null

Number of US vehicle inspections resulting in out-of-service

Example: 8
usVehicleInspectionsOosPctnumber or null(float)

Percentage of US vehicle inspections resulting in out-of-service

Example: 5.33
Response
application/json
{
  "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",
    "isAirportOrAirbase": false,
    "isConstructionOrUtilitySite": false,
    "isSmartyValidated": true,
    "obeysDst": true,
    "cityId": null
  },
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 400",
    "city": "Chicago",
    "country": "USA",
    "market": "CHI",
    "latitude": "41.8781",
    "longitude": "-87.6298",
    "isAirportOrAirbase": false,
    "isConstructionOrUtilitySite": false,
    "isSmartyValidated": true,
    "obeysDst": true,
    "cityId": null
  },
  "mcNumber": "MC-123456",
  "dotNumber": "1234567",
  "scac": "SWFT",
  "einNumber": "12-3456789",
  "ffNumber": "FF-123456",
  "mxNumber": "MX-123456",
  "rfcNumber": "ABCD123456XYZ",
  "iataCode": "AA",
  "equipments": [
    "VAN",
    "REEFER"
  ],
  "isHazmat": false,
  "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,
    "apOnly": false,
    "doNotUse": false,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "isFactoringPreferred": false,
  "goldenCarrierId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "paymentMethods": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null,
  "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
}

Update a carrier

Request

Partially update a carrier. Only provided fields will be updated.

  • Omitted fields: Not modified (current value preserved)
  • Provided fields: Updated to the new value
  • Null values: Clear the field (set to null) where applicable

The carrier type determines which fields can be updated:

  • TRUCKLOAD: Can update insurance, safety rating, and FMCSA fields
  • AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL: Can only update base carrier fields

Changing the carrier type will affect which specialized fields are available.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Bodyapplication/jsonrequired
namestring

Carrier legal name

Example: "Swift Transportation Co"
typestring

Carrier operation type

Enum"TRUCKLOAD""AIR""CARTAGE""LINEHAUL""LTL""OCEAN""RAIL"
Example: "TRUCKLOAD"
Discriminator
dbaNamestring or null

Doing Business As name

Example: "Swift Logistics"
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-CARRIER-SWIFT-001"
emailstring or null(email)

Primary email address

Example: "dispatch@swifttrans.com"
phonestring or null

Primary phone number

Example: "+1-555-987-6543"
websitestring or null

Company website URL

Example: "https://swifttrans.com"
statusstring

Carrier status

Example: "ACTIVE"
statusReasonstring or null

Reason for current status

Example: "Active and in good standing"
notesstring or null

Internal notes about the carrier

Example: "Preferred carrier for midwest routes"
corporateAddressobject(AddressPatch)

Partial address update. All fields are optional.

  • Omitted fields: Not modified (current value preserved)
  • Provided fields: Updated to the new value
  • Null values: Clear the field (set to null) where applicable
billingAddressobject(AddressPatch)

Partial address update. All fields are optional.

  • Omitted fields: Not modified (current value preserved)
  • Provided fields: Updated to the new value
  • Null values: Clear the field (set to null) where applicable
mcNumberstring or null

Motor Carrier (MC) number

Example: "MC-123456"
dotNumberstring or null

Department of Transportation (DOT) number

Example: "1234567"
scacstring or null

Standard Carrier Alpha Code

Example: "SWFT"
einNumberstring or null

Employer Identification Number

Example: "12-3456789"
ffNumberstring or null

Freight Forwarder (FF) number

Example: "FF-123456"
mxNumberstring or null

Mexico carrier registration number

Example: "MX-123456"
rfcNumberstring or null

RFC (Mexico tax ID) number

Example: "ABCD123456XYZ"
iataCodestring or null

International Air Transport Association code

Example: "AA"
equipmentsArray of strings(CarrierEquipment)

Equipment types this carrier operates

Items Enum"CONTAINER""FLATBED""POWER_ONLY""REEFER""SPECIALIZED""TANKER""VAN"
Example: ["VAN","REEFER"]
isHazmatboolean or null

Whether carrier is certified to transport hazardous materials

Example: false
tsaApprovedboolean or null

Whether carrier is TSA approved

Example: true
trucksinteger or null

Number of trucks in fleet

Example: 50
trailersinteger or null

Number of trailers in fleet

Example: 100
driversinteger or null

Number of drivers employed

Example: 75
powerUnitsinteger or null

Number of power units

Example: 50
currencyCurrency (string) or null

Preferred currency for transactions

Any of:

Currency code (ISO 4217)

string(Currency)
Enum"ARS""AUD""BRL""CAD""CNY""EUR""GBP""IDR""INR""JPY"
paymentTermIdstring or null(uuid)

Payment term ID

Example: "550e8400-e29b-41d4-a716-446655440002"
isFactoringPreferredboolean or null

Whether carrier prefers factoring for payment

Example: false
goldenCarrierIdstring or null(uuid)

Reference to golden carrier record (for deduplication)

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
insuranceCompanystring or null

Insurance company name

Example: "State Farm Insurance"
insuranceAgentstring or null

Insurance agent name

Example: "John Smith"
insuranceAgentPhonestring or null

Insurance agent phone number

Example: "+1-555-123-4567"
insuranceAuthorityDatestring or null(date-time)

Date insurance authority was granted

Example: "2025-01-01T00:00:00Z"
insuranceExpirationDatestring or null(date-time)

Insurance policy expiration date

Example: "2025-12-31T23:59:59Z"
insuranceAutoLiabilityLimitnumber or null(float)

Auto liability insurance limit (in dollars)

Example: 1000000
insuranceCargoLiabilityLimitnumber or null(float)

Cargo liability insurance limit (in dollars)

Example: 100000
insuranceGeneralLiabilityLimitnumber or null(float)

General liability insurance limit (in dollars)

Example: 1000000
ratingstring or null

Carrier safety rating

Example: "SATISFACTORY"
ratingDatestring or null(date)

Date of last safety rating

Example: "2025-01-15"
reviewTypestring or null

Type of safety review conducted

Example: "COMPLIANCE_REVIEW"
reviewDatestring or null(date)

Date of last safety review

Example: "2025-01-15"
operatingAbilitystring or null

FMCSA operating authority status

Example: "AUTHORIZED"
inFmcsaboolean or null

Whether carrier is registered in FMCSA database

Example: true
usDriverInspectionsinteger or null

Total number of US driver inspections

Example: 100
usDriverInspectionsOosinteger or null

Number of US driver inspections resulting in out-of-service

Example: 5
usDriverInspectionsOosPctnumber or null(float)

Percentage of US driver inspections resulting in out-of-service

Example: 5
usVehicleInspectionsinteger or null

Total number of US vehicle inspections

Example: 150
usVehicleInspectionsOosinteger or null

Number of US vehicle inspections resulting in out-of-service

Example: 8
usVehicleInspectionsOosPctnumber or null(float)

Percentage of US vehicle inspections resulting in out-of-service

Example: 5.33
curl -i -X PATCH \
  https://docs.mvmnt.io/_mock/apis/openapi/carriers/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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",
      "isAirportOrAirbase": false,
      "isConstructionOrUtilitySite": false,
      "isSmartyValidated": true,
      "obeysDst": true,
      "cityId": null
    },
    "billingAddress": {
      "line1": "123 Main St",
      "line2": "Suite 400",
      "city": "Chicago",
      "country": "USA",
      "market": "CHI",
      "latitude": "41.8781",
      "longitude": "-87.6298",
      "isAirportOrAirbase": false,
      "isConstructionOrUtilitySite": false,
      "isSmartyValidated": true,
      "obeysDst": true,
      "cityId": null
    },
    "mcNumber": "MC-123456",
    "dotNumber": "1234567",
    "scac": "SWFT",
    "einNumber": "12-3456789",
    "ffNumber": "FF-123456",
    "mxNumber": "MX-123456",
    "rfcNumber": "ABCD123456XYZ",
    "iataCode": "AA",
    "equipments": [
      "VAN",
      "REEFER"
    ],
    "isHazmat": false,
    "tsaApproved": true,
    "trucks": 50,
    "trailers": 100,
    "drivers": 75,
    "powerUnits": 50,
    "currency": "USD",
    "paymentTermId": "550e8400-e29b-41d4-a716-446655440002",
    "isFactoringPreferred": false,
    "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
  }'

Responses

Carrier updated successfully

Bodyapplication/json
objectstringread-only

Object type identifier

Value"CARRIER"
Example: "CARRIER"
idstring(uuid)read-onlyrequired

Unique carrier identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
friendlyIdstringread-onlyrequired

Human-readable carrier identifier

Example: "C123456"
typestringrequired

Carrier operation type (discriminator field)

Enum"TRUCKLOAD""AIR""CARTAGE""LINEHAUL""LTL""OCEAN""RAIL"
Example: "TRUCKLOAD"
Discriminator
namestringrequired

Carrier legal name

Example: "Swift Transportation Co"
dbaNamestring or null

Doing Business As name

Example: "Swift Logistics"
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-CARRIER-SWIFT-001"
emailstring or null(email)

Primary email address

Example: "dispatch@swifttrans.com"
phonestring or null

Primary phone number

Example: "+1-555-987-6543"
websitestring or null

Company website URL

Example: "https://swifttrans.com"
statusstringrequired

Carrier status

Example: "ACTIVE"
statusReasonstring or null

Reason for current status

Example: "Active and in good standing"
notesstring or null

Internal notes about the carrier

Example: "Preferred carrier for midwest routes"
corporateAddressAddress (object) or null

Corporate headquarters address

Any of:

Physical address/location details (nested, without id).

This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.

billingAddressAddress (object) or null

Billing address for invoices

Any of:

Physical address/location details (nested, without id).

This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.

mcNumberstring or null

Motor Carrier (MC) number

Example: "MC-123456"
dotNumberstring or null

Department of Transportation (DOT) number

Example: "1234567"
scacstring or null

Standard Carrier Alpha Code

Example: "SWFT"
einNumberstring or null

Employer Identification Number

Example: "12-3456789"
ffNumberstring or null

Freight Forwarder (FF) number

Example: "FF-123456"
mxNumberstring or null

Mexico carrier registration number

Example: "MX-123456"
rfcNumberstring or null

RFC (Mexico tax ID) number

Example: "ABCD123456XYZ"
iataCodestring or null

International Air Transport Association code

Example: "AA"
equipmentsArray of strings(CarrierEquipment)

Equipment types this carrier operates

Items Enum"CONTAINER""FLATBED""POWER_ONLY""REEFER""SPECIALIZED""TANKER""VAN"
Example: ["VAN","REEFER"]
isHazmatboolean or null

Whether carrier is certified to transport hazardous materials

Example: false
tsaApprovedboolean or null

Whether carrier is TSA approved

Example: true
trucksinteger or null

Number of trucks in fleet

Example: 50
trailersinteger or null

Number of trailers in fleet

Example: 100
driversinteger or null

Number of drivers employed

Example: 75
powerUnitsinteger or null

Number of power units

Example: 50
currencyCurrency (string) or null

Preferred currency for transactions

Any of:

Currency code (ISO 4217)

string(Currency)
Enum"ARS""AUD""BRL""CAD""CNY""EUR""GBP""IDR""INR""JPY"
paymentTermPaymentTermReference (object) or null

Payment terms for this carrier

Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

isFactoringPreferredboolean or null

Whether carrier prefers factoring for payment

Example: false
goldenCarrierIdstring or null(uuid)

Reference to golden carrier record (for deduplication)

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
paymentMethodsArray of objects(CarrierPaymentMethodReference)

Payment methods configured for this carrier

contactsArray of objects(CarrierContactReference)

Contacts for this carrier

createdAtstring(date-time)read-onlyrequired

When the carrier was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

When the carrier was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

When the carrier was soft deleted (null if active)

Example: null
insuranceCompanystring or null

Insurance company name

Example: "State Farm Insurance"
insuranceAgentstring or null

Insurance agent name

Example: "John Smith"
insuranceAgentPhonestring or null

Insurance agent phone number

Example: "+1-555-123-4567"
insuranceAuthorityDatestring or null(date-time)

Date insurance authority was granted

Example: "2025-01-01T00:00:00Z"
insuranceExpirationDatestring or null(date-time)

Insurance policy expiration date

Example: "2025-12-31T23:59:59Z"
insuranceAutoLiabilityLimitnumber or null(float)

Auto liability insurance limit (in dollars)

Example: 1000000
insuranceCargoLiabilityLimitnumber or null(float)

Cargo liability insurance limit (in dollars)

Example: 100000
insuranceGeneralLiabilityLimitnumber or null(float)

General liability insurance limit (in dollars)

Example: 1000000
ratingstring or null

Carrier safety rating

Example: "SATISFACTORY"
ratingDatestring or null(date)

Date of last safety rating

Example: "2025-01-15"
reviewTypestring or null

Type of safety review conducted

Example: "COMPLIANCE_REVIEW"
reviewDatestring or null(date)

Date of last safety review

Example: "2025-01-15"
operatingAbilitystring or null

FMCSA operating authority status

Example: "AUTHORIZED"
inFmcsaboolean or null

Whether carrier is registered in FMCSA database

Example: true
usDriverInspectionsinteger or null

Total number of US driver inspections

Example: 100
usDriverInspectionsOosinteger or null

Number of US driver inspections resulting in out-of-service

Example: 5
usDriverInspectionsOosPctnumber or null(float)

Percentage of US driver inspections resulting in out-of-service

Example: 5
usVehicleInspectionsinteger or null

Total number of US vehicle inspections

Example: 150
usVehicleInspectionsOosinteger or null

Number of US vehicle inspections resulting in out-of-service

Example: 8
usVehicleInspectionsOosPctnumber or null(float)

Percentage of US vehicle inspections resulting in out-of-service

Example: 5.33
Response
application/json
{
  "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",
    "isAirportOrAirbase": false,
    "isConstructionOrUtilitySite": false,
    "isSmartyValidated": true,
    "obeysDst": true,
    "cityId": null
  },
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 400",
    "city": "Chicago",
    "country": "USA",
    "market": "CHI",
    "latitude": "41.8781",
    "longitude": "-87.6298",
    "isAirportOrAirbase": false,
    "isConstructionOrUtilitySite": false,
    "isSmartyValidated": true,
    "obeysDst": true,
    "cityId": null
  },
  "mcNumber": "MC-123456",
  "dotNumber": "1234567",
  "scac": "SWFT",
  "einNumber": "12-3456789",
  "ffNumber": "FF-123456",
  "mxNumber": "MX-123456",
  "rfcNumber": "ABCD123456XYZ",
  "iataCode": "AA",
  "equipments": [
    "VAN",
    "REEFER"
  ],
  "isHazmat": false,
  "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,
    "apOnly": false,
    "doNotUse": false,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "isFactoringPreferred": false,
  "goldenCarrierId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "paymentMethods": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null,
  "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
}

Delete a carrier

Request

Soft delete a carrier (sets deletedAt timestamp).

The carrier will no longer appear in default queries but can be retrieved by explicitly filtering for deleted records.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X DELETE \
  https://docs.mvmnt.io/_mock/apis/openapi/carriers/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Carrier deleted successfully

Response
No content

Search carriers

Request

Search carriers using OpenSearch-powered full-text and field-specific search.

This endpoint searches both:

  • ONBOARDED carriers: Carriers with profiles in your organization
  • FMCSA carriers: Public carrier records from FMCSA database

Features:

  • Full-text search across multiple fields
  • Field-specific filtering with various operators
  • Sorting and pagination
  • Saved search preferences

Note: Only active (non-deleted) carriers are searchable. Soft-deleted records are automatically excluded from all search results.

Response Formats:

  • flat (default): Returns indexed fields only for faster performance
  • full: Returns complete carrier objects with all relationships
Security
BearerAuth
Bodyapplication/jsonrequired
criteriaobject(CarrierSearchCriteria)

Search criteria to filter carriers

paginationobject(SearchPaginationInput)

Pagination options for search requests

sortArray of objects(SearchSortOption)<= 3 items

Sort options for the search results

Example: [{"field":"createdAt","order":"desc"}]
savedSearchobject(SavedSearchLookup)

Optional saved search to load preferences from. When provided, the saved search criteria will be loaded and merged with any explicit criteria.

formatstring

Response format:

  • flat: Returns only indexed fields (default, faster)
  • full: Returns complete carrier objects
Default "flat"
Enum"flat""full"
curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/carriers/search \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "criteria": {
      "id": {
        "operator": "EQUALS",
        "values": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      },
      "carrierProfileId": {
        "operator": "EQUALS",
        "values": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      },
      "goldenCarrierId": {
        "operator": "EQUALS",
        "values": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      },
      "friendlyId": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "name": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "carrierStatus": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "type": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "city": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "market": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "zone": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "primaryContactName": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "primaryContactPhone": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "primaryContactEmail": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "fmcsaStatus": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "mcNumber": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "dotNumber": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "einNumber": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "safetyRating": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "equipments": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "powerUnits": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "trucks": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "monthsActiveAuthority": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "highwayId": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "highwayRulesAssessment": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "rmisId": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "rmisOperatingStatus": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "rmisInvitationStatus": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "mcpStatus": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "mcpReviewStatus": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "quickbooksVendorId": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "factorBankNames": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "paymentTermName": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "quickPayFee": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "accountOwnerId": {
        "operator": "EQUALS",
        "values": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      },
      "accountOwnerName": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "loadsCount": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "totalMiles": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "totalRevenue": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "totalCostOfGoodsSold": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "ratePerMile": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "quotesCount": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "createdAt": {
        "operator": "AFTER",
        "value": "2025-01-01T00:00:00Z"
      }
    },
    "pagination": {
      "pageNumber": 1,
      "pageSize": 50
    },
    "sort": [
      {
        "field": "createdAt",
        "order": "desc"
      }
    ],
    "savedSearch": {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    },
    "format": "flat"
  }'

Responses

Successful search results

Bodyapplication/json
dataArray of objectsrequired

Search results - either flat rows or full carrier objects based on format parameter

data[].​objectstringrequired

Object type identifier for discriminating between flat and full response formats

Value"CARRIER_SEARCH_ROW"
Discriminator
data[].​idstring(uuid)required

Carrier ID (carrierProfileId if onboarded, goldenCarrierId otherwise)

data[].​carrierProfileIdstring or null(uuid)

Profile ID (only for onboarded carriers)

data[].​goldenCarrierIdstring(uuid)required

Golden carrier ID from FMCSA

data[].​friendlyIdstring or null

Account ID (only for onboarded carriers)

data[].​namestringrequired

Carrier company name

data[].​carrierStatusstring or null

Status (only for onboarded carriers)

Enum"pending""active""inactive""doNotUse"
data[].​typestring or null
Enum"TL""LTL""LINEHAUL""CARTAGE""AIR""OCEAN""RAIL"
data[].​citystring or null
data[].​marketstring or null

DAT market

data[].​zonestring or null

DAT zone

data[].​primaryContactNamestring or null
data[].​primaryContactPhonestring or null
data[].​primaryContactEmailstring or null(email)
data[].​fmcsaStatusstring or null
Enum"active""inactive"
data[].​mcNumberstring or null
data[].​dotNumberstring or null
data[].​einNumberstring or null
data[].​safetyRatingstring or null
data[].​equipmentsArray of strings

Equipment types available

Items Enum"VAN""REEFER""FLATBED""POWER_ONLY""SPECIALIZED""CONTAINER""TANKER"
data[].​powerUnitsinteger or null
data[].​trucksinteger or null
data[].​monthsActiveAuthorityinteger or null

Months of active authority

data[].​highwayIdstring or null
data[].​highwayRulesAssessmentstring or null
data[].​rmisIdstring or null
data[].​rmisOperatingStatusstring or null
data[].​rmisInvitationStatusstring or null
Enum"ERROR""INVITED""SUCCESS"
data[].​mcpStatusstring or null

MyCarrierPortal invite status

Enum"complete""invited""notInvited""inProcess""incomplete"
data[].​mcpReviewStatusstring or null

MyCarrierPortal review status

Enum"acceptable""moderate""unacceptable"
data[].​quickbooksVendorIdstring or null

QuickBooks Online vendor ID

data[].​factorBankNamesArray of strings

Factoring companies

data[].​paymentTermNamestring or null
data[].​quickPayFeenumber or null(float)

Quick pay discount rate

data[].​accountOwnerIdstring or null(uuid)
data[].​accountOwnerNamestring or null
data[].​loadsCountinteger or null

Number of loads delivered

data[].​totalMilesnumber or null(float)
data[].​totalRevenuenumber or null(float)
data[].​totalCostOfGoodsSoldnumber or null(float)
data[].​ratePerMilenumber or null(float)

Average rate per mile

data[].​quotesCountinteger or null
data[].​createdAtstring or null(date-time)

Onboarding date

paginationobject(SearchPaginationInfo)required

Pagination information for search results

pagination.​pageNumberintegerrequired

Current page number

Example: 1
pagination.​pageSizeintegerrequired

Number of results returned on this page

Example: 50
pagination.​totalPagesintegerrequired

Total number of pages available

Example: 25
totalResultsinteger>= 0required

Total number of matching results (excluding soft-deleted records)

Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalPages": 25
  },
  "totalResults": 0
}

Get carrier outstanding bills

Request

List outstanding (unpaid) bills for a carrier.

Returns bills with status APPROVED_TO_PAY.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Enum"id""key"
Example: by=key
curl -i -X GET \
  'https://docs.mvmnt.io/_mock/apis/openapi/carriers/550e8400-e29b-41d4-a716-446655440000/outstanding-bills?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Outstanding bills retrieved

Bodyapplication/json
billsArray of objectsrequired
bills[].​idstring(uuid)
bills[].​friendlyIdstring
bills[].​entityTypestring(BillEntityType)

Type of entity the bill is for.

  • CARRIER: Bill for a carrier (LoadCarrier)
  • VENDOR: Bill for a vendor service (VendedService)
Enum"CARRIER""VENDOR"
bills[].​carrierobject(CarrierReference)

Enhanced reference to a carrier resource (returned in responses). Includes full carrier details in addition to id/key.

Note: Does NOT include nested references (contacts, etc.) to prevent recursion. Maximum nesting depth: 1 level.

bills[].​vendorobject(VendorReference)

Enhanced reference to a vendor profile. Includes full vendor details in addition to id/key.

bills[].​amountnumber
bills[].​invoiceDatestring or null(date)
bills[].​dueDatestring or null(date)
bills[].​openBalancenumber
bills[].​isOverdueboolean
totalOutstandingnumberrequired

Total outstanding balance

Response
application/json
{
  "bills": [
    { … }
  ],
  "totalOutstanding": 0
}

Get carrier bills available for payment

Request

List bills available for payment from a carrier.

Returns bills with status APPROVED_TO_PAY and open balance.

Carrier factor

If the carrier has a factor configured, factor details are included.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Enum"id""key"
Example: by=key
curl -i -X GET \
  'https://docs.mvmnt.io/_mock/apis/openapi/carriers/550e8400-e29b-41d4-a716-446655440000/bills-for-payment?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bills for payment retrieved

Bodyapplication/json
billsArray of objects(OutstandingBill)required
bills[].​idstring(uuid)
bills[].​friendlyIdstring
bills[].​entityTypestring(BillEntityType)

Type of entity the bill is for.

  • CARRIER: Bill for a carrier (LoadCarrier)
  • VENDOR: Bill for a vendor service (VendedService)
Enum"CARRIER""VENDOR"
bills[].​carrierobject(CarrierReference)

Enhanced reference to a carrier resource (returned in responses). Includes full carrier details in addition to id/key.

Note: Does NOT include nested references (contacts, etc.) to prevent recursion. Maximum nesting depth: 1 level.

bills[].​vendorobject(VendorReference)

Enhanced reference to a vendor profile. Includes full vendor details in addition to id/key.

bills[].​invoiceDatestring or null(date)
bills[].​dueDatestring or null(date)
bills[].​amountnumber
bills[].​amountPaidnumber
bills[].​openBalancenumber
bills[].​isOverdueboolean
bills[].​shipmentIdstring or null(uuid)
bills[].​shipmentFriendlyIdstring or null
totalOutstandingnumberrequired

Total outstanding balance

carrierobject(CarrierReference)

Enhanced reference to a carrier resource (returned in responses). Includes full carrier details in addition to id/key.

Note: Does NOT include nested references (contacts, etc.) to prevent recursion. Maximum nesting depth: 1 level.

vendorobject(VendorReference)

Enhanced reference to a vendor profile. Includes full vendor details in addition to id/key.

carrierFactorobject(bill-payments_CarrierFactorReference)
Response
application/json
{
  "bills": [
    { … }
  ],
  "totalOutstanding": 0,
  "carrier": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CARRIER-SWIFT",
    "name": "Swift Transportation",
    "phoneNumber": "+1-555-987-6543",
    "email": "dispatch@swifttrans.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "vendor": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-VENDOR-ABC-001",
    "friendlyId": "V123456",
    "name": "ABC Warehouse Services",
    "email": "billing@abcwarehouse.com",
    "phone": "+1-555-123-4567",
    "status": "ACTIVE",
    "currency": "USD",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "carrierFactor": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "companyName": "string",
    "bankName": "string"
  }
}

Carrier Contacts

Carrier contact management operations

Operations

Carrier Factors

Carrier factor (factoring company) management operations

Operations

Carrier Payment Methods

Carrier payment method management operations

Operations

Companies

Company management operations

Operations

Credit Memos

AR credit memo management operations. Credit memos represent customer credits that can be applied to invoices.

Operations

Bills

AP bill management operations. Bills represent carrier and vendor invoices to be paid.

Operations

Bill Payments

AP bill payment management operations. Bill payments record payments made to carriers and vendors.

Operations

Customers

Customer management operations

Operations

Customer Contacts

Customer contact management operations

Operations

Documents

Document management operations. Documents are files (PDFs, images) that can be attached to orders, loads, or services.

Operations

Invoices

AR invoice management operations. Invoices represent customer billing for shipment services.

Operations

Loads

Load management operations. Loads represent carrier execution - which carrier is moving the freight.

Operations

Locations

Location management operations

Operations

Location Contacts

Location contact management operations

Operations

Payment Terms

Payment term management operations

Operations

Payments

AR payment management operations. Payments represent received customer payments applied to invoices.

Operations

Quotes

Quote management operations. Quotes are pricing requests/responses that can be converted to shipments.

Operations

Saved Searches

Saved search management operations

Operations

Services

Service (vended service) management operations. Services represent non-carrier vendor work (drayage, customs, warehousing).

Operations

Shipments

Shipment tracking and management operations. Shipments contain orders, loads, and services.

Operations

Teams

Team management operations

Operations

Users

User management operations

Operations

Vendors

Vendor management operations

Operations

Vendor Contacts

Vendor contact management operations

Operations

Vendor Payment Methods

Vendor payment method management operations

Operations

Event Notifications

Webhooks