Sign in
Carrier

Accepts a Shipment

Accepts an offered shipment on behalf of the authenticated carrier. The shipmentReference of the shipment to accept is required.

post/shipments/accept

Request body

shipmentReferencestring required

Reference of the shipment to accept.

Example request

{
  "shipmentReference": "ABC-123"
}

Response

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

shipmentIdstring
statusstring
carrierIdstring

Example response

{
  "shipmentId": "61f468826a139d5cfe58f0a2",
  "status": "created",
  "carrierId": "60b7a951c2b827f9f5179454",
  "stops": [
    {
      "stopId": "60b7a951c2b827f9f517945c",
      "status": "unstarted",
      "locationName": "Cargomatic HQ",
      "locationAddress": "211 E. Ocean Blvd Long Beach CA 90802",
      "windowStart": "2021-06-02T15:52:49.258Z",
      "windowEnd": "2021-06-02T19:52:49.258Z"
    }
  ]
}

Changes