Stops

Get a stop

Changed on
get/stops/{id}

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/stops/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Stop ID

Response

Stop details

idstring uuid required
type'PICK' | 'DROP' required

Whether freight is collected (PICK) or delivered (DROP) at this stop.

sequenceinteger required

Position in the route, starting at 1.

postalCodestring nullable
airportCodestring nullable
requestedStartDatestring date nullable
requestedEndDatestring date nullable
requestedStartTimestring nullable
requestedEndTimestring nullable
actualArrivalstring date-time nullable
actualDeparturestring date-time nullable
dropTrailerboolean

Whether the carrier drops the trailer rather than waiting.

notesstring nullable

Instructions shown to the carrier.

createdAtstring date-time required
updatedAtstring date-time nullable

Example response

{
  "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
  }
}

Changes

  • 2cd6ecfbeb82Revision changes
    • 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

      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

      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

  • 66fb538125abRevision changes
    • info

      endpoint added