Filter stops

Changed on Oct 7, 2026

Search for stops using filter criteria.

Common Filters

By location: { "filter": { "shipperLocationId": { "equalTo": "uuid" } } }
By postal code: { "filter": { "postalCode": { "equalTo": "60601" } } }
Recently updated: { "filter": { "updatedAt": { "greaterThan": "2025-01-01T00:00:00Z" } } }

To list the stops of one shipment, read the shipment instead: its orders carry them in route order, which a filter cannot express.

post/stops/filter

Request

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

Request body

pageSizeinteger

cursorstring

Response

Stops matching filter criteria

Example response

{
  "data": [
    {
      "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
      }
    }
  ],
  "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
  endpoint added

Operation history