Shipments

Get tracking link

Changed on

Search for shipments by friendly ID (e.g. L-004167) or reference field values (BOL #, PRO #, MAWB #, etc.) and return tracking information.

Usage

  1. Provide an array of search queries in the searches field
  2. Optionally filter which reference field types to search using referenceFields
  3. Results are returned in the same order as input searches
  4. If no match is found, the result contains only the original query (other fields are null)

Matching Behavior

  • Searches are case-insensitive
  • If multiple shipments match a query, the most recently created shipment is returned
  • If referenceFields is omitted, all reference field types and the shipment friendly ID are searched; a friendly ID match has no field

Example Use Cases

  • Customer portal: Look up shipment status by BOL or PRO number
  • EDI integration: Validate shipment references before sending updates
  • Bulk status check: Query multiple shipments in a single request

Rate Limits

  • Maximum 100 searches per request
  • Standard API rate limits apply (see Rate Limiting documentation)
post/shipments/track

Request

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

Request body

referenceFieldsShipmentReferenceField[]

Optional filter for reference field types to search. If omitted, searches all reference field types.

Common use: limit search to specific field types for faster results or to avoid false matches across different reference types.

Example request

{
  "searches": [
    {
      "query": "MAWB123456"
    },
    {
      "query": "BOL789"
    }
  ],
  "referenceFields": [
    "MASTER_AIRWAYBILL_NUMBER",
    "BOL_NUMBER"
  ]
}

Response

Track results returned successfully

Example response

{
  "results": [
    {
      "query": "MAWB123456",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "SHIP-001",
      "friendlyId": "SHP-12345",
      "status": "IN_TRANSIT",
      "field": "MASTER_AIRWAYBILL_NUMBER",
      "value": "MAWB123456",
      "origin": "Los Angeles, CA 90210",
      "destination": "New York, NY 10001",
      "pickUpDate": "2025-01-15",
      "deliveryDate": "2025-01-20",
      "trackingUrl": "https://app.mvmnt.io/shipments/550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "query": "NOTFOUND123",
      "id": null,
      "key": null,
      "friendlyId": null,
      "status": null,
      "field": null,
      "value": null,
      "origin": null,
      "destination": null,
      "pickUpDate": null,
      "deliveryDate": null,
      "trackingUrl": null
    }
  ]
}

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

    • warning

      added the new BOOKING_NUMBER enum value to the ////// response property for the response status

    • warning

      added the new CONSOLIDATED enum value to the ////// response property for the response status

    • warning

      added the new INTERNAL_ID enum value to the ////// response property for the response status

    • warning

      added the new LOT_NUMBER enum value to the ////// response property for the response status

    • warning

      added the new PAPS_NUMBER enum value to the ////// response property for the response status

    • warning

      added the new PARS_NUMBER enum value to the ////// response property for the response status

    • warning

      added the new QUOTE_NUMBER enum value to the ////// response property for the response status

    • info

      added the new BOOKING_NUMBER enum value to the request property /

    • info

      added the new INTERNAL_ID enum value to the request property /

    • info

      added the new LOT_NUMBER enum value to the request property /

    • info

      added the new PAPS_NUMBER enum value to the request property /

    • info

      added the new PARS_NUMBER enum value to the request property /

    • info

      added the new QUOTE_NUMBER enum value to the request property /

    • info

      added the optional property // to the response with the status