Shipments

Search shipments

Changed on Oct 7, 2026

Search shipments using OpenSearch-powered full-text and field-specific search.

This endpoint provides fast, indexed search across shipment data with support for:

Full-text search across multiple fields (references, locations, parties)
Field-specific filtering with various operators
Sorting and pagination
Saved search preferences

Note: Only active (non-deleted) shipments are searchable. Soft-deleted records are automatically excluded from all search results.

Response Formats:

flat (default): Returns indexed fields only for faster performance
full: Returns complete shipment objects with all relationships

post/shipments/search

Request

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

Request body

format'flat' | 'full'

Response format:

flat: Returns only indexed fields (default, faster)
full: Returns complete shipment objects

Example request

{
  "criteria": {
    "id": {
      "operator": "EQUALS",
      "values": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "friendlyId": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "status": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "orderStatus": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "loadStatuses": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "mode": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "tonu": {
      "operator": "TRUE"
    },
    "pickUp": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "pickUpCity": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "pickUpState": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "pickUpZipCode": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "pickUpCountry": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "dropOff": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "dropOffCity": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "dropOffState": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "dropOffZipCode": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "dropOffCountry": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "pickUpStartDatetime": {
      "operator": "AFTER",
      "value": "2025-01-01T00:00:00Z"
    },
    "dropOffStartDatetime": {
      "operator": "AFTER",
      "value": "2025-01-01T00:00:00Z"
    },
    "bookedAt": {
      "operator": "AFTER",
      "value": "2025-01-01T00:00:00Z"
    },
    "shipperId": {
      "operator": "EQUALS",
      "values": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "shipperName": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "carrierIds": {
      "operator": "EQUALS",
      "values": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "carrierNames": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "primaryRepId": {
      "operator": "EQUALS",
      "values": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "primaryRepName": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "bookingRepIds": {
      "operator": "EQUALS",
      "values": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "bookingRepNames": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "groupId": {
      "operator": "EQUALS",
      "values": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "groupName": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "equipmentType": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "weight": {
      "operator": "GREATER_THAN",
      "value": 1000.5
    },
    "totalMiles": {
      "operator": "GREATER_THAN",
      "value": 1000.5
    },
    "revenue": {
      "operator": "GREATER_THAN",
      "value": 1000.5
    },
    "cost": {
      "operator": "GREATER_THAN",
      "value": 1000.5
    },
    "profit": {
      "operator": "GREATER_THAN",
      "value": 1000.5
    },
    "profitMargin": {
      "operator": "GREATER_THAN",
      "value": 1000.5
    },
    "referenceValues": {
      "operator": "INCLUDES",
      "values": [
        "search term"
      ]
    },
    "customerRef": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "bol": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "po": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "quoteId": {
      "operator": "EQUALS",
      "values": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "quoteFriendlyId": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "arInvoiceId": {
      "operator": "EQUALS",
      "values": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "arInvoiceFriendlyId": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "apInvoiceIds": {
      "operator": "EQUALS",
      "values": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    },
    "apInvoiceFriendlyIds": {
      "operator": "ONE_OF",
      "values": [
        "ACTIVE",
        "PENDING"
      ]
    },
    "createdAt": {
      "operator": "AFTER",
      "value": "2025-01-01T00:00:00Z"
    },
    "orderCreatedAt": {
      "operator": "AFTER",
      "value": "2025-01-01T00:00:00Z"
    }
  },
  "pagination": {
    "pageNumber": 1,
    "pageSize": 50
  },
  "sort": [
    {
      "field": "createdAt",
      "order": "desc"
    }
  ],
  "savedSearch": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Response

Successful search results

totalResultsinteger required

Total number of matching results

Example response

{
  "data": [
    {
      "friendlyId": "SHP-0001"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalPages": 25
  }
}

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
- warning
  added the new DROP enum value to the ////////// response property for the response status
- warning
  added the new PICK enum value to the ////////// response property for the response status
- 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
  removed the DELIVERY enum value from the ////////// response property for the response status
- info
  removed the PICKUP enum value from the ////////// response property for the response 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
Oct 1, 202666fb538125ab Revision changes
- 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 optional property ////////// to the response with the status

Operation history (6 revisions)