Skip to content
API Reference/
/
Add carrier to load

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

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

Filter loads

Request

Search for loads using filter criteria.

Common Filters

  • By shipment: { "filter": { "shipmentId": { "equalTo": "uuid" } } }
  • Active loads: { "filter": { "status": { "notIn": ["DELIVERED", "CANCELED"] } } }
  • TL loads: { "filter": { "mode": { "equalTo": "TL" } } }
Security
BearerAuth
Bodyapplication/jsonrequired
filterobject(LoadFilter)
pageSizeinteger[ 1 .. 100 ]
Default 50
cursorstring
curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/loads/filter \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "shipmentId": {
        "equalTo": "550e8400-e29b-41d4-a716-446655440000"
      }
    }
  }'

Responses

Loads matching filter criteria

Bodyapplication/json
dataArray of objects(Load)required
data[].​idstring(uuid)required
Example: "550e8400-e29b-41d4-a716-446655440000"
data[].​keystring or null

Human-readable load ID

Example: "LD-12345"
data[].​shipmentIdstring(uuid)

Parent shipment

data[].​shipmentKeystring or null

Parent shipment friendly ID

data[].​modestring(TransportMode)

Transportation mode.

  • TL: Full Truckload
  • LTL: Less than Truckload
  • AIR: Air freight
  • OCEAN: Ocean freight
  • RAIL: Rail freight
  • INTERMODAL: Intermodal (multiple modes)
  • DRAYAGE: Drayage/cartage
Enum"TL""LTL""AIR""OCEAN""RAIL""INTERMODAL""DRAYAGE"
data[].​statusstring(LoadStatus)required

Current status of the load.

Pre-transit:

  • SOURCING: Looking for carrier
  • BOOKED: Carrier booked
  • DISPATCHED: Dispatched to carrier

In-transit:

  • LOADING: Loading at pickup
  • PICKED_UP: Picked up
  • IN_TRANSIT: In transit
  • UNLOADING: Unloading at delivery

Final:

  • DELIVERED: Delivered
  • CANCELED: Canceled
Enum"SOURCING""BOOKED""DISPATCHED""LOADING""PICKED_UP""IN_TRANSIT""UNLOADING""DELIVERED""CANCELED"
data[].​stopsArray of objects(LoadStop)

Load stops

data[].​carriersArray of objects(LoadCarrier)

Carrier assignments (flattened from LoadCarriersConnection)

data[].​totalCostnumber or null

Total carrier costs

data[].​createdAtstring(date-time)required
data[].​updatedAtstring or null(date-time)
data[].​pickedUpAtstring or null(date-time)
data[].​deliveredAtstring or null(date-time)
paginationobject(PaginationInfo)required
pagination.​pageSizeintegerrequired

Number of items per page

Example: 50
pagination.​hasNextPagebooleanrequired

Whether there are more pages

Example: true
pagination.​hasPreviousPageboolean

Whether there are previous pages

Example: false
pagination.​endCursorstring or null

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

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

Create a load

Request

Create a new load for a shipment.

What happens

  • Load is created for the specified shipment
  • Optionally assigns an initial carrier

Note

Loads are typically created as part of shipment creation. Use this endpoint to add additional loads to an existing shipment.

Security
BearerAuth
Bodyapplication/jsonrequired
shipmentIdstring(uuid)required

Parent shipment ID

loadobject(LoadInput)required
load.​modestring(TransportMode)required

Transportation mode.

  • TL: Full Truckload
  • LTL: Less than Truckload
  • AIR: Air freight
  • OCEAN: Ocean freight
  • RAIL: Rail freight
  • INTERMODAL: Intermodal (multiple modes)
  • DRAYAGE: Drayage/cartage
Enum"TL""LTL""AIR""OCEAN""RAIL""INTERMODAL""DRAYAGE"
load.​orderStopIdsArray of strings(uuid)

Order stop IDs to include in this load

load.​carrierobject(LoadCarrierInput)

Initial carrier assignment

curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/loads \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipmentId": "550e8400-e29b-41d4-a716-446655440000",
    "load": {
      "mode": "TL"
    }
  }'

Responses

Load created successfully

Bodyapplication/json
idstring(uuid)required
Example: "550e8400-e29b-41d4-a716-446655440000"
keystring or null

Human-readable load ID

Example: "LD-12345"
shipmentIdstring(uuid)

Parent shipment

shipmentKeystring or null

Parent shipment friendly ID

modestring(TransportMode)

Transportation mode.

  • TL: Full Truckload
  • LTL: Less than Truckload
  • AIR: Air freight
  • OCEAN: Ocean freight
  • RAIL: Rail freight
  • INTERMODAL: Intermodal (multiple modes)
  • DRAYAGE: Drayage/cartage
