Carrier management operations
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.
OAuth 2.0 client credentials flow. See Authentication Guide for details.
Headers:
Content-Type: application/x-www-form-urlencodedBody Parameters:
grant_type=client_credentials
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRETcurl -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"Status: 200 OK
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600
}Response Fields:
access_token: JWT Bearer token to use for API requeststoken_type: AlwaysBearerexpires_in: Token lifetime in seconds (3600 = 1 hour)
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
Overview
Languages
Servers
Production
https://api.mvmnt.io/v1
Demo (non-production)
https://api.demo.mvmnt.io/v1
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
Request
Search across multiple entity types simultaneously (shipments, customers, carriers, users, vendors).
Use Cases:
- Unified search bar for finding any type of record
- Quick lookup by name, ID, or reference number
- Cross-entity discovery
Search Behavior:
- Searches across default searchable fields for each entity type
- Results are sorted by object type priority: SHIPMENT → CUSTOMER → CARRIER → USER → VENDOR
- Within each object type, results are sorted by most recently updated
Prefix Filtering: Use "type:query" syntax to search specific object types:
carrier:acme- searches only carriersshipment:12345- searches only shipmentscustomer:west- searches only customers
IMPORTANT: Eventually Consistent This endpoint queries OpenSearch indices which are updated asynchronously. Changes typically appear within 2 seconds, but this is not guaranteed.
Security
BearerAuth
Search query string. Searches across default searchable fields for each entity type.
Supports prefix filtering using "type:query" syntax:
carrier:acme- searches only carriers for "acme"shipment:12345- searches only shipments for "12345"user:john- searches only users for "john"
Example: "acme corp"
Optional filter to limit search to specific object types. If not provided, searches across all object types.
Items Enum"SHIPMENT""CUSTOMER""CARRIER""USER""VENDOR"
Example: ["SHIPMENT","CUSTOMER"]
- Productionhttps://api.mvmnt.io/v1/global-search
- Demo (non-production)https://api.demo.mvmnt.io/v1/global-search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mvmnt.io/v1/global-search \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"query": "acme"
}'Search results
Search results sorted by object type priority: SHIPMENT → CUSTOMER → CARRIER → USER → VENDOR
Object types available for global search:
SHIPMENT: Shipment recordsCUSTOMER: Customer/shipper profilesCARRIER: Carrier profilesUSER: User accountsVENDOR: Vendor profiles
Enum"SHIPMENT""CUSTOMER""CARRIER""USER""VENDOR"
Client-defined reference identifier if set
Example: "ERP-CUST-12345"
Internal entity type name (for backwards compatibility). Prefer using the object field instead.
Example: "SHIPPER_PROFILE"
Primary display text for the result (e.g., name, friendlyId)
Example: "Acme Corporation"
Pagination information for search results
Response
application/json
{ "data": [ { … }, { … } ], "pagination": { "pageNumber": 1, "pageSize": 20, "totalPages": 3 }, "totalResults": 42 }