Skip to content
API Reference/
/
Create a new location con...

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

Filter location contacts

Request

Query location contacts using flexible filter criteria with AND/OR logic.

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

Security
BearerAuth
Bodyapplication/jsonrequired
filterobject(LocationContactFilter)

Filter criteria (optional - omit to return all location contacts).

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

Example: {"and":[{"locationId":{"equalTo":"770e8400-e29b-41d4-a716-446655440000"}},{"isPrimary":{"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://api.mvmnt.io/v1/location-contacts/filter \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "and": [
        {
          "locationId": {
            "equalTo": "770e8400-e29b-41d4-a716-446655440000"
          }
        },
        {
          "isPrimary": {
            "equalTo": true
          }
        }
      ]
    },
    "pageSize": 50
  }'

Responses

Filtered location contacts with pagination

Bodyapplication/json
dataArray of objects(LocationContact)required
objectstringread-only

Object type identifier

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

Unique location contact identifier

Example: "880e8400-e29b-41d4-a716-446655440000"
locationIdstring(uuid)required

Location this contact is associated with

Example: "770e8400-e29b-41d4-a716-446655440000"
locationobject(Location)read-only

The location this contact is associated with

customerContactIdstring(uuid)required

Customer contact linked to this location

Example: "660e8400-e29b-41d4-a716-446655440000"
customerContactobject(CustomerContact)read-only

The customer contact details

isPrimarybooleanrequired

Whether this is the primary contact for the location

Example: true
contactTypesArray of strings(LocationContactType)

Roles/types for this location contact

Items Enum"ACCOUNT_MANAGER""BILLING""DOCK_SHIPPING""EMERGENCY""LOCATION_MANAGER""OWNER""PROCUREMENT""PURCHASING""RATES_PRICING""RECEIVING"
Example: ["LOCATION_MANAGER","SHIPPING"]
keystring or null<= 512 characters

Client-defined reference identifier for this location contact

Example: "ERP-LOC-CONTACT-001"
createdAtstring(date-time)read-onlyrequired

Timestamp when location contact was created

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

Timestamp when location contact was last updated

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

Timestamp when location contact was soft-deleted (null if active)

Example: null
pageInfoobject(PaginationInfo)required
pageSizeintegerrequired

Number of items per page

Example: 50
hasNextPagebooleanrequired

Whether there are more pages

Example: true
hasPreviousPageboolean

Whether there are previous pages

Example: false
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 location contact

Request

Link a customer contact to a location with specific contact types/roles.

Location contacts represent the relationship between a customer contact and a specific location, defining what role the contact has at that location.

Security
BearerAuth
Bodyapplication/jsonrequired
locationIdstring(uuid)required

Location this contact is associated with (required)

Example: "770e8400-e29b-41d4-a716-446655440000"
customerContactIdstring(uuid)required

Customer contact to link to this location (required)

Example: "660e8400-e29b-41d4-a716-446655440000"
isPrimarybooleanrequired

Whether this is the primary contact for the location (required)

Example: true
contactTypesArray of strings(LocationContactType)

Roles/types for this location contact

Items Enum"ACCOUNT_MANAGER""BILLING""DOCK_SHIPPING""EMERGENCY""LOCATION_MANAGER""OWNER""PROCUREMENT""PURCHASING""RATES_PRICING""RECEIVING"
Example: ["LOCATION_MANAGER","SHIPPING"]
keystring<= 512 characters

Client-defined reference identifier

Example: "ERP-LOC-CONTACT-001"
curl -i -X POST \
  https://api.mvmnt.io/v1/location-contacts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "locationId": "770e8400-e29b-41d4-a716-446655440000",
    "customerContactId": "660e8400-e29b-41d4-a716-446655440000",
    "isPrimary": true,
    "contactTypes": [
      "LOCATION_MANAGER",
      "SHIPPING"
    ],
    "key": "ERP-LOC-CONTACT-001"
  }'

Responses

Location contact created successfully

Bodyapplication/json
objectstringread-only

Object type identifier

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

Unique location contact identifier

Example: "880e8400-e29b-41d4-a716-446655440000"
locationIdstring(uuid)required

Location this contact is associated with

Example: "770e8400-e29b-41d4-a716-446655440000"
locationobject(Location)read-only

The location this contact is associated with

customerContactIdstring(uuid)required

Customer contact linked to this location

Example: "660e8400-e29b-41d4-a716-446655440000"
customerContactobject(CustomerContact)read-only

The customer contact details

isPrimarybooleanrequired

Whether this is the primary contact for the location

Example: true
contactTypesArray of strings(LocationContactType)

Roles/types for this location contact

