Skip to content
/
Create a new FTL shipment

FTL API (1.0.0)

API documentation for FTL Operations

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

FTL Quotes

FTL Quotes

Operations

FTL Shipments

FTL Shipments

Operations

List FTL shipments by Order Numbers

Request

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

Security
bearerAuth
Query
order_numbersstringrequired

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

Example: order_numbers=FS123,FS456,FS789
curl -i -X GET \
  'https://apitest.drayeasy.com/api/v2/ftl/shipments?order_numbers=FS123%2CFS456%2CFS789' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of FTL shipments

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

Create a new FTL shipment

Request

This endpoint allows you to create a new FTL 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
commodity_namestring<= 255 charactersrequired
Example: "Electronics"
total_weightintegerrequired
Example: 12345
total_unitsintegerrequired
Example: 50
package_typestringrequired
Enum"Pallet""Crate"
Example: "Pallet"
cartonsintegerrequired
Example: 123
pickup_time_typeinteger

0: Time window and first come first serve, 1: Specific pickup time, 2: Represent me to make an appointment

Enum012
Example: 0
pickup_specific_timestring or null<= 5 characters^\d{2}:\d{2}$
Example: "10:00"
destination_time_typeinteger

0: Time window and first come first serve, 1: Specific destination time, 2: Represent me to make an appointment

Enum012
Example: 0
destination_specific_timestring or null<= 5 characters^\d{2}:\d{2}$
Example: "15:00"
curl -i -X POST \
  https://apitest.drayeasy.com/api/v2/ftl/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,
    "commodity_name": "Electronics",
    "total_weight": 12345,
    "total_units": 50,
    "package_type": "Pallet",
    "cartons": 123,
    "pickup_time_type": 0,
    "pickup_specific_time": "10:00",
    "destination_time_type": 0,
    "destination_specific_time": "15:00"
  }'

Responses

Shipment created successfully

Bodyapplication/json
dataobject(FTLShipmentDetail)
Response
application/json
{
  "data": {
    "order_number": "FS241205028749"
  }
}

FTL Tracking

FTL Tracking

Operations

FTL Files

FTL Shipment Files

Operations
Copyleft © DrayEasy Inc. No rights reserved.