CarLoadboard.com™ Web Services
The following section describes the currently available Web Service options.
This system will allow you to Post new loads, edit existing loads and delete existing loads for your account.
In order to submit XML requests to our system, you will have to be able to post XML data to the specific urls for each type of request.
If you need assistance using our web services, please contact us
Important: Read the XML-Response you receive back from our system as it will explain any possible errors in the XML you send to us.
Posting URL: http://www.carloadboard.com/webservices/addloads.php
<?xml version="1.0"?>
<carloadboard>
<credentials>
<account>jdoe</account>
<webservicekey>jdoewebservicekey</webservicekey>
<requestid>jdoeinternalid</requestid>
</credentials>
<loads>
<load>
<order_id>123</order_id>
<origin_city>Atlanta</origin_city>
<origin_state>GA</origin_state>
<origin_zip>30308</origin_zip>
<destination_city>Norcross</destination_city>
<destination_state>GA</destination_state>
<destination_zip>30092</destination_zip>
<payment_amount>450.00</payment_amount>
<payment_method>quickpay</payment_method>
<cod_cop_amount>150.00</cod_cop_amount>
<cod_cop_method>comchek</cod_cop_method>
<cod_cop_timing>delivery</cod_cop_timing>
<trailer_type>open</trailer_type>
<date_available>2010-07-01</date_available>
<date_delivery>2010-07-01</date_delivery>
<additional_info>Deliver by July 10th.</additional_info>
<status>posted</status>
<vehicles>
<vehicle>
<year>2007</year>
<make>Honda</make>
<model>Civic</model>
<type>Car</type>
<operable>yes</operable>
</vehicle>
...
</vehicles>
</load>
...
</loads>
</carloadboard>
Posting URL: http://www.carloadboard.com/webservices/editloads.php
Editing loads is similar to Posting Loads, but will only update existing loads.
All fields must be passed on edit, especially vehicles as they are not identified uniquely through webservices and will overwrite the previous vehicles for this load.
<?xml version="1.0"?>
<carloadboard>
<credentials>
<account>jdoe</account>
<webservicekey>jdoewebservicekey</webservicekey>
<requestid>jdoeinternalid</requestid>
</credentials>
<loads>
<load>
<order_id>123</order_id>
<origin_city>Atlanta</origin_city>
<origin_state>GA</origin_state>
<origin_zip>30308</origin_zip>
<destination_city>Norcross</destination_city>
<destination_state>GA</destination_state>
<destination_zip>30092</destination_zip>
<payment_amount>450.00</payment_amount>
<payment_method>quickpay</payment_method>
<cod_cop_amount>150.00</cod_cop_amount>
<cod_cop_method>comchek</cod_cop_method>
<cod_cop_timing>delivery</cod_cop_timing>
<trailer_type>open</trailer_type>
<date_available>2010-07-01</date_available>
<date_delivery>2010-07-01</date_delivery>
<additional_info>Deliver by July 10th.</additional_info>
<status>posted</status>
<vehicles>
<vehicle>
<year>2007</year>
<make>Honda</make>
<model>Civic</model>
<type>Car</type>
<operable>yes</operable>
</vehicle>
...
</vehicles>
</load>
...
</loads>
</carloadboard>
Posting URL: http://www.carloadboard.com/webservices/deleteloads.php
Multiple loads can be deleted at once by adding multiple <load> blocks.
<?xml version="1.0"?>
<carloadboard>
<credentials>
<account>jdoe</account>
<webservicekey>jdoewebservicekey</webservicekey>
<requestid>jdoeinternalid</requestid>
</credentials>
<loads>
<load>
<order_id>2341234345</order_id>
</load>
...
</loads>
</carloadboard>
$url is the posting URL as defined for each Request XML section.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml"));
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close ($ch);
Once completed the $response contains the results of your submission.
Each load contains vehicles. At least one vehicle is required for the load to be processed into the system.
Response status code will either be "ok" or "error"
<?xml version="1.0"?>
<carloadboard>
<response>
<_timestamp>1278956146</_timestamp>
<_requestid>jdoewebservicekey</_requestid>
<_errors>
<_error>
<_errorcode>255</_errorcode>
<_errortext>Full error description</_errortext>
</_error>
...
</_errors>
<status>error</status>
</response>
</carloadboard>
This system will allow you to Post new loads, edit existing loads and delete existing loads for your account.
In order to submit XML requests to our system, you will have to be able to post XML data to the specific urls for each type of request.
If you need assistance using our web services, please contact us
Important: Read the XML-Response you receive back from our system as it will explain any possible errors in the XML you send to us.
Sample Request XML
View Sample Post Load Request XML
View Sample Edit Load Request XML
View Sample Delete Loads Request XML
Sample CURL request
View Sample CURL request in PHP
Response Codes and Valid Fields
View Data Field/Value Parameters
View Sample Load Response XML
Sample Post Loads Request XML
Please take note that the Order ID is a unique value, you cannot re-add a load with the same Order ID unless the previous one has been deleted.Posting URL: http://www.carloadboard.com/webservices/addloads.php
<?xml version="1.0"?>
<carloadboard>
<credentials>
<account>jdoe</account>
<webservicekey>jdoewebservicekey</webservicekey>
<requestid>jdoeinternalid</requestid>
</credentials>
<loads>
<load>
<order_id>123</order_id>
<origin_city>Atlanta</origin_city>
<origin_state>GA</origin_state>
<origin_zip>30308</origin_zip>
<destination_city>Norcross</destination_city>
<destination_state>GA</destination_state>
<destination_zip>30092</destination_zip>
<payment_amount>450.00</payment_amount>
<payment_method>quickpay</payment_method>
<cod_cop_amount>150.00</cod_cop_amount>
<cod_cop_method>comchek</cod_cop_method>
<cod_cop_timing>delivery</cod_cop_timing>
<trailer_type>open</trailer_type>
<date_available>2010-07-01</date_available>
<date_delivery>2010-07-01</date_delivery>
<additional_info>Deliver by July 10th.</additional_info>
<status>posted</status>
<vehicles>
<vehicle>
<year>2007</year>
<make>Honda</make>
<model>Civic</model>
<type>Car</type>
<operable>yes</operable>
</vehicle>
...
</vehicles>
</load>
...
</loads>
</carloadboard>
Sample Edit Load Request XML
In order to Edit a Load you must use their unique Order ID value, and you cannot edit a load that has already been deleted.Posting URL: http://www.carloadboard.com/webservices/editloads.php
Editing loads is similar to Posting Loads, but will only update existing loads.
All fields must be passed on edit, especially vehicles as they are not identified uniquely through webservices and will overwrite the previous vehicles for this load.
<?xml version="1.0"?>
<carloadboard>
<credentials>
<account>jdoe</account>
<webservicekey>jdoewebservicekey</webservicekey>
<requestid>jdoeinternalid</requestid>
</credentials>
<loads>
<load>
<order_id>123</order_id>
<origin_city>Atlanta</origin_city>
<origin_state>GA</origin_state>
<origin_zip>30308</origin_zip>
<destination_city>Norcross</destination_city>
<destination_state>GA</destination_state>
<destination_zip>30092</destination_zip>
<payment_amount>450.00</payment_amount>
<payment_method>quickpay</payment_method>
<cod_cop_amount>150.00</cod_cop_amount>
<cod_cop_method>comchek</cod_cop_method>
<cod_cop_timing>delivery</cod_cop_timing>
<trailer_type>open</trailer_type>
<date_available>2010-07-01</date_available>
<date_delivery>2010-07-01</date_delivery>
<additional_info>Deliver by July 10th.</additional_info>
<status>posted</status>
<vehicles>
<vehicle>
<year>2007</year>
<make>Honda</make>
<model>Civic</model>
<type>Car</type>
<operable>yes</operable>
</vehicle>
...
</vehicles>
</load>
...
</loads>
</carloadboard>
Sample Delete Load Request XML
Only delete loads if they are not going to be reposted. You can edit the status to pending to keep them unposted until you want them posted again.Posting URL: http://www.carloadboard.com/webservices/deleteloads.php
Multiple loads can be deleted at once by adding multiple <load> blocks.
<?xml version="1.0"?>
<carloadboard>
<credentials>
<account>jdoe</account>
<webservicekey>jdoewebservicekey</webservicekey>
<requestid>jdoeinternalid</requestid>
</credentials>
<loads>
<load>
<order_id>2341234345</order_id>
</load>
...
</loads>
</carloadboard>
Sample PHP CURL request
$xml is the request XML code being passed to the script.$url is the posting URL as defined for each Request XML section.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml"));
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close ($ch);
Once completed the $response contains the results of your submission.
Data Field/Value Parameters
The following are the fields and parameters for the Post Load Request. Be sure to use the example XML code to get you started.| Credentials Fields | Allowed Values |
| account | This is your account username. (e.g. jdoe) |
| webservicekey | This is the webservice key found in your Shipper/Broker account under "Webservice Options" on your menu. |
| requestid | (optional) Can be any string value used as an internal ID for your company to keep track of requests submitted to CarLoadboard.com™. |
| Loads Fields | Allowed Values per Load |
| order_id | Unique Order identification number (This will allow you to edit and delete each load if required) (String, 20 Characters max) |
| origin_city | Origination City name (40 characters max) |
| origin_state | Origination State Abbreviation (2 characters max, uppercase) |
| origin_zip | Origination Zip Code (10 characters max, any string) |
| destination_city | Destination City name (40 characters max) |
| destination_state | Destination State Abbreviation (2 characters max, uppercase) |
| destination_zip | Destination Zip Code (10 characters max, any string) |
| payment_amount | Numeric payment value of the format ####.## (the 2 decimal places are required, no commas for delimiting allowed) |
| payment_method | Allowed Values: "none", "quickpay", "comchek" |
| cod_cop_amount | (optional) Numeric payment value of the format ####.## (if not empty the 2 decimal places are required, no commas for delimiting allowed) |
| cod_cop_method | (optional) Allowed Values: "none", "cash", "check" |
| cod_cop_timing | (optional) Allowed Values: "none", "pickup", "delivery" |
| trailer_type | Allowed Values: "open", "enclosed", "driveaway" |
| date_available | A valid date in the format YYYY-MM-DD |
| date_delivery | A valid date in the format YYYY-MM-DD, or enter "null", but do not leave empty. |
| additional_info | Any string (80 characters max) |
| status | Allowed Values: "pending", "posted" |
Each load contains vehicles. At least one vehicle is required for the load to be processed into the system.
| Vehicle Fields | Allowed Values per Vehicle |
| year | Any 4 digit year from 1000-2999 |
| make | Any string (30 character max) |
| model | Any string (30 character max) |
| type | Allowed Values: "car", "boat", "motorcycle", "pickup", "rv", "suv", "travel_trailer", "van", "other" |
| operable | Allowed Values: "yes", "no" |
View Sample Load Response XML
Response status code will either be "ok" or "error"
<?xml version="1.0"?>
<carloadboard>
<response>
<_timestamp>1278956146</_timestamp>
<_requestid>jdoewebservicekey</_requestid>
<_errors>
<_error>
<_errorcode>255</_errorcode>
<_errortext>Full error description</_errortext>
</_error>
...
</_errors>
<status>error</status>
</response>
</carloadboard>
About Us |
Features |
How It Works |
FAQ |
Blog |
Contact Us
Copyright CarLoadboard.com™ 2010 - 2013 ©. All Rights Reserved. - Terms of Service - Privacy Policy Questions? 513-881-1950
Web Services
Copyright CarLoadboard.com™ 2010 - 2013 ©. All Rights Reserved. - Terms of Service - Privacy Policy Questions? 513-881-1950
Web Services