latestOpenAPI 3.0.02026-08-08163663.9 KB

4aa7f4326443

Stops

Shipper

Mark a stop as "arrived"

Marks a stop as "arrived". status, stopId, and shipmentReference are required. The only acceptable value for status is arrived (see example request body). If date is not provided, the current time will be used as the arrival time. Admins, shippers, carriers, and drivers are authorized to use this API endpoint.

post/stops/transition

Request body

shipmentReferencestring required

stopIdstring required

statusstring required

Example request

{
  "shipmentReference": "ABC-123",
  "status": "arrived",
  "meta": {
    "date": "2023-07-20T16:51:11.736Z"
  }
}

Response

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

successboolean

Example response

{
  "data": {
    "status": "arrived"
  }
}