Items Enum"ACCOUNT_MANAGER""BILLING""DOCK_SHIPPING""EMERGENCY""LOCATION_MANAGER""OWNER""PROCUREMENT""PURCHASING""RATES_PRICING""RECEIVING"
Example: ["LOCATION_MANAGER","SHIPPING"]
keystring or null<= 512 characters

Client-defined reference identifier for this location contact

Example: "ERP-LOC-CONTACT-001"
createdAtstring(date-time)read-onlyrequired

Timestamp when location contact was created

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

Timestamp when location contact was last updated

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

Timestamp when location contact was soft-deleted (null if active)

Example: null
Response
application/json
{
  "object": "LOCATION_CONTACT",
  "id": "880e8400-e29b-41d4-a716-446655440000",
  "locationId": "770e8400-e29b-41d4-a716-446655440000",
  "location": {
    "object": "LOCATION",
    "id": "770e8400-e29b-41d4-a716-446655440000",
    "customerId": "550e8400-e29b-41d4-a716-446655440000",
    "customer": { … },
    "address": { … },
    "name": "ABC Warehouse - Dallas",
    "key": "ERP-LOC-DALLAS-01",
    "type": "SHIPPER",
    "isAppointmentRequired": true,
    "notes": "Call 24 hours ahead for appointment",
    "internalNotes": "Use dock door 5 for expedited shipments",
    "contacts": [ … ],
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "customerContactId": "660e8400-e29b-41d4-a716-446655440000",
  "customerContact": {
    "object": "CUSTOMER_CONTACT",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "customer": { … },
    "name": "John Smith",
    "contactInfo": { … },
    "phoneExtension": "1234",
    "isPrimary": true,
    "contactTypes": [ … ],
    "notifications": [ … ],
    "invitedUser": { … },
    "deletedBy": { … },
    "key": "ERP-CONTACT-JOHN-001",
    "createdAt": "2025-01-15T10:00:00Z",
    "deletedAt": null
  },
  "isPrimary": true,
  "contactTypes": [
    "LOCATION_MANAGER",
    "SHIPPING"
  ],
  "key": "ERP-LOC-CONTACT-001",
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Get a location contact by ID

Request

Retrieve a single location contact by its unique identifier.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X GET \
  https://api.mvmnt.io/v1/location-contacts/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Location contact found

Bodyapplication/json
objectstringread-only

Object type identifier

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

Unique location contact identifier

Example: "880e8400-e29b-41d4-a716-446655440000"
locationIdstring(uuid)required

Location this contact is associated with

Example: "770e8400-e29b-41d4-a716-446655440000"
locationobject(Location)read-only

The location this contact is associated with

customerContactIdstring(uuid)required

Customer contact linked to this location

Example: "660e8400-e29b-41d4-a716-446655440000"
customerContactobject(CustomerContact)read-only

The customer contact details

isPrimarybooleanrequired

Whether this is the primary contact for the location

Example: true
contactTypesArray of strings(LocationContactType)

Roles/types for this location contact

Items Enum"ACCOUNT_MANAGER""BILLING""DOCK_SHIPPING""EMERGENCY""LOCATION_MANAGER""OWNER""PROCUREMENT""PURCHASING""RATES_PRICING""RECEIVING"
Example: ["LOCATION_MANAGER","SHIPPING"]
keystring or null<= 512 characters

Client-defined reference identifier for this location contact

Example: "ERP-LOC-CONTACT-001"
createdAtstring(date-time)read-onlyrequired

Timestamp when location contact was created

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

Timestamp when location contact was last updated

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

Timestamp when location contact was soft-deleted (null if active)

Example: null
Response
application/json
{
  "object": "LOCATION_CONTACT",
  "id": "880e8400-e29b-41d4-a716-446655440000",
  "locationId": "770e8400-e29b-41d4-a716-446655440000",
  "location": {
    "object": "LOCATION",
    "id": "770e8400-e29b-41d4-a716-446655440000",
    "customerId": "550e8400-e29b-41d4-a716-446655440000",
    "customer": { … },
    "address": { … },
    "name": "ABC Warehouse - Dallas",
    "key": "ERP-LOC-DALLAS-01",
    "type": "SHIPPER",
    "isAppointmentRequired": true,
    "notes": "Call 24 hours ahead for appointment",
    "internalNotes": "Use dock door 5 for expedited shipments",
    "contacts": [ … ],
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "customerContactId": "660e8400-e29b-41d4-a716-446655440000",
  "customerContact": {
    "object": "CUSTOMER_CONTACT",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "customer": { … },
    "name": "John Smith",
    "contactInfo": { … },
    "phoneExtension": "1234",
    "isPrimary": true,
    "contactTypes": [ … ],
    "notifications": [ … ],
    "invitedUser": { … },
    "deletedBy": { … },
    "key": "ERP-CONTACT-JOHN-001",
    "createdAt": "2025-01-15T10:00:00Z",
    "deletedAt": null
  },
  "isPrimary": true,
  "contactTypes": [
    "LOCATION_MANAGER",
    "SHIPPING"
  ],
  "key": "ERP-LOC-CONTACT-001",
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Update a location contact

Request

Partially update a location contact. 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
Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Bodyapplication/jsonrequired
locationIdstring(uuid)

Location this contact is associated with

Example: "770e8400-e29b-41d4-a716-446655440000"
customerContactIdstring(uuid)

Customer contact linked to this location

Example: "660e8400-e29b-41d4-a716-446655440000"
isPrimaryboolean

Whether this is the primary contact for the location

Example: true
contactTypesArray of strings(LocationContactType)

Roles/types for this location contact

Items Enum"ACCOUNT_MANAGER""BILLING""DOCK_SHIPPING""EMERGENCY""LOCATION_MANAGER""OWNER""PROCUREMENT""PURCHASING""RATES_PRICING""RECEIVING"
Example: ["LOCATION_MANAGER","SHIPPING"]
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-LOC-CONTACT-001"
curl -i -X PATCH \
  https://api.mvmnt.io/v1/location-contacts/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contactTypes": [
      "LOCATION_MANAGER",
      "SHIPPING",
      "RECEIVING"
    ]
  }'

Responses

Location contact updated successfully

Bodyapplication/json
objectstringread-only

Object type identifier

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

Unique location contact identifier

Example: "880e8400-e29b-41d4-a716-446655440000"
locationIdstring(uuid)required

Location this contact is associated with

Example: "770e8400-e29b-41d4-a716-446655440000"
locationobject(Location)read-only

The location this contact is associated with

customerContactIdstring(uuid)required

Customer contact linked to this location

Example: "660e8400-e29b-41d4-a716-446655440000"
customerContactobject(CustomerContact)read-only

The customer contact details

isPrimarybooleanrequired

Whether this is the primary contact for the location

Example: true
contactTypesArray of strings(LocationContactType)

Roles/types for this location contact

Items Enum"ACCOUNT_MANAGER""BILLING""DOCK_SHIPPING""EMERGENCY""LOCATION_MANAGER""OWNER""PROCUREMENT""PURCHASING""RATES_PRICING""RECEIVING"
Example: ["LOCATION_MANAGER","SHIPPING"]
keystring or null<= 512 characters

Client-defined reference identifier for this location contact

Example: "ERP-LOC-CONTACT-001"
createdAtstring(date-time)read-onlyrequired

Timestamp when location contact was created

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

Timestamp when location contact was last updated

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

Timestamp when location contact was soft-deleted (null if active)

Example: null
Response
application/json
{
  "object": "LOCATION_CONTACT",
  "id": "880e8400-e29b-41d4-a716-446655440000",
  "locationId": "770e8400-e29b-41d4-a716-446655440000",
  "location": {
    "object": "LOCATION",
    "id": "770e8400-e29b-41d4-a716-446655440000",
    "customerId": "550e8400-e29b-41d4-a716-446655440000",
    "customer": { … },
    "address": { … },
    "name": "ABC Warehouse - Dallas",
    "key": "ERP-LOC-DALLAS-01",
    "type": "SHIPPER",
    "isAppointmentRequired": true,
    "notes": "Call 24 hours ahead for appointment",
    "internalNotes": "Use dock door 5 for expedited shipments",
    "contacts": [ … ],
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "customerContactId": "660e8400-e29b-41d4-a716-446655440000",
  "customerContact": {
    "object": "CUSTOMER_CONTACT",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "customer": { … },
    "name": "John Smith",
    "contactInfo": { … },
    "phoneExtension": "1234",
    "isPrimary": true,
    "contactTypes": [ … ],
    "notifications": [ … ],
    "invitedUser": { … },
    "deletedBy": { … },
    "key": "ERP-CONTACT-JOHN-001",
    "createdAt": "2025-01-15T10:00:00Z",
    "deletedAt": null
  },
  "isPrimary": true,
  "contactTypes": [
    "LOCATION_MANAGER",
    "SHIPPING"
  ],
  "key": "ERP-LOC-CONTACT-001",
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Delete a location contact

Request

Soft delete a location contact (sets deletedAt timestamp).

The location contact 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://api.mvmnt.io/v1/location-contacts/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Location contact deleted successfully

Response
No content

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

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