Stops

Create a stop on an order.

A stop is placed exactly one way — by location, postalCode, cityId or airportCode. Only a location carries a street address; the other three exist because freight is routinely tendered before an address is known.

What happens

  • The stop is created and attached to the order
  • sequence decides where it falls in the route

Note

Stops are normally created with their shipment. Use this endpoint to add one to an order that already exists.

post/stops

Request

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

Request body

orderIdstring uuid required

The order this stop belongs to

Response

Stop created successfully

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

    • 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

      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 the new DROP enum value to the request property /

    • info

      added the new PICK enum value to the request property /

    • 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

    • info

      endpoint added