List Loads


Description

This method is used to search and retrieve a list of loads and their data.

Authentication

Requires HTTP BASIC authentication.

HTTP Methods

Accepts GET requests.

URI

/api/creditor/{uuid}/loads.json

Path Variables

Name Required/Optional Description Validation
uuid required The UUID of the creditor in the system Creditor UUID should exist in the system.

HTTP Parameters

Name Required/Optional Description Validation
id optional The UUID of load Load UUID should exist in the system
originLatitude optional The Origin Latitude. If originLatitude is specified then originLongitude is required and it will search the loads inside the radius as specified by field originRadius.
originLatitude optional The Origin Latitude. If originLatitude is specified then originLongitude is required and it will search the loads inside the radius as specified by field originRadius.
originLongitude optional The Origin Longitude If originLongitude is specified then originLatitude is required and it will search the loads inside the radius as specified by field originRadius. for eg: originLongitude=-72.92
originRadius optional The Origin Radius in miles. Min is 25 and Max is 300. If originRadius is specified then originLatitude and originLongitude are required.
originStateOrProvince optional The Origin State Or Province code If you want to search more than one State Or Province, request the parameter multiple times in the URL. for eq: originStateOrProvince=IA&originStateOrProvince=DC
originCity optional The Origin City. If you want to search more than one city, request the parameter multiple times in the URL. for eq: originCity=Pittsburg&originCity=hobart If Origin City contains a space, replace that space with %20. for eq: originCity=Buena%20Park
originPostcode optional The Origin Post Code
originCountry optional The Origin Country Length should be 2 characters which represents country code. For eg: US for United States
destinationLatitude optional The Destination Latitude If destinationLatitude is specified then destinationLongitude is required and it will search the loads inside the radius as specified by field destinationRadius. for eg: destinationLatitude=42.18
destinationLongitude optional The Destination Latitude. If destinationLongitude is specified then destinationLatitude is required and it will search the loads inside the radius as specified by field destinationRadius. for eg: destinationLongitude=-72.92
destinationRadius optional The Destination Radius in miles Min is 25 and Max is 300.If destinationRadius is specified then destinationLatitude and destinationLongitude are required.
destinationStateOrProvince optional The Destination State Or Province code. If you want to search more than one State Or Province, request the parameter multiple times in the URL. for eq: destinationStateOrProvince=IA&destinationStateOrProvince=DC
destinationCity optional The Destination City If you want to search more than one city, request the parameter multiple times in the URL. for eq: destinationCity=Pittsburg&destinationCity=hobart If Destination City contains a space, replace that space with %20. for eq: destinationCity=Buena%20Park
destinationPostcode optional The Destination Post Code
destinationCountry optional The Destination Country Length should be 2 characters which represents country code. For eg: US for United States
fullOrLTL optional Full Load or Partial value can be F or LTL
postedWithin optional Loads posted within the time in minutes mentioned value can be -30 (i.e Last 30 minutes), -60 (i.e Last 1 Hour), -120 (i.e Last 2 Hour), -240 (i.e Last 4 Hour) or -480 (i.e Last 8 Hour)
postedSince optional Date from when the loads are postedThe Destination Country Value should be in format MM-dd-yyyy-HH-mm-ss.
equipment optional Type of Equipment Value can be AC, ALLFB, ALLRF, ALLVN, DD, DT, F, FBT, FH, FPE, FSD, FWS, FWT, FT, HB, HS, LB, MX, PO, R, RH, RPE, RG, SD, T, V, VH, VA, VF, VR, VV, VC, VPE, VFR, VT or VWF
availFromDate optional Available Dates should be greater and equal to the given date. Value should be in format MM-dd-yyyy.
availToDate optional Available Dates should be less then and equal to the given date. Value should be in format MM-dd-yyyy.
fromRate optional Minimum Rate for the Loads Value should be numeric
toRate optional Maximum Rate for the Loads Value should be numeric
fromWeight optional Minimum Weight for the Loads Value should be numeric
toWeight optional Maximum Weight for the Loads Value should be numeric
includeRemovedLoads optional Includes inactive loads Value should be y/Y or n/N
orderBy optional The field to be ordered Value can be originStartDate, originState, destinationCity, destinationState, postDate, equipment, distance, rate, weight, loadStatus or companyName. Default value is originStartDate
firstResult optional The index of the first result to return Must be 0 or greater.
maxResults optional The maximum number of results to return Default is 100. Max is 1000

Curl Example

Request

curl -k -u apiuser:test -X GET "https://www.factorsnetwork.com/api/creditor/e6aaa036-2121-d11d-dd33-869ffac113be/loads.json?originLatitude=42.18&originLongitude=-72.92&originRadius=25&originStateOrProvince=AB&originCity=hobart&fullOrLTL=F&postedWithin=-60&equipment=V"
						

Response

{
  "loadsResponse" : [ {
    "id" : "d6aaa036-2121-d11d-dd33-869ffac113be",
    "dispatchNumber" : "877-745-2118",
    "equipmentType" : null,
    "fullOrLTL" : "LTL",
    "dateAvailable" : "01/09/2014",
    "deliveryDate" : "07/10/2014",
    "pickUpPoint" : "Ephrata PA",
    "destination" : "Lexington KY",
    "hoursOld" : 1729.7,
    "company" : "Solutions Inc.",
    "distance" : 1925.0,
    "debtorUuid" : e7aaa036-2121-d11d-dd33-869ffac113be,
    "rate" : "$100.00",
    "weight" : 20.0,
    "length" : 0.0,
    "height" : 0.0,
    "width" : 0.0,
    "loadsCount" : 1",
    "loadStatus" : "Active"
  }, {
    "id" : "c6aaa036-2121-d11d-dd33-869ffac113be",
    "dispatchNumber" : "877-745-2118",
    "equipmentType" : null,
    "fullOrLTL" : "LTL",
    "dateAvailable" : "01/06/2014",
    "deliveryDate" : "07/07/2014",
    "pickUpPoint" : "Ephrata PA",
    "destination" : "Lexington KY",
    "hoursOld" : 1729.7,
    "company" : "Solutions Inc.",
    "distance" : 485.0,
    "debtorUuid" : "e7aaa036-2121-d11d-dd33-869ffac113be",
    "rate" : "$100.00",
    "weight" : 400.0,
    "length" : 0.0,
    "height" : 0.0,
    "width" : 0.0,
    "loadsCount" : 1,
    "loadStatus" : "Active"
  } ],
  "totalRecords" : 2
}

Note: Responses will not be pretty printed when using the API, but have been formatted here for documentation purposes.