All the request need be sent in json format.
All the response you received in json format.
You can call all the service using CURL with POST method.

1) Get a Quote


URLhttps://www.roadlaunch.com/api/quote/
MethodPOST
Content-Typeapplication/json
Acceptapplication/json

Request Data Example


            
                {
                    "email":"dummy@roadlaunch.com",
                    "api_key":"1234567890",
                    "city_from":"toronto",
                    "state_from":"on",
                    "city_to":"kitchener",
                    "state_to":"on",
                    "item":[
                       {
                          "length":48,
                          "width":48,
                          "height":48,
                          "qty":1,
                          "weight":300
                       },
                       {
                          "length":48,
                          "width":48,
                          "height":60,
                          "qty":1,
                          "weight":500
                       }
                    ]
                 }
            
        

Request Data Fields Details


FieldValueDescription
emailYour RoadLaunch.com Email Addressrequired
api_keyYour RoadLaunch.com Api Keyrequired
city_fromOrigin city namerequired
state_fromOrigin state/provice ISO2 Coderequired
For example new york state of united state value is NY
city_toDestination city namerequired
state_toDestination state/provice ISO2 Coderequired
For example new york state of united state value is NY
itemFreight items listrequired
Atleast one item required for get quote.

Item Request Data Fields Details


FieldValueDescription
lengthItem Lenght in Inchesrequired
widthItem Width in Inchesrequired
heightItem Height in Inchesrequired
qtyItem Quantityrequired
weightItem Weight in LBSrequired
Pass Single item weight.
System will calculate (qty X weight)

Response Data Example


            
                {
                    "status":"success",
                    "error_message":null,
                    "data":{
                       "city_from":"toronto",
                       "state_from":"on",
                       "city_to":"kitchener",
                       "state_to":"on",
                       "total_cubic_weight":11.574074074074074,
                       "total_actual_weight":800,
                       "total_qty":2,
                       "load_type":"ltl",
                       "item":[
                          {
                             "length":10,
                             "width":10,
                             "height":10,
                             "qty":1,
                             "weight":300
                          },
                          {
                             "length":10,
                             "width":10,
                             "height":10,
                             "qty":1,
                             "weight":500
                          }
                       ],
                       "list":[
                          {
                             "carrier_id":"2",
                             "carrier":"Company Name 1",
                             "rate":30,
                             "currency":"USD",
                             "available_capacity":60
                          },
                          {
                             "carrier_id":"10",
                             "carrier":"Company Name 2",
                             "rate":40,
                             "currency":"CAD"
                             "available_capacity":40
                          }
                       ]
                    }
                }
            
        

Response Fields Details


FieldValueDescription
status success, error success = if your request is successfully completed without any error

error = if your request have error.
error_message multiple error message seprated by "|" if your request have error its provided in this fields.
data contains your response data

Data Response Fields Details


FieldValueDescription
city_fromOrigin city name
state_fromOrigin state/provice ISO2 Code
city_toDestination city name
state_toDestination state/provice ISO2 Code
total_cubic_weighttotal cubic weight calculated by system.
total_actual_weighttotal actual weight calculated by system.
total_qtytotal quantity in your item list.
load_typeltl, ftl, htl
itemFreight items list
listFreight Carrier Rates list

Item Response Fields Details


FieldValueDescription
lengthItem Lenght in Inches
widthItem Width in Inches
heightItem Height in Inches
qtyItem Quantity
weightItem Weight in LBS

List Response Fields Details


FieldValueDescription
carrier_idCarrier id of roadlaunch system.InchesYou can use this id for other api request like Quote Email Request to send the email to carrier for your quote request.
carrierCarrier Name in roadlaunch system.if carrier enable option to display name in roadlaunch it will reflect here. otherwise its comes blank.
rateQuote PriceQuote price without excluded fuel surcharge, tax etc.
currencyUSD, CADQuote price currency code.
available_capacity% value of available capacity

2) Quote Email


