Skip to content

LTL API (1.0.0)

API documentation for LTL Operations

Languages
Servers
Sandbox Server
https://apitest.drayeasy.com/
Production Server
https://api.drayeasy.com/

LTL Quotes

LTL Quotes

Operations

Create a new LTL Quote

Request

This endpoint allows you to create a new LTL quote.

Security
bearerAuth
Bodyapplication/jsonrequired
pickup_zipcodestring<= 255 charactersrequired
Example: "91730"
pickup_citystring<= 32 charactersrequired
Example: "RANCHO CUCAMONGA"
pickup_statestring<= 32 charactersrequired

State abbreviation

Example: "CA"
pickup_countrystring or null<= 32 characters

Default value is 'US'

Example: "US"
pickup_address_typestringrequired

when home delivery is selected, pickup_address_type must be business

Enum"business""residential""limitedAccess"
Example: "business"
pickup_accessorialsArray of strings or null

when home delivery is selected, pickup_accessorials must be empty

Enum"inside""liftgate"
destination_zipcodestring<= 255 charactersrequired
Example: "08086"
destination_citystring<= 32 charactersrequired
Example: "LEONARDS"
destination_statestring<= 32 charactersrequired

State abbreviation

Example: "NJ"
destination_countrystring or null<= 32 characters

Default value is 'US'

Example: "US"
destination_address_typestringrequired

when home delivery is selected, destination_address_type must be residential

Enum"business""residential""limitedAccess"
Example: "business"
destination_accessorialsArray of strings or null

when home delivery is selected, destination_accessorials can only contain homeDelivery

Enum"inside""liftgate""appointment""homeDelivery"
pickup_datestring(date)required

Pickup date can not be in the past

Example: "2024-12-07"
timeoutinteger or null[ 5 .. 60 ]

Timeout in seconds to wait for the quote to be processed. Default value is 30 seconds.

Example: 30
cargo_valueinteger or null[ 1 .. 30000 ]

The cargo value will be used in the calculation of the insurance premium.

Example: 2000
floorinteger or null

Floor number. Only available when home delivery is selected.

Example: 12
is_elevatorboolean or null

Whether elevator is available. Only available when home delivery is selected.

Example: true
is_militaryboolean or null

Whether it is a military address. Only available when home delivery is selected.

Example: true
itemsArray of objects(LTLQuoteShipmentItem)required

Array of items to be shipped

items[].​weight_unitstringrequired
Enum"lbs""kg"
Example: "lbs"
items[].​dimension_unitstringrequired
Enum"in""cm"
Example: "in"
items[].​heightinteger>= 1required
Example: 72
items[].​lengthinteger>= 1required
Example: 48
items[].​widthinteger>= 1required
Example: 40
items[].​total_weightinteger>= 1required
Example: 1200
items[].​unitsinteger>= 1required
Example: 1
items[].​piecesinteger or null>= 1

Required when home delivery is not selected. Optional when home delivery is selected.

Example: 1
items[].​package_typestringrequired
Enum"Bag""Bale""Box""Bucket""Bundle""Can""Carton""Case""Coil""Crate"
Example: "Pallet"
items[].​descriptionstring<= 255 charactersrequired

Description of the item

Example: "general goods"
curl -i -X POST \
  https://apitest.drayeasy.com/api/ltl/quotes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pickup_zipcode": "91730",
    "pickup_city": "RANCHO CUCAMONGA",
    "pickup_state": "CA",
    "pickup_country": "US",
    "pickup_address_type": "business",
    "pickup_accessorials": [
      "inside"
    ],
    "destination_zipcode": "08086",
    "destination_city": "LEONARDS",
    "destination_state": "NJ",
    "destination_country": "US",
    "destination_address_type": "business",
    "destination_accessorials": [
      "inside"
    ],
    "pickup_date": "2024-12-07",
    "timeout": 30,
    "cargo_value": 2000,
    "floor": 12,
    "is_elevator": true,
    "is_military": true,
    "items": [
      {
        "weight_unit": "lbs",
        "dimension_unit": "in",
        "height": 72,
        "length": 48,
        "width": 40,
        "total_weight": 1200,
        "units": 1,
        "pieces": 1,
        "package_type": "Pallet",
        "description": "general goods"
      }
    ]
  }'

Responses

Quote created successfully

Bodyapplication/json
dataobject
Response
application/json
{ "data": { "rates": [], "premium": 1221, "quote_number": "unique-quote-number" } }

LTL Shipments

LTL Shipments

Operations

LTL Tracking

LTL Tracking

Operations