latestOpenAPI 3.0.02026-08-08163663.9 KB

4aa7f4326443

Shipper

Creates a quote

Creates a quote based on the factors provided in the request body. This API endpoint is only accessible by Shippers and Admins!

post/quotes

Request body

courierboolean

distanceinteger

marketstring

The valid values for market are the three letter identifiers for the market, like LAX, SFO, ATL, etc.

weightinteger required

Total weight of the shipment.

weight_unitsstring

Default unit is lb.

full_truckloadboolean required

If full_truckload is false, loads is a required field.

shipment_typestring

Example request

{
  "accessorials": [
    {
      "type": "residential_delivery"
    }
  ],
  "distance": 12583,
  "loads": [
    {
      "type": "pallets",
      "quantity": 1,
      "length": 48,
      "width": 40,
      "height": 60,
      "weight_units": "lb",
      "dimensional_units": "in",
      "languageCodeId": "en-us",
      "distance_units": "mi",
      "currency": "USD",
      "temperature_units": "F"
    }
  ],
  "market": "SFO",
  "stops": [
    {
      "action": "pickup",
      "location": {
        "name": "Atlas Marine",
        "address": "1550 Cota Ave Long Beach CA 90813"
      }
    }
  ],
  "weight": 40000,
  "weight_units": "lb",
  "shipper": {
    "_id": "62879ea006bfa2d915861ba6"
  },
  "full_truckload": true,
  "shipment_type": "shorthaul"
}

Response

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

successboolean

Example response

{
  "quote": {
    "shipment_type": "shorthaul",
    "weight": 4000,
    "distance": 4276,
    "created_at": "2023-07-12T03:41:08.784Z",
    "origin": {
      "address": "1550 Cota Ave Long Beach CA 90813 USA",
      "coords": [
        -118.2162816
      ],
      "name": "Atlas Marine"
    },
    "destination": {
      "address": "211 E Ocean Blvd Long Beach CA 90802",
      "coords": [
        -118.19072819999997
      ],
      "name": "Cargomatic"
    },
    "loads": [
      {
        "type": "pallets",
        "dimensional_units": "in",
        "quantity": 3,
        "width": 40,
        "height": 60,
        "length": 48,
        "weight": 4000,
        "spaces": 3,
        "weight_units": "lb",
        "_id": "64ae20d4814c928bbafbeade"
      }
    ],
    "quote_id": "BAD-QT-1796",
    "expiration_date": "2023-07-19T03:41:08Z",
    "receivables": [
      {
        "message": "Residential",
        "value": 35,
        "timestamp": "2023-07-12T03:41:06.029Z"
      }
    ],
    "shipper": "badri.shipper@cargomatic.com"
  }
}