Search globally

Changed on Oct 7, 2026

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 carriers
shipment:12345 - searches only shipments
customer: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.

post/global-search

Request

Base URL: https://api.mvmnt.io/v1
URL: https://api.mvmnt.io/v1/global-search
Auth: HTTP bearer

Request body

querystring required

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"

objectsGlobalSearchObjectType[]

Optional filter to limit search to specific object types. If not provided, searches across all object types.

Example request

{
  "query": "acme corp",
  "objects": [
    "SHIPMENT",
    "CUSTOMER"
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 50
  }
}

Response

Search results

totalResultsinteger required

Total number of matching results across all object types

Example response

{
  "data": [
    {
      "key": "ERP-CUST-12345",
      "entityName": "SHIPPER_PROFILE",
      "title": "Acme Corporation",
      "subtitle": "CUST-12345",
      "field": "Name",
      "highlight": "<em>Acme</em> Corporation"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalPages": 25
  },
  "totalResults": 42
}

Changes

Oct 7, 20262cd6ecfbeb82 Revision changes
- breaking
  the response's body type changed from object to no type for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  the optional response header X-RateLimit-Reset removed for the status 429
- info
  added subschema #2 to the response body allOf list for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history