Sign in
latestOpenAPI 3.0.02026-08-08163663.9 KB

4aa7f4326443

Stops
Shipper

Mark a stop as complete

Marks a stop as "complete". The stopId, and shipmentReference is required for all shipment types. If the shipment is shorthaul, only admins can access this route and file data must also be provided. If the shipment is drayage, chassis, trailerId, and containerId may be required.

post/stops/complete

Request body

stopIdstring required
shipmentReferencestring required

Example request

{
  "stopId": "5ca39c2a0cb793001366c012",
  "shipmentReference": "ABC-123",
  "meta": {
    "files": [
      "stop_info.txt"
    ]
  }
}

Response

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

successboolean

Example response

{
  "data": {
    "status": "complete",
    "windowStart": "2021-06-02T15:54:29.728Z",
    "windowEnd": "2021-07-02T15:54:29.728Z",
    "documents": [
      "stop_info.txt"
    ]
  }
}