Enum"TL""LTL""AIR""OCEAN""RAIL""INTERMODAL""DRAYAGE"
statusstring(LoadStatus)required

Current status of the load.

Pre-transit:

  • SOURCING: Looking for carrier
  • BOOKED: Carrier booked
  • DISPATCHED: Dispatched to carrier

In-transit:

  • LOADING: Loading at pickup
  • PICKED_UP: Picked up
  • IN_TRANSIT: In transit
  • UNLOADING: Unloading at delivery

Final:

  • DELIVERED: Delivered
  • CANCELED: Canceled
Enum"SOURCING""BOOKED""DISPATCHED""LOADING""PICKED_UP""IN_TRANSIT""UNLOADING""DELIVERED""CANCELED"
stopsArray of objects(LoadStop)

Load stops

carriersArray of objects(LoadCarrier)

Carrier assignments (flattened from LoadCarriersConnection)

totalCostnumber or null

Total carrier costs

createdAtstring(date-time)required
updatedAtstring or null(date-time)
pickedUpAtstring or null(date-time)
deliveredAtstring or null(date-time)
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "LD-12345",
  "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
  "shipmentKey": "string",
  "mode": "TL",
  "status": "SOURCING",
  "stops": [
    { … }
  ],
  "carriers": [
    { … }
  ],
  "totalCost": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "pickedUpAt": "2019-08-24T14:15:22Z",
  "deliveredAt": "2019-08-24T14:15:22Z"
}

Get a load

Request

Retrieve a load by ID.

The response includes embedded carriers and stops.

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/loads/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Load retrieved successfully

Bodyapplication/json
idstring(uuid)required
Example: "550e8400-e29b-41d4-a716-446655440000"
keystring or null

Human-readable load ID

Example: "LD-12345"
shipmentIdstring(uuid)

Parent shipment

shipmentKeystring or null

Parent shipment friendly ID

modestring(TransportMode)

Transportation mode.

  • TL: Full Truckload
  • LTL: Less than Truckload
  • AIR: Air freight
  • OCEAN: Ocean freight
  • RAIL: Rail freight
  • INTERMODAL: Intermodal (multiple modes)
  • DRAYAGE: Drayage/cartage
Enum"TL""LTL""AIR""OCEAN""RAIL""INTERMODAL""DRAYAGE"
statusstring(LoadStatus)required

Current status of the load.

Pre-transit:

  • SOURCING: Looking for carrier
  • BOOKED: Carrier booked
  • DISPATCHED: Dispatched to carrier

In-transit:

  • LOADING: Loading at pickup
  • PICKED_UP: Picked up
  • IN_TRANSIT: In transit
  • UNLOADING: Unloading at delivery

Final:

  • DELIVERED: Delivered
  • CANCELED: Canceled
Enum"SOURCING""BOOKED""DISPATCHED""LOADING""PICKED_UP""IN_TRANSIT""UNLOADING""DELIVERED""CANCELED"
stopsArray of objects(LoadStop)

Load stops

carriersArray of objects(LoadCarrier)

Carrier assignments (flattened from LoadCarriersConnection)

totalCostnumber or null

Total carrier costs

createdAtstring(date-time)required
updatedAtstring or null(date-time)
pickedUpAtstring or null(date-time)
deliveredAtstring or null(date-time)
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "LD-12345",
  "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
  "shipmentKey": "string",
  "mode": "TL",
  "status": "SOURCING",
  "stops": [
    { … }
  ],
  "carriers": [
    { … }
  ],
  "totalCost": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "pickedUpAt": "2019-08-24T14:15:22Z",
  "deliveredAt": "2019-08-24T14:15:22Z"
}

Update a load

Request

Update load fields.

Note: To manage carriers, use the carrier-specific endpoints.

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
Bodyapplication/jsonrequired
modestring(TransportMode)

Transportation mode.

  • TL: Full Truckload
  • LTL: Less than Truckload
  • AIR: Air freight
  • OCEAN: Ocean freight
  • RAIL: Rail freight
  • INTERMODAL: Intermodal (multiple modes)
  • DRAYAGE: Drayage/cartage
Enum"TL""LTL""AIR""OCEAN""RAIL""INTERMODAL""DRAYAGE"
curl -i -X PATCH \
  'https://docs.mvmnt.io/_mock/apis/openapi/loads/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "mode": "TL"
  }'

Responses

Load updated successfully

Bodyapplication/json
idstring(uuid)required
Example: "550e8400-e29b-41d4-a716-446655440000"
keystring or null

