Skip to content
/
Create a new LTL shipment

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

LTL Shipments

LTL Shipments

Operations

List LTL shipments by Order Numbers and Rate Numbers

Request

This endpoint allows you to list LTL shipments by Order Numbers and Rate Numbers. Max 50 order numbers can be passed. Order numbers should be comma separated.

Security
bearerAuth
Query
order_numbersstring

A list of order numbers separated by commas. Max 50 order numbers can be passed.

Example: order_numbers=123,456,789
rate_numbersstring

A list of rate numbers separated by commas. Max 50 rate numbers can be passed.

Example: rate_numbers=R123,R456,R789
curl -i -X GET \
  'https://apitest.drayeasy.com/api/ltl/shipments?order_numbers=123%2C456%2C789&rate_numbers=R123%2CR456%2CR789' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of LTL shipments

Bodyapplication/json
dataArray of objects(LTLShipmentDetail)
Response
application/json
{
  "data": [
    { … }
  ]
}

Create a new LTL shipment

Request

This endpoint allows you to create a new LTL shipment.

Security
bearerAuth
Bodyapplication/jsonrequired
pickup_company_namestring<= 255 charactersrequired
Example: "test"
pickup_contact_namestring
Example: "John"
pickup_contact_emailstring(email)required
Example: "1@1.com"
pickup_contact_phonestring<= 10 characters/^\d{10}$/required
Example: "1234567890"
pickup_contact_phone_extstring or null<= 5 characters
Example: "123"
pickup_address1string<= 255 charactersrequired
Example: "123 Main St"
pickup_address2string or null<= 255 characters
Example: "Apt 4B"
destination_company_namestring<= 255 charactersrequired
Example: "test"
destination_contact_namestring
Example: "John"
destination_contact_emailstring(email)required
Example: "2@1.com"
destination_contact_phonestring<= 10 characters/^\d{10}$/required
Example: "1234567890"
destination_contact_phone_extstring or null<= 5 characters
Example: "456"
destination_address1string<= 255 charactersrequired
Example: "456 Elm St"
destination_address2string or null<= 255 characters
Example: "Suite 5"
pickup_open_timestring<= 5 characters^\d{2}:\d{2}$required
Example: "08:00"
pickup_close_timestring<= 5 characters^\d{2}:\d{2}$required
Example: "17:00"
destination_open_timestring<= 5 characters^\d{2}:\d{2}$required
Example: "09:00"
destination_close_timestring<= 5 characters^\d{2}:\d{2}$required
Example: "18:00"
customer_reference_numberstring or null<= 255 characters
Example: "REF123"
pickup_special_requeststring or null<= 255 characters
Example: "Leave at front desk"
destination_special_requeststring or null<= 255 characters
Example: "Call upon arrival"
pickup_numberstring or null<= 255 characters
Example: ""
dropoff_numberstring or null<= 255 characters
Example: ""
rate_numberstringrequired

Rate number from the quote API response

Example: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
is_insurance_entrustedbooleanrequired
Example: true
cargo_valueinteger or null[ 1 .. 30000 ]

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

Example: 2000
curl -i -X POST \
  https://apitest.drayeasy.com/api/ltl/shipments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pickup_company_name": "test",
    "pickup_contact_name": "John",
    "pickup_contact_email": "1@1.com",
    "pickup_contact_phone": "1234567890",
    "pickup_contact_phone_ext": "123",
    "pickup_address1": "123 Main St",
    "pickup_address2": "Apt 4B",
    "destination_company_name": "test",
    "destination_contact_name": "John",
    "destination_contact_email": "2@1.com",
    "destination_contact_phone": "1234567890",
    "destination_contact_phone_ext": "456",
    "destination_address1": "456 Elm St",
    "destination_address2": "Suite 5",
    "pickup_open_time": "08:00",
    "pickup_close_time": "17:00",
    "destination_open_time": "09:00",
    "destination_close_time": "18:00",
    "customer_reference_number": "REF123",
    "pickup_special_request": "Leave at front desk",
    "destination_special_request": "Call upon arrival",
    "pickup_number": "",
    "dropoff_number": "",
    "rate_number": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "is_insurance_entrusted": true,
    "cargo_value": 2000
  }'

Responses

Shipment created successfully

Bodyapplication/json
dataobject(LTLShipmentDetail)
Response
application/json
{
  "data": {
    "order_number": "LS241205028749",
    "pickup_company_name": "Pickup Company",
    "pickup_contact_name": "John Doe",
    "pickup_contact_phone": "123-456-7890",
    "pickup_contact_email": "pickup@example.com",
    "pickup_zipcode": "90047",
    "pickup_city": { … },
    "pickup_address1": "123 Main St",
    "pickup_address2": "Apt 4B",
    "destination_company_name": "Destination Company",
    "destination_contact_name": "Jane Doe",
    "destination_contact_phone": "987-654-3210",
    "destination_contact_email": "destination@example.com",
    "destination_zipcode": "92404",
    "destination_city": { … },
    "destination_address1": "456 Elm St",
    "destination_address2": "Suite 5",
    "pro_number": "PRO123456789",
    "pickup_accessorials": [ … ],
    "destination_accessorials": [ … ],
    "pickup_special_request": "Special request",
    "destination_special_request": "Special request",
    "pickup_number": "123",
    "dropoff_number": "123",
    "customer_reference_number": "REF123",
    "customer_status": "Pending",
    "rate": 2482.04,
    "cargo_value": 1221,
    "premium": 1221,
    "is_insurance_entrusted": true,
    "pickup_open_time": "08:00",
    "pickup_close_time": "18:00",
    "estimated_pickup_date": "2024-12-31",
    "actual_pickup_date": "2024-12-31",
    "estimated_delivery_date": "2025-01-31",
    "actual_delivery_date": "2025-01-31",
    "destination_open_time": "09:00",
    "destination_close_time": "18:00",
    "items": [ … ],
    "documents": [ … ],
    "created_at": "2024-12-05 02:44"
  }
}

LTL Tracking

LTL Tracking

Operations
Copyleft © DrayEasy Inc. No rights reserved.