URLhttps://www.roadlaunch.com/api/quote-email/
MethodPOST
Content-Typeapplication/json
Acceptapplication/json

Request Data Example


            
                {
                    "email":"dummy@roadlaunch.com",
                    "api_key":"1234567890",
                    "city_from":"toronto",
                    "state_from":"on",
                    "city_to":"kitchener",
                    "state_to":"on",
                    "item":[
                       {
                          "length":48,
                          "width":48,
                          "height":48,
                          "qty":1,
                          "weight":300
                       },
                       {
                          "length":48,
                          "width":48,
                          "height":60,
                          "qty":1,
                          "weight":500
                       }
                    ],
                    "carrier":[  
                        1,
                        10,
                        13,
                        14
                    ]
                 }
            
        

Request Data Fields Details


FieldValueDescription
emailYour RoadLaunch.com Email Addressrequired
api_keyYour RoadLaunch.com Api Keyrequired
city_fromOrigin city namerequired
state_fromOrigin state/provice ISO2 Coderequired
For example new york state of united state value is NY
city_toDestination city namerequired
state_toDestination state/provice ISO2 Coderequired
For example new york state of united state value is NY
itemFreight items listrequired
Atleast one item required for get quote.
carriercarrier_id listrequired
array list of carrier_id which you receive in quote response.
System will send this all carrier email of your quote request.

Item Request Data Fields Details


FieldValueDescription
lengthItem Lenght in Inchesrequired
widthItem Width in Inchesrequired
heightItem Height in Inchesrequired
qtyItem Quantityrequired
weightItem Weight in LBSrequired
Pass Single item weight.
System will calculate (qty X weight)

Response Data Example


            
                {
                    "status":"success",
                    "error_message":null,
                    "data":{
                       "city_from":"toronto",
                       "state_from":"on",
                       "city_to":"kitchener",
                       "state_to":"on",
                       "total_cubic_weight":11.574074074074074,
                       "total_actual_weight":800,
                       "total_qty":2,
                       "load_type":"ltl",
                       "item":[
                          {
                             "length":10,
                             "width":10,
                             "height":10,
                             "qty":1,
                             "weight":300
                          },
                          {
                             "length":10,
                             "width":10,
                             "height":10,
                             "qty":1,
                             "weight":500
                          }
                       ],
                       "list":[
                          {
                             "carrier_id":"2",
                             "carrier":"Company Name 1",
                             "rate":30,
                             "currency":"USD",
                             "available_capacity":60
                          },
                          {
                             "carrier_id":"10",
                             "carrier":"Company Name 2",
                             "rate":40,
                             "currency":"CAD",
                             "available_capacity":40
                          }
                       ]
                    }
                }
            
        

Response Fields Details


FieldValueDescription
status success, error success = if your request is successfully completed without any error

error = if your request have error.
error_message multiple error message seprated by "|" if your request have error its provided in this fields.
data contains your response data

Data Response Fields Details


FieldValueDescription
city_fromOrigin city name
state_fromOrigin state/provice ISO2 Code
city_toDestination city name
state_toDestination state/provice ISO2 Code
total_cubic_weighttotal cubic weight calculated by system.
total_actual_weighttotal actual weight calculated by system.
total_qtytotal quantity in your item list.
load_typeltl, ftl, htl
itemFreight items list
listFreight Carrier Rates list

Item Response Fields Details


FieldValueDescription
lengthItem Lenght in Inches
widthItem Width in Inches
heightItem Height in Inches
qtyItem Quantity
weightItem Weight in LBS

List Response Fields Details


FieldValueDescription
carrier_idCarrier id of roadlaunch system.InchesYou can use this id for other api request like Quote Email Request to send the email to carrier for your quote request.
carrierCarrier Name in roadlaunch system.if carrier enable option to display name in roadlaunch it will reflect here. otherwise its comes blank.
rateQuote PriceQuote price without excluded fuel surcharge, tax etc.
currencyUSD, CADQuote price currency code.
available_capacity% value of available capacity