Human-readable load ID

Example: "LD-12345"
shipmentIdstring(uuid)

Parent shipment

shipmentKeystring or null

Parent shipment friendly ID

modestring(TransportMode)

Transportation mode.

  • TL: Full Truckload
  • LTL: Less than Truckload
  • AIR: Air freight
  • OCEAN: Ocean freight
  • RAIL: Rail freight
  • INTERMODAL: Intermodal (multiple modes)
  • DRAYAGE: Drayage/cartage
Enum"TL""LTL""AIR""OCEAN""RAIL""INTERMODAL""DRAYAGE"
statusstring(LoadStatus)required

Current status of the load.

Pre-transit:

  • SOURCING: Looking for carrier
  • BOOKED: Carrier booked
  • DISPATCHED: Dispatched to carrier

In-transit:

  • LOADING: Loading at pickup
  • PICKED_UP: Picked up
  • IN_TRANSIT: In transit
  • UNLOADING: Unloading at delivery

Final:

  • DELIVERED: Delivered
  • CANCELED: Canceled
Enum"SOURCING""BOOKED""DISPATCHED""LOADING""PICKED_UP""IN_TRANSIT""UNLOADING""DELIVERED""CANCELED"
stopsArray of objects(LoadStop)

Load stops

carriersArray of objects(LoadCarrier)

Carrier assignments (flattened from LoadCarriersConnection)

totalCostnumber or null

Total carrier costs

createdAtstring(date-time)required
updatedAtstring or null(date-time)
pickedUpAtstring or null(date-time)
deliveredAtstring or null(date-time)
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "LD-12345",
  "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
  "shipmentKey": "string",
  "mode": "TL",
  "status": "SOURCING",
  "stops": [
    { … }
  ],
  "carriers": [
    { … }
  ],
  "totalCost": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "pickedUpAt": "2019-08-24T14:15:22Z",
  "deliveredAt": "2019-08-24T14:15:22Z"
}

Delete a load

Request

Soft delete a load.

Prerequisites

  • Load must not have any active carriers
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 DELETE \
  'https://docs.mvmnt.io/_mock/apis/openapi/loads/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Load deleted successfully

Response
No content

Add carrier to load

Request

Add an additional carrier to a load.

Use cases

  • Split loads (multiple carriers for same load)
  • Adding backup carrier
  • Re-assigning after TONU/bounce

What happens

  • New LoadCarrier record is created
  • Carrier is notified (if configured)
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
Bodyapplication/jsonrequired
carrierobject(ResourceReferenceInput)required
One of:

Carrier reference

carrier.​idstring(uuid)required

Resource UUID

carrier.​keystring

Client-defined reference ID

contactobject(ResourceReferenceInput)
One of:

Carrier contact

chargesArray of objects
driverNamestring
driverPhonestring
truckNumberstring
trailerNumberstring
curl -i -X POST \
  'https://docs.mvmnt.io/_mock/apis/openapi/loads/550e8400-e29b-41d4-a716-446655440000/add-carrier?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrier": {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    },
    "contact": {
      "id": "660e8400-e29b-41d4-a716-446655440001"
    },
    "charges": [
      {
        "chargeCode": {
          "key": "LINEHAUL"
        },
        "amount": 2000
      }
    ],
    "driverName": "John Smith",
    "driverPhone": "+15551234567"
  }'

Responses

Carrier added successfully

Bodyapplication/json
loadIdstring(uuid)required
loadCarrierIdstring(uuid)required

The new load carrier ID

