Skip to content
/Reference Data

MVMNT API (1.0.0)

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

Postman setup guide: API Clients.

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)

Idempotency

Mutating requests (POST, PATCH, DELETE) accept an optional Idempotency-Key header (up to 255 characters). Retrying a request with the same key and the same body returns the original result instead of repeating the operation; reusing a key with a different body fails. Keys are scoped to your organization — keys chosen by other tenants can never collide with yours. Use a stable identifier from your system (for example your own record id plus the action) rather than a random value per attempt.

Download OpenAPI description
openapi.json
openapi.yaml
openapi-3.0.yaml (legacy tooling)
Postman Collection
Postman Environment — Demo
Postman Environment — Production
Overview
URL
https://docs.mvmnt.io
MVMNT Support
support@mvmnt.io
License
Proprietary
Languages
Servers
Production
https://api.mvmnt.io/v1
Demo (non-production)
https://api.demo.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

Locations

Location management operations

Operations

Location Contacts

Location contact management operations

Operations

Payment Terms

Payment term management operations

Operations

Reference Data

Read-only catalogs (equipment, charge codes, special requirements) referenced by id from other resources.

Every catalog also answers on its short top-level path, so GET /v1/charge-codes and GET /v1/reference-data/charge-codes are the same endpoint. The documented /reference-data/* form is canonical — it keeps the catalogs grouped here as more are added (port codes, cities, zip codes) — and the short form is a convenience alias.

Operations

List equipment

Request

Read-only catalog of equipment types. The ids are what order and load equipment arrays reference. The list is system-managed and small — fetch it once and cache it, or hardcode the ids your integration uses.

The catalog is global and organization-independent: every authenticated organization sees the same rows.

Security
BearerAuth
Query
categoryIdstring(uuid)

Only return equipment in this category

groupIdstring(uuid)

Only return equipment in this top-level group

subcategoryIdstring(uuid)

Only return equipment in this subcategory

curl -i -X GET \
  'https://api.mvmnt.io/v1/reference-data/equipment?categoryId=497f6eca-6276-4993-bfeb-53cbbbba6f08&groupId=497f6eca-6276-4993-bfeb-53cbbbba6f08&subcategoryId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
dataArray of objects(Equipment)required
idstring(uuid)required

Equipment id (referenced by order/load equipment arrays)

namestringrequired

Display name (e.g., "Van 53'")

Example: "Van 53'"
categoryEquipmentCategory (object) or null

Equipment category

One of:

Equipment category

groupEquipmentGroup (object) or null

Top-level equipment group

One of:

Top-level equipment group

subcategoryEquipmentSubcategory (object) or null

Equipment subcategory

One of:

Equipment subcategory

Response
application/json
{
  "data": [
    { … }
  ]
}

List charge codes

Request

Read-only catalog of charge codes. The integer ids are what charge chargeCodeId fields reference. The list is system-managed — fetch it once and cache it.

The catalog is global and organization-independent: every authenticated organization sees the same rows.

Security
BearerAuth
Query
codestring

Only return the charge code with this exact accounting code

Example: code=LH
curl -i -X GET \
  'https://api.mvmnt.io/v1/reference-data/charge-codes?code=LH' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
dataArray of objects(ChargeCode)required
idintegerrequired

Charge code id (referenced by charge chargeCodeId fields)

Example: 1
codestringrequired

Short accounting code

Example: "LH"
namestringrequired

Display name

Example: "Linehaul"
descriptionstringrequired

Full description

Example: "Linehaul charges"
Response
application/json
{
  "data": [
    { … }
  ]
}

List special requirements

Request

Read-only catalog of special requirements (equipment accessories, driver services, freight handling, location constraints). The ids are what order and load specialRequirements arrays reference. Filter by type to get one category.

The catalog is global and organization-independent: every authenticated organization sees the same rows.

Security
BearerAuth
Query
typestring(SpecialRequirementType)

Only return requirements of this type

Enum"EQUIPMENT""DRIVER""FREIGHT""SHIPPER_LOCATION"
curl -i -X GET \
  'https://api.mvmnt.io/v1/reference-data/special-requirements?type=EQUIPMENT' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
dataArray of objects(SpecialRequirement)required
idstring(uuid)required

Special-requirement id (referenced by order/load specialRequirements arrays)

namestringrequired

Display name (e.g., "Tarps")

Example: "Tarps"
typestring(SpecialRequirementType)required

What the requirement applies to.

  • EQUIPMENT: Equipment accessories (e.g., tarps, straps)
  • DRIVER: Driver services (e.g., team service, TWIC)
  • FREIGHT: Freight handling characteristics
  • SHIPPER_LOCATION: Location constraints
Enum"EQUIPMENT""DRIVER""FREIGHT""SHIPPER_LOCATION"
Response
application/json
{
  "data": [
    { … }
  ]
}

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