Shipments

Filter shipments

Changed on Oct 7, 2026

Search for shipments using filter criteria.

Each row in the response carries the fully nested shipment payload (orders with stops, freight, references, charges; loads with carriers). With a large pageSize, responses can be sizable — use a smaller page size if you only need scalar fields.

Common Filters

Active shipments: { "filter": { "status": { "notIn": ["DELIVERED", "CANCELED"] } } }
Delivered today: { "filter": { "deliveredAt": { "greaterThanOrEqualTo": "2025-01-15T00:00:00Z" } } }
By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }

post/shipments/filter

Request

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

Request body

pageSizeinteger

cursorstring

Response

Shipments matching filter criteria

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "friendlyId": "SHP-12345",
      "key": "my-shipment-001",
      "customer": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-CUSTOMER-ACME",
        "name": "Acme Manufacturing Corp",
        "friendlyId": "A123456",
        "status": "ACTIVE",
        "phoneNumber": "+1-555-123-4567",
        "website": "https://acme-manufacturing.com",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "customerRep": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone": "+1-555-123-4567",
        "phoneExt": "123",
        "status": "ACTIVE",
        "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "orders": [
        {
          "stops": [
            {
              "location": {
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "key": "ERP-USER-12345"
              },
              "address": {
                "line1": "123 Main St",
                "line2": "Suite 400",
                "city": "Chicago",
                "state": "IL",
                "zipCode": "60601",
                "country": "USA",
                "market": "CHI",
                "latitude": "41.8781",
                "longitude": "-87.6298",
                "isSmartyValidated": true,
                "obeysDst": true
              }
            }
          ]
        }
      ],
      "loads": [
        {
          "carriers": [
            {
              "carrier": {
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "key": "ERP-CARRIER-SWIFT",
                "name": "Swift Transportation",
                "phoneNumber": "+1-555-987-6543",
                "email": "dispatch@swifttrans.com",
                "createdAt": "2025-01-15T10:00:00Z",
                "updatedAt": "2025-01-15T14:30:00Z"
              }
            }
          ]
        }
      ],
      "services": [
        {
          "vendor": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-VENDOR-ABC-001",
            "friendlyId": "V123456",
            "name": "ABC Warehouse Services",
            "email": "billing@abcwarehouse.com",
            "phone": "+1-555-123-4567",
            "status": "ACTIVE",
            "currency": "USD",
            "createdAt": "2025-01-15T10:00:00Z",
            "updatedAt": "2025-01-15T14:30:00Z"
          }
        }
      ]
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  },
  "errors": [
    {
      "field": "/required",
      "message": "missing property 'status'"
    }
  ]
}

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
- 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
  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
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)