loadCarrierobject(LoadCarrier)
Response
application/json
{
  "loadId": "9fa4c9ea-0db7-4bb2-8f50-086d18a90403",
  "loadCarrierId": "29f9f87f-f417-4003-80d8-b9d49851fa35",
  "loadCarrier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "carrier": { … },
    "contact": { … },
    "status": "ACTIVE",
    "billingStatus": "AWAITING_INVOICE",
    "bookedAt": "2019-08-24T14:15:22Z",
    "dispatchedAt": "2019-08-24T14:15:22Z",
    "charges": [ … ],
    "totalCost": 0,
    "driverName": "string",
    "driverPhone": "string",
    "truckNumber": "string",
    "trailerNumber": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Rebook a TONU load

Request

Create a new load to replace a TONU'd load.

Use case

After a carrier reports TONU, use this to create a replacement load that can be assigned to a new carrier.

What happens

  • New Load is created with same stops
  • Original load remains in TONU status
  • New load is ready for carrier assignment
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 POST \
  'https://docs.mvmnt.io/_mock/apis/openapi/loads/550e8400-e29b-41d4-a716-446655440000/rebook?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Load rebooked successfully

Bodyapplication/json
originalLoadIdstring(uuid)required
newLoadIdstring(uuid)required
newLoadKeystring or null
Response
application/json
{
  "originalLoadId": "550e8400-e29b-41d4-a716-446655440000",
  "newLoadId": "660e8400-e29b-41d4-a716-446655440001",
  "newLoadKey": "LD-12346"
}

Get load carrier

Request

Retrieve a specific carrier assignment for a load.

Security
BearerAuth
Path
loadIdstringrequired

Load ID

carrierIdstringrequired

LoadCarrier ID

curl -i -X GET \
  'https://docs.mvmnt.io/_mock/apis/openapi/loads/{loadId}/carriers/{carrierId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Load carrier retrieved

Bodyapplication/json
idstring(uuid)
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.

contactobject
statusstring(LoadCarrierStatus)

Status of the carrier assignment.

  • ACTIVE: Carrier is actively assigned
  • TONU: Truck Ordered Not Used (carrier dispatched but cancelled)
  • BOUNCED: Carrier bounced/rejected load
Enum"ACTIVE""TONU""BOUNCED"
billingStatusstring(LoadBillingStatus)

Billing status for the load (AP side).

  • AWAITING_INVOICE: Waiting for carrier invoice
  • INVOICE_IN_REVIEW: Invoice received, under review
  • APPROVED_TO_PAY: Approved for payment
  • PAID: Paid to carrier
Enum"AWAITING_INVOICE""INVOICE_IN_REVIEW""APPROVED_TO_PAY""PAID"
bookedAtstring or null(date-time)
dispatchedAtstring or null(date-time)
chargesArray of objects(LoadCarrierCharge)

Flattened charges array

totalCostnumber or null

Sum of all charges

driverNamestring or null
driverPhonestring or null
truckNumberstring or null
trailerNumberstring or null
createdAtstring(date-time)
updatedAtstring or null(date-time)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "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
  },
  "contact": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "status": "ACTIVE",
  "billingStatus": "AWAITING_INVOICE",
  "bookedAt": "2019-08-24T14:15:22Z",
  "dispatchedAt": "2019-08-24T14:15:22Z",
  "charges": [
    { … }
  ],
  "totalCost": 0,
  "driverName": "string",
  "driverPhone": "string",
  "truckNumber": "string",
  "trailerNumber": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Update load carrier

Request

Update carrier assignment details.

Use this to update driver info, truck/trailer numbers, or contact.

Security
BearerAuth
Path
loadIdstringrequired
carrierIdstringrequired
Bodyapplication/jsonrequired
contactobject(ResourceReferenceInput)
One of:

Reference to another resource by either ID or client key (used in create/update requests)

driverNamestring or null
driverPhonestring or null
truckNumberstring or null
trailerNumberstring or null
curl -i -X PATCH \
  'https://docs.mvmnt.io/_mock/apis/openapi/loads/{loadId}/carriers/{carrierId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "driverName": "Jane Doe",
    "driverPhone": "+15559876543",
    "truckNumber": "TRK-123",
    "trailerNumber": "TRL-456"
  }'

Responses

Load carrier updated

Bodyapplication/json
idstring(uuid)
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.

contactobject
statusstring(LoadCarrierStatus)

Status of the carrier assignment.

  • ACTIVE: Carrier is actively assigned
  • TONU: Truck Ordered Not Used (carrier dispatched but cancelled)
  • BOUNCED: Carrier bounced/rejected load
Enum"ACTIVE""TONU""BOUNCED"
billingStatusstring(LoadBillingStatus)

Billing status for the load (AP side).

  • AWAITING_INVOICE: Waiting for carrier invoice
  • INVOICE_IN_REVIEW: Invoice received, under review
  • APPROVED_TO_PAY: Approved for payment
  • PAID: Paid to carrier
Enum"AWAITING_INVOICE""INVOICE_IN_REVIEW""APPROVED_TO_PAY""PAID"
bookedAtstring or null(date-time)
dispatchedAtstring or null(date-time)
chargesArray of objects(LoadCarrierCharge)

Flattened charges array

totalCostnumber or null

Sum of all charges

driverNamestring or null
driverPhonestring or null
truckNumberstring or null
trailerNumberstring or null
createdAtstring(date-time)
updatedAtstring or null(date-time)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "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
  },
  "contact": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "status": "ACTIVE",
  "billingStatus": "AWAITING_INVOICE",
  "bookedAt": "2019-08-24T14:15:22Z",
  "dispatchedAt": "2019-08-24T14:15:22Z",
  "charges": [
    { … }
  ],
  "totalCost": 0,
  "driverName": "string",
  "driverPhone": "string",
  "truckNumber": "string",
  "trailerNumber": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Bounce carrier

