New Quote
POST v2/quotes/multistop
Request
Quote Object
service
string enum "LTL" or "TL"
Yes
Whether the shipment is truck load or ltl
commodityDescriptionId
int (See Below)
Yes
Describes the freight being hauled
freightClass
string enum (See Below)
No
Describes the freight class of the load
shippers
Stop array (See Below)
Yes
All the pickups for the load. At least 1 is required.
consignees
Stop array (See Below)
Yes
All the deliveries for the load. At least 1 is required.
reefer
Reefer (See Below)
No
If the load is temperature controlled then this object is required.
units
Units (See Below)
Yes
The units of size, weight, and count for the load.
Reefer Object
reeferTemp
string
Yes*
The temperature of the load. If this object is present then this field is required. LTL Range: 40° to 80° TL Range: -20° to 80°
reeferCont
boolean
No
If true, indicates that a reefer should be continuously run. Defaults to false. Only available for TL.
Stop Object
zip
string
No*
The zip code of the stop. It is required if a locationId is not present.
locationId
int
No*
The locationId of the stop. The id can be obtained from the locations endpoint. It is required if a zip is not present.
accessorialIds
int array
No
An array of ids representing accessorials to be added to the stop. The ids can be obtained from the accessorials endpoint.
accessorialTags
string array enum (See Below)
No
An array of accessorials to be added to the stop. An alternative to using accessorialIds but can be used with it.
date
string (yyyy-mm-dd)
No*
The date of the pickup only. Needed for more accurate transit windows. Needs to be in the form 2023-04-02
Units Object
palletDimensions
Pallet Group array (See Below)
Yes
An array of pallet dimension objects. Allows for loads with pallets of various sizes.
totalDimensions
Total Dimensions object (See Below)
Yes
Dimensions related to the entirety of the load.
Pallet Group Object
units
string enum "inches" or "feet"
Yes
The units the dimensions will be sent in.
length
int
Yes
The length of one pallet in this group.
width
int
Yes
The width of one pallet in this group.
height
int
No
The height of one pallet in this group. Only needed if the group is stackable.
count
int
Yes
The number of pallets in this group.
stackable
boolean
No
Whether the pallets can be stacked on top of each other. Defaults to false.
class
string
Conditional
The NMFC Freight Class of the load. For LTL loads the class is required.
Total Dimensions Object
totalWeight
int
Yes
The total weight of the load.
Commodity Description IDs
1 - Dairy
2 - Machinery
4 - Dry F.A.K.
5 - Food Product
6 - Alcohol
7 - Vitamins
8 - Electronics
Accessorial Tags
driver_count
liftgate
after_hours
high_value
floor_loaded
stop_charge
scheduled_appointment
Freight Classes
"500" - 500 Class
"400" - 400 Class
"300" - 300 Class
"250" - 250 Class
"200" - 200 Class
"175" - 175 Class
"150" - 150 Class
"125" - 125 Class
"110" - 110 Class
"100" - 100 Class
"92" - 92 Class
"85" - 85 Class
"77" - 77 Class
"70" - 70 Class
"65" - 65 Class
"60" - 60 Class
"55" - 55 Class
"50" - 50 Class
Example Request
Example 1 - request with multiple sized pallets
{
"service":"LTL",
"commodityDescriptionId":2,
"shippers":[
{
"zip":"90026",
"date" "2024-04-01",
"accessorialTags":[
"floor_loaded"
]
}
],
"consignees":[
{
"locationID":74248
}
],
"units":{
"palletDimensions":[
{
"units":"inches",
"length":48,
"width":48,
"height":48,
"count":6,
"stackable":true,
"class": "50"
},
{
"units":"inches",
"length":55,
"width":45,
"height":62,
"count":6,
"stackable":false,
"class": "50"
}
],
"totalDimensions":{
"totalWeight":10000
}
},
"reefer":{
"reeferTemp":"",
"reeferCont":false
}
}
Example 2 - request with multiple stops
{
"service":"LTL",
"commodityDescriptionId":2,
"shippers":[
{
"zip":"90210",
"date" "2024-04-01"
},
{
"zip":"90026",
"date" "2024-04-01"
}
],
"consignees":[
{
"zip":"60607"
}
],
"units":{
"palletDimensions":[
{
"units":"inches",
"length":"50.4",
"width":"40",
"height":"40",
"count":"10",
"stackable":true,
"class": "50"
}
],
"totalDimensions":{
"totalWeight":13000
}
}
}
Example 3 - request for TL reefer
{
"service":"TL",
"commodityDescriptionId":2,
"shippers":[
{
"zip":"90210",
"date" "2024-04-01"
},
{
"zip":"90026"
"date" "2024-04-01"
}
],
"consignees":[
{
"zip":"60607"
}
],
"units":{
"palletDimensions":[
{
"units":"inches",
"length":"48",
"width":"48",
"height":"48",
"count":"23"
}
],
"totalDimensions":{
"totalWeight":23000
},
"reefer":{
"reeferTemp":"0",
"reeferCont":false
}
}
}
Quote Response
Response Object
id
int
The unique id of the quote.
createdAt
string
Date and time the quote was created.
commodityDescription
string
The string name of the description id sent.
freightClass
string
The freight class. Empty string means no freight class was used
totalMiles
int
The total road miles of the quote.
pallets
int
The total number of pallets for the quote.
feet
int
The total number of feet for the load. TL will alway return 53 feet.
weight
int
The total weight of the load.
type
string
Either TL or LTL
stops
array
An array of stop objects. See below.
serviceLevels
array
An array of service level objects. See below.
accessorials
array
An array of accessorial objects. See below.
units
object
The unit object that was sent in the quote request is returned.
Stop Object
id
int
The unique id of the stop.
name
string
The name of the location of the stop.
type
string
Either shipper (pickup) or consignee (delivery)
address
object
An object representing the address of the stop. See Below.
Address Object
locationId
int
If the address is a valid location then the id is returned.
city
string
The city name.
state
string
The two letter state abbreviation. Ex "CA"
zip
string
The zip code of the address.
latitude
float
The latitude of the address.
longitude
float
The longitude of the address.
Service Level Object
id
string
The identifier of the service level. Used when tendering a load.
description
string
The expected transit time of the service level.
seviceLevel
string
The name of the service level. Either guaranteed, premium, or economy.
baseRate
float
The base rate of the service level.
fuelRate
float
The fuel surcharge for the service level.
extra
float
The total of the accessorials for the quote. Does not include fuel surcharge.
totalRate
float
The total cost of the service level.
surcharges
array
An array of accessorial objects. These charges are unique to only the service level they are apart of.
from
date string "YYYY-M-D"
The earliest date the load can be expected to deliver
to
date string "YYYY-M-D"
The latest date the load can be expected to deliver
flexible
boolean
If flexible is true then the from - to dates are considered a window. If flexible is false then the load can be guaranteed to deliver on any date in the window
Accessorial Object
costAmount
float
The cost of the accessorial.
name
string
The name of the accessorial
accessorialId
int
The id of the accessorial.
stopId
int
The id of the stop object this accessorial is for. Omitted if the accessorial is not part of a stop.
stopName
string
The name of the stop object this accessorial is for. Omitted if the accessorial is not part of a stop.
Example 1 - response with multiple sized pallets
{
"id":1433565,
"createdAt":"2018-04-10T21:54:38Z",
"commodityDescription":"Machinery",
"totalMiles":385,
"pallets":12,
"freightClass": "50",
"feet":22,
"weight":10000,
"type":"LTL",
"stops":[
{
"id":3051472,
"name":"90026",
"type":"shipper",
"city":"Los Angeles",
"state":"CA",
"zip":"90026",
"address":{
"city":"Los Angeles",
"state":"CA",
"zip":"90026",
"latitude":34.079313,
"longitude":-118.262692
}
},
{
"id":3051473,
"name":"Mule Creek State Prison - DOC",
"type":"consignee",
"city":"Plymouth",
"state":"CA",
"zip":"95669",
"address":{
"locationId":74248,
"line1":"4001 CA-104",
"city":"Plymouth",
"state":"CA",
"zip":"95669",
"latitude":38.3687,
"longitude":-120.959
}
}
],
"serviceLevels":[
{
"id":"G1433565",
"description":"4 Business Days",
"serviceLevel":"guaranteed",
"baseRate":1844,
"extra":595,
"fuelRate":332,
"totalRate":2771,
"surcharges":[
{
"costAmount":445,
"name":"Guaranteed Service",
"accessorialId":2
}
],
"flexible": false,
"from": "2023-9-25",
"to": "2023-10-5"
},
{
"id":"P1433565",
"description":"5/6 Business Days",
"serviceLevel":"premium",
"baseRate":1844,
"extra":150,
"fuelRate":332,
"totalRate":2326,
"surcharges":null,
"flexible": true,
"from": "2023-9-26",
"to": "2023-9-27"
},
{
"id":"E1433565",
"description":"7/10 Business Days",
"serviceLevel":"economy",
"baseRate":1529,
"extra":150,
"fuelRate":275,
"totalRate":1954,
"surcharges":null,
"flexible": true,
"from": "2023-9-28",
"to": "2023-10-3"
}
],
"accessorials":[
{
"costAmount":200,
"name":"Floor Loaded",
"accessorialId":1,
"stopId":3051472,
"stopName":"Stop:1 - 90026"
},
{
"costAmount":-50,
"name":"Online Quote Discount",
"accessorialId":66
}
],
"units":{
"palletDimensions":[
{
"units":"inches",
"length":48,
"width":48,
"height":48,
"count":6,
"stackable":true
},
{
"units":"inches",
"length":55,
"width":45,
"height":62,
"count":6
}
],
"totalDimensions":{
"totalWeight":10000
}
},
"api":"public",
"version":3
}
Example 2 - response with multiple stops
{
"id":1433566,
"createdAt":"2018-04-10T22:11:27Z",
"commodityDescription":"Machinery",
"totalMiles":2025,
"pallets":10,
"feet":14,
"weight":13000,
"type":"LTL",
"stops":[
{
"id":3051474,
"name":"90210",
"type":"shipper",
"city":"Beverly Hills",
"state":"CA",
"zip":"90210",
"address":{
"city":"Beverly Hills",
"state":"CA",
"zip":"90210",
"latitude":34.086771,
"longitude":-118.411853
}
},
{
"id":3051475,
"name":"90026",
"type":"shipper",
"city":"Los Angeles",
"state":"CA",
"zip":"90026",
"address":{
"city":"Los Angeles",
"state":"CA",
"zip":"90026",
"latitude":34.079313,
"longitude":-118.262692
}
},
{
"id":3051476,
"name":"60607",
"type":"consignee",
"city":"Chicago",
"state":"IL",
"zip":"60607",
"address":{
"city":"Chicago",
"state":"IL",
"zip":"60607",
"latitude":41.87941,
"longitude":-87.650582
}
}
],
"transitTime":115.23333333333333,
"serviceLevels":[
{
"id":"G1433566",
"description":"4 Business Days",
"serviceLevel":"guaranteed",
"baseRate":1083,
"extra":395,
"fuelRate":195,
"totalRate":1673,
"surcharges":[
{
"costAmount":445,
"name":"Guaranteed Service",
"accessorialId":2
}
],
"flexible": false,
"from": "2023-9-25",
"to": "2023-10-5"
},
{
"id":"P1433566",
"description":"5/6 Business Days",
"serviceLevel":"premium",
"baseRate":1083,
"extra":-50,
"fuelRate":195,
"totalRate":1228,
"surcharges":null,
"flexible": true,
"from": "2023-9-26",
"to": "2023-9-27"
},
{
"id":"E1433566",
"description":"*8/9 Business Days",
"serviceLevel":"economy",
"baseRate":924,
"extra":-50,
"fuelRate":166,
"totalRate":1040,
"surcharges":null,
"flexible": true,
"from": "2023-9-28",
"to": "2023-10-3"
}
],
"accessorials":[
{
"costAmount":-50,
"name":"Online Quote Discount",
"accessorialId":66
}
],
"units":{
"palletDimensions":[
{
"units":"inches",
"length":"50.4",
"width":"40",
"height":"40",
"count":"10",
"stackable":true
}
],
"totalDimensions":{
"totalWeight":13000
}
},
"api":"public",
"version":3
}
Example 3 - response for TL reefer
{
"id":1433567,
"createdAt":"2018-04-10T22:14:32Z",
"commodityDescription":"Machinery",
"totalMiles":2025,
"pallets":23,
"feet":53,
"weight":23000,
"type":"TL",
"stops":[
{
"id":3051477,
"name":"90210",
"type":"shipper",
"city":"Beverly Hills",
"state":"CA",
"zip":"90210",
"address":{
"city":"Beverly Hills",
"state":"CA",
"zip":"90210",
"latitude":34.086771,
"longitude":-118.411853
}
},
{
"id":3051478,
"name":"90026",
"type":"shipper",
"city":"Los Angeles",
"state":"CA",
"zip":"90026",
"address":{
"city":"Los Angeles",
"state":"CA",
"zip":"90026",
"latitude":34.079313,
"longitude":-118.262692
}
},
{
"id":3051479,
"name":"60607",
"type":"consignee",
"city":"Chicago",
"state":"IL",
"zip":"60607",
"address":{
"city":"Chicago",
"state":"IL",
"zip":"60607",
"latitude":41.87941,
"longitude":-87.650582
}
}
],
"transitTime":97.11666666666667,
"serviceLevels":[
{
"id":"G1433567",
"description":"5 Calendar Days",
"serviceLevel":"guaranteed",
"baseRate":2691,
"extra":395,
"fuelRate":633,
"totalRate":3719,
"surcharges":[
{
"costAmount":445,
"name":"Guaranteed Service",
"accessorialId":2
}
],
"flexible": false,
"from": "2023-9-28",
"to": "2023-10-3"
},
{
"id":"P1433567",
"description":"6/7 Calendar Days",
"serviceLevel":"premium",
"baseRate":2691,
"extra":-50,
"fuelRate":633,
"totalRate":3274,
"surcharges":null,
"flexible": true,
"from": "2023-9-28",
"to": "2023-10-3"
},
{
"id":"E1433567",
"description":"*8/9 Calendar Days",
"serviceLevel":"economy",
"baseRate":2415,
"extra":-50,
"fuelRate":567,
"totalRate":2932,
"surcharges":null,
"flexible": true,
"from": "2023-9-28",
"to": "2023-10-3"
}
],
"accessorials":[
{
"costAmount":-50,
"name":"Online Quote Discount",
"accessorialId":66
}
],
"units":{
"palletDimensions":[
{
"units":"inches",
"length":"48",
"width":"48",
"height":"48",
"count":"23"
}
],
"totalDimensions":{
"totalWeight":23000
}
},
"api":"public",
"version":3
}
Last updated