How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MVMNT Locations API

Location management operations

MVMNT Locations API is one of 27 APIs that MVMNT publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Locations. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 6 operations across 4 paths, and defines 53 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.mvmnt.io/v1.

6 operations 4 paths 53 schemas 1 DELETE1 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.mvmnt.io/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

MVMNT Locations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — OAuth 2.0 access token obtained via client credentials flow

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Locations 6

Location management operations

POST
/locations/filter
Filter locations
filterLocations body → 200400401500
POST
/locations
Create a new location
createLocation body → 201400401409500
GET
/locations/{id}
Get a location by ID
getLocationById 1 param → 200400401404500
PATCH
/locations/{id}
Update a location
updateLocation 1 param body → 200400401404409500
DELETE
/locations/{id}
Delete a location
deleteLocation 1 param → 204400401404500
POST
/locations/search
Search locations
searchLocations body → 200400401422429

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are Customer (50 properties), LocationSearchRow (21 properties), LocationSearchCriteria (19 properties), CustomerContact (14 properties). Each schema is shown below with its type and property counts.

CustomerTransportationMode
string
Transportation mode type
ContactInfo
object
Contact information details (nested, without id). This is an embedded object representing a Contact record. The id is managed internally and not exposed in the…
4 properties 1 required
LocationSearchRow
object
Flattened location data from search index. Note: This represents only active locations. Soft-deleted records are never returned.
21 properties 6 required
ShowNotes
string
Controls whether external notes are shown on all documents or split from carrier-facing notes. - ALL: Use external notes on customer-facing and carrier-facing…
CustomerAnnualSpend
string
Annual freight spend estimate range
CustomerServiceTier
string
Service tier level for the customer
DatetimeSearchCriteria
object
Search criteria for datetime fields. Supports both absolute datetime values and relative time expressions.
10 properties 1 required
TextSearchCriteria
object
Search criteria for text fields (supports wildcards and partial matching)
2 properties 1 required
ValidationError
object
3 properties 3 required
Address
object
Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed…
12 properties 8 required
Error
object
2 properties 2 required
LocationFilterRequest
object
Request body for filtering locations
3 properties
KeywordSearchCriteria
object
Search criteria for keyword fields (exact match, no partial matching)
2 properties 1 required
ClientKeyFilter
object
Filter options for client key fields (limited operations - exact match only)
3 properties
SearchPaginationInput
object
Pagination options for search requests
2 properties
BooleanFilter
object
Filter options for boolean fields
3 properties
CustomerCurrency
string
Preferred currency for transactions
IntSearchCriteria
object
Search criteria for integer fields
4 properties 1 required
BooleanSearchCriteria
object
Search criteria for boolean fields
1 property 1 required
PaginationInfo
object
4 properties 2 required
CustomerAnnualRevenue
string
Annual revenue range
Location
object
14 properties 6 required
Customer
object
50 properties 6 required
PaymentTermReference
object
Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
11 properties 4 required
LocationInput
object
7 properties 3 required
CustomerContactType
string
Type of customer contact role
LocationSearchRequest
object
Request body for searching locations
5 properties
CustomerSpendType
string
Customer spend type: - CONTRACT: Customer operates under contract pricing - SPOT: Customer operates on spot market pricing
UUIDSearchCriteria
object
Search criteria for UUID fields
2 properties 1 required
RelativeTimeUnit
string
Time unit for relative time calculations: - YEAR: Years - MONTH: Months - WEEK: Weeks - DAY: Days - HOUR: Hours - MINUTE: Minutes - SECOND: Seconds
LocationSearchResponse
object
Response for location search requests. Note: Only active (non-deleted) locations are included in results.
3 properties 3 required
CustomerStatus
string
Customer account status (includes lead stages): - NEW: New lead, not yet contacted - CONTACTED: Initial contact made with lead - QUALIFIED: Lead has been quali…
SearchPaginationInfo
object
Pagination information for search results
3 properties 3 required
LocationContactType
string
Type of location contact role
CustomerReference
object
Enhanced reference to a customer resource (returned in responses). Includes full customer details in addition to id/key. Note: Does NOT include nested referenc…
10 properties 6 required
LocationType
string
The type of location: - SHIPPER: Pickup location only - RECEIVER: Delivery location only - BOTH: Can be used for both pickup and delivery
CustomerContactReference
object
Customer contact reference for embedding in Customer responses. Identical to CustomerContact but excludes the customer and customerId fields to avoid circular…
13 properties 5 required
UserReference
object
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (team…
11 properties 5 required
CustomerNumberOfEmployees
string
Number of employees in the company
IDFilter
object
Filter options for ID fields (limited operations - exact match only)
2 properties
DatetimeFilter
object
Filter options for datetime fields
7 properties
ResourceReference
object
Reference to another resource (returned in responses)
2 properties 1 required
StringFilter
object
Filter options for string fields
11 properties
CustomerContact
object
14 properties 6 required
SearchSortOption
object
Sort option for search results
2 properties 2 required
SavedSearchLookup
object
Reference to a saved search by ID or client key. Provide either id or key (not both).
2 properties
LocationSearchCriteria
object
Search criteria for filtering locations (shipper/receiver locations). Note: Only active (non-deleted) locations are searchable. Soft-deleted records are automa…
19 properties
LocationPatch
object
Partial location update. All fields are optional. - Omitted fields: Not modified (current value preserved) - Provided fields: Updated to the new value - Null v…
7 properties
LocationFilter
object
Filter criteria for locations with AND/OR logic support
14 properties
CustomerIndustry
string
Industry classification for the customer
CustomerDeactivationReason
string
Reason for customer deactivation: - NOTPAYINGINVOICE: Customer is not paying invoices - ACQUIRED: Customer was acquired by another company - DUPLICATE: Duplica…
LocationContactReference
object
Location contact reference for embedding in Location responses. Identical to LocationContact but excludes the location and locationId fields to avoid circular…
10 properties 5 required
CustomerContactNotificationType
string
Types of shipment notifications the contact should receive

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mvmnt-locations-api-openapi.yml Raw ↑

Other APIs MVMNT publishes across the network.

MVMNT Bill Payments API
MVMNT Bills API
MVMNT Carrier Contacts API
MVMNT Carrier Factors API
MVMNT Carrier Payment Methods API
MVMNT Carriers API
MVMNT Companies API
MVMNT Credit Memos API
MVMNT Customer Contacts API
MVMNT Customers API
MVMNT Documents API
MVMNT Invoices API
Where this information came from

This is an independent, third-party profile of MVMNT Locations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.