Request

Mark carrier as bounced (rejected load without payment).

What happens

  • LoadCarrier status changes to BOUNCED
  • Carrier is removed from active execution
  • No payment is recorded

When to use

Use bounce when carrier rejects the load before dispatch, or fails to show up without prior notice.

For carriers who were dispatched but cancelled, use TONU instead.

Security
BearerAuth
Path
loadIdstringrequired
carrierIdstringrequired
Bodyapplication/json
reasonstring(LoadCarrierRemovalReason)

Reason for removing a carrier from a load

Enum"TONU""BOUNCED""RATE_DISPUTE""EQUIPMENT_ISSUE""DRIVER_ISSUE""TIMING_ISSUE""OTHER"
reasonTextstring<= 1000 characters

Additional reason details

curl -i -X POST \
  'https://docs.mvmnt.io/_mock/apis/openapi/loads/{loadId}/carriers/{carrierId}/bounce' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reason": "DRIVER_ISSUE",
    "reasonText": "Driver did not show up at scheduled time"
  }'

Responses

Carrier bounced successfully

Bodyapplication/json
idstring(uuid)
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.

contactobject
statusstring(LoadCarrierStatus)

Status of the carrier assignment.

  • ACTIVE: Carrier is actively assigned
  • TONU: Truck Ordered Not Used (carrier dispatched but cancelled)
  • BOUNCED: Carrier bounced/rejected load
Enum"ACTIVE""TONU""BOUNCED"
billingStatusstring(LoadBillingStatus)

Billing status for the load (AP side).

  • AWAITING_INVOICE: Waiting for carrier invoice
  • INVOICE_IN_REVIEW: Invoice received, under review
  • APPROVED_TO_PAY: Approved for payment
  • PAID: Paid to carrier
Enum"AWAITING_INVOICE""INVOICE_IN_REVIEW""APPROVED_TO_PAY""PAID"
bookedAtstring or null(date-time)
dispatchedAtstring or null(date-time)
chargesArray of objects(LoadCarrierCharge)

Flattened charges array

totalCostnumber or null

Sum of all charges

driverNamestring or null
driverPhonestring or null
truckNumberstring or null
trailerNumberstring or null
createdAtstring(date-time)
updatedAtstring or null(date-time)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "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
  },
  "contact": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "status": "ACTIVE",
  "billingStatus": "AWAITING_INVOICE",
  "bookedAt": "2019-08-24T14:15:22Z",
  "dispatchedAt": "2019-08-24T14:15:22Z",
  "charges": [
    { … }
  ],
  "totalCost": 0,
  "driverName": "string",
  "driverPhone": "string",
  "truckNumber": "string",
  "trailerNumber": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Report TONU

Request

Report Truck Ordered Not Used (TONU).

What happens

  • LoadCarrier status changes to TONU
  • TONU costs are recorded if provided
  • Optionally creates a replacement load

When to use

Use TONU when:

  • Carrier was dispatched but load was cancelled
  • Carrier arrived but freight wasn't ready
  • Carrier was turned away at shipper

TONU typically involves some payment to the carrier.

Security
BearerAuth
Path
loadIdstringrequired
carrierIdstringrequired
Bodyapplication/json
reasonstring<= 1000 characters

Reason for TONU

costsArray of objects

TONU costs to record

createReplacementLoadboolean

Whether to create a replacement load

Default false
curl -i -X POST \
  'https://docs.mvmnt.io/_mock/apis/openapi/loads/{loadId}/carriers/{carrierId}/tonu' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reason": "Freight not ready at shipper",
    "costs": [
      {
        "chargeCode": {
          "key": "TONU"
        },
        "amount": 250,
        "description": "TONU fee"
      }
    ],
    "createReplacementLoad": true
  }'

Responses

TONU reported successfully

Bodyapplication/json
loadCarrierobject(LoadCarrier)
replacementLoadIdstring or null(uuid)

New load ID if replacement was requested

Response
application/json
{
  "loadCarrier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "carrier": { … },
    "contact": { … },
    "status": "ACTIVE",
    "billingStatus": "AWAITING_INVOICE",
    "bookedAt": "2019-08-24T14:15:22Z",
    "dispatchedAt": "2019-08-24T14:15:22Z",
    "charges": [ … ],
    "totalCost": 0,
    "driverName": "string",
    "driverPhone": "string",
    "truckNumber": "string",
    "trailerNumber": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "replacementLoadId": "08109b74-00a2-4d00-91a7-576db2a57194"
}

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