Sign in
latestOpenAPI 3.0.02026-08-08163663.9 KB

4aa7f4326443

Carrier

Updates an existing appointment with a new status, start time, and/or end time. Requires the client to send at least one of new `windowStart` time, new `windowEnd` time, or `appointmentConfirmed`.

post/shipments/appointment

Request body

shipmentReferencestring
stopIdstring
windowStartstring date-time
windowEndstring date-time
appointmentConfirmedboolean

Example request

{
  "shipmentReference": "61f468826a139d5cfe58f0a2",
  "stopId": "61f468806a139d5cfe58f09d",
  "windowStart": "2022-03-28T19:00:00.000Z",
  "windowEnd": "2022-03-28T23:00:00.000Z"
}

Response

Status Code 200: Successful Response - the request was successful!

successboolean

Example response

{
  "stop": {
    "stopId": "64ac4a958bea65dbe619482b",
    "status": "unstarted",
    "locationName": "21660 Copley",
    "locationAddress": "21660 Copley Dr Diamond Bar CA 91765 USA",
    "windowStart": "2022-07-14T19:00:00.000Z",
    "windowEnd": "2022-07-14T23:00:00.000Z",
    "sequence": 2
  }
}