Home/ Api / TRM

Overview

Tranzlogix aggregate Logistics data across Carriers, ELD Devices, Brokers, Shippers in US Transport market on line lively and thereby enables smart and smooth management of Load and delivery in time.
Tranzlogix have developed API and UI Interface that can readily integrate with Brokers, Carriers and Shippers through web service for exchange of information for this purpose.
This Interface enables Shippers, Brokers to get connected with carrier for their Load booking and Tracking information online.
Basically Tranzlogix already have online exchange of ELD device log information like GPS Tracking data, DVIR, HOS, Drivers, Vehicle, ELD Device with most of the popular ELD vendors in the US market and readily developed platform for integration.
The Shippers, Brokers and Carriers are get registered with Tranzlogix Truckergig portal and thereby get API authentication code. This API authentication code uniquely identifies the Shippers, Brokers and Carriers in the System and used for subsequent service call and interaction with Tranzlogix.
When Shipper or Broker Book a Load with Carrier, they can in parallel Identify the carrier in Tranzlogix Truckergig system and upload the Load information through UI interface or through API call.
On getting the Load and Carrier Information the Truckergig system get connected with the carrier and get the Driver or Vehicle assigned to the Load by Mapping the Driver ID or Vehicle ID to the Load Number.
Actual transaction between Shippers and Carriers or Brokers and Carriers happen in off line and the reference to these Transactions are tracked in Tranzlogix Truckergig

Authentication

Authentication https://api.truckergig.com/api/v1/userresource/authenticate
Description A username and password will be created for user and this API have to be used to get Authentication token for the username and password. Further all other API services have to use this Authentication token as mentioned above
Method POST

Request Parameters

Name Type Size Description
UserName String 30 User Name.
Password String 30 Password

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Token String Token

JSON response example:

eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJvcHR5bSIsImlzcyI6Imh0dHA6Ly93d3cudHJhbnpsb2dpeC5jb20vIiwiaWF0IjoxNTYyMjIwNzgzLCJleHAiOjE1NjIyMjEwODN9.3sdcp7oR1Ci0bQioveBZwSy6jTLQSeA6CZBhQpk0vBU

Carriers

Carriers https://api.truckergig.com/api/v1/clientcarriermappingresource/carriers
Description By providing the Authentication token this API will return the list of carriers attached to this account
Method GET

Request Parameters

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Carriers Object Carriers
Name Type Size Description
Carrier String 50 Carrier Name
Carrier Id Object Dot#,MC#,TLX#
Name Type Size Description
Dot# Integer 10 Dot Number
MC# String 10 Motor Carrier Number
Tlx# Integer 10 Trazlogix Carrier Number

JSON response example:

[
    {
    "carriers": [
      {
        "carrier": "providence",
        "carrierId": [
              {
            "name": "MC#",
            "value": "MC-851622"
            },
              {
            "name": "DOT#",
            "value": "1803778"
            },
              {
            "name": "TLX#",
            "value": "164"
            }
        ],
        }
      ]
    }
]

ELDVendors

ELDVendors https://api.truckergig.com/api/v1/clienteldmappingresource/eldvendors
Description By providing the Authentication token this API will return the list of ELD vendors attached to this account
Method GET

Request Parameters

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
EldVendor String ELDVendor Name
EldVendor Id Integer EldVendor Id

JSON response example:

[
   {
    "eldVendors": [
      {
        "eldvendor": "Fleetmatics",
        "eldvendorId": 39
      }
    ]
   }
]

Drivers

Drivers https://api.truckergig.com/api/v1/driverresource/drivers?carrier=Providence&eldvendor=fleetmatics&page=1
Description By providing the Authentication token this API will return the list of drivers attached to this account.
Method GET

Request Parameters

Name Type Size Description
CarrierName String 50 Carrier Name
ELDVendor Name String 10 EldVendor Name
PageNo Integer 10 Page Number

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Pagination Object Pagination Info
Name Type Description
Current Page Integer Current Page No.
Hasnextpage Boolean Next page availabe or not
Hasprevpage Boolean Previous page availabe or not
Size Integer Size of the page
Totalpages Integer Total No of pages
Driver Object Driver Info
Name Type Description
Driverid Integer Driver Id
Drivercode Integer Driver Code
Driverid-tlx Integer Tranzlogix Driver Id
Name String Driver Name
Firstname String First Name
Lastname String Last Name
IsActive boolean Active driver
Current-vehicle-id Integer Driver assign to the vehicle
Licensenumber String Driver License Number
Licensestate String License taken in the state
Phone String Driver Phone Number
Email String Driver Email-id
EldVendorId Integer Eldvendor No which is assigned to the vehicle
EldVendorName String EldName which is assigned to the vehicle
CarrierId Integer Carrierid for whom the driver running the vehicle
CarrierName String Carriername for whom the driver running the vehicle

JSON response example:

[
   {
    "Pagination": {
    "CurrentPageNo": 1,
    "HasNextPage": false,
    "HasPrevPage": false,
    "Size": 17,
    "TotalPages": 1
    },
    "Drivers": [
      {
    "driverId": 42,
    "driver-code": null,
    "driver-id-tlx": 14180,
    "name": "Ramiro Villarreal",
    "first-name": "Ramiro",
    "last-name": "Villarreal",
    "isActive": true,
    "current-vehicle-id": null,
    "license-number": null,
    "license-state": null,
    "phone": "9565698061",
    "email": "ramjonvilla816@yahoo.com",
    "eldvendorId": "39",
    "eldVendor": "Fleetmatics",
    "CarrierId": "164",
    "Carrier-name": "Providence"
    },
      {
    "driverId": 1807,
    "driver-code": null,
    "driver-id-tlx": 14181,
    "name": "Geronimo Puente",
    "first-name": "Geronimo",
    "last-name": "Puente",
    "isActive": true,
    "current-vehicle-id": null,
    "license-number": null,
    "license-state": null,
    "phone": "9562077084",
    "email": "puentejerry@gmail.com",
    "eldvendorId": "39",
    "eldVendor": "Fleetmatics",
    "CarrierId": "164",
    "Carrier-name": "Providence"
    },...]
  }
]

Vehicles

Vehicles https://api.truckergig.com/api/v1/vehiclesresource/vehicles?carrier=Providence&eldvendor=fleetmatics&page=1
Description By providing the Authentication token in the request Header and the Carrier Name and EldVendor Name in the query string parameter this API will return the list of Vehicles attached to this account for the particular carrier and eld vendor.
Method GET

Request Parameters

Name Type Size Description
CarrierName String 50 Carrier Name
ELDVendorName String 10 EldVendor Name
PageNo Integer 10 Page Number

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Pagination Object Pagination Info
Name Type Description
Current Page Integer Current Page No.
Hasnextpage Boolean Next page availabe or not
Hasprevpage Boolean Previous page availabe or not
Size Integer Size of the page
Totalpages Integer Total No of pages
Vehicle Object Vehicle Info
Name Type Description
VehicleId Integer VehicleId
Enginehours Integer Engine Hours
tlx-id Integer Tranzlogix VehicleId
Name String Vehicle Name
License-plate String License Plate No
VIN String VehicleIdentificatinNo
Model String VehicleModel
Year Integer year
DeviceId String DeviceId
EldVendorId Integer Eld Vendor Id
CarrierId Integer Carrier Id
Carrier Name String Carrier Name

JSON response example:

[
   {
    "Pagination": {
    "CurrentPageNo": 1,
    "HasNextPage": false,
    "HasPrevPage": false,
    "Size": 23,
    "TotalPages": 1
    },
    "Vehicles": [
      {
    "vehicleId": "20",
    "engineHours": null,
    "id-tlx": 1545,
    "name": null,
    "license-plate": "20",
    "VIN": "20",
    "model": null,
    "year": null,
    "device-id": "R372270",
    "eldvendorId": 39,
    "CarrierId": 164,
    "Carrier-name": "Providence"
    },
      {
    "vehicleId": "161807J",
    "engineHours": null,
    "id-tlx": 1546,
    "name": null,
    "license-plate": "1807",
    "VIN": "161807J",
    "model": null,
    "year": "2006",
    "device-id": "R199809",
    "eldvendorId": 39,
    "CarrierId": 164,
    "Carrier-name": "Providence"
    }...
    ]
  }
]

Location Information

Location Information https://api.truckergig.com/api/v1/trackingdataresource/locationdata?id=3AKJGLD56FSGB0981&idType=VIN&eldVendor=Fleetmatics
Description By providing the Authentication token in the request Header and the edl Vendor Name and vehicle id in the query string parameter this API will return the list of Vehicles and the location information of the vehicle attached to this account for the particular carrier and eld vendor
Method GET

Request Parameters

Name Type Size Description
Id String 10 Vehicle Identification No.
IdType String 100 Any of these types(VIN/DeviceId)
Vendor String 100 Name of the ELD

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
LicensePlateNo String LicensePlateNo
DeviceId String Device Id
Speed String Speed/span>
Odometer String Odometer
Date String Date
DateUTC String DateUTC
Latitude String Latitude
Longitude String Longitude
Location String Location of the Vehicle

JSON request example:

Based on VIN

JSON response example:

[
{
"latitude": "35.838656",
"longitude": "-88.089129",
"speed": "110.69999694824219",
"license_Plate_No": "22",
"device_Id": "R345423",
"identification_No": "3AKJGLD56FSGB0981",
"date_UTC": "2019-07-04 06:05:25.0",
"odom": null,
"location": "I-40,,Holladay,TN,USA,38341"
}
]

History Information

History Information https://api.truckergig.com/api/v1/trackingdataresource/history/2920914/geotab?vehicleId=&startDate=&endDate=&page=1
Description By providing the Authentication token in the request Header and the dot no , eld vendor name , vehicleId ,start date, end date in the query string parameter this API will return the tracking history of the vehicle attached to this account for the particular carrier and eld vendor.If the vehcile id is not passed in the query parameter all the vehicles history attached to that carrier for the eld vendor displayed. If startDate is not passed current date history information displayed.If the startdate and enddate is passed in query parameter history information displayed for the particular date range and start date not beyond the 30 days from current date
Method GET

Request Parameters

Name Type Size Description
Dot No Integer 10 Carrier Dot#.
EldVendor Name String 100 ELD Vendor Name
VehicleId String 100 Vehicle Id
Start Date String 10 Start Date
End Date String 10 End Date

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Size Description
EldId Integer 10 EldId
Eld VendorName String 20 Eld VendorName
Truck Object Truck Information
Name Type Size Description
Truck Id String 50 Truck Id
Device Id String 25 Device Id
Number String 25 Vehicle Number
Licenseplateno String 2 License Plate No
Year Integer 4 Phone Number
Model String 10 Model
VIN String 20 Vehicle Identification No
Traliler String Trailer
Location History Object Location History
Name Type Size Description
Last Modified At String 50 Last Modified At
Location Info Object Location Info
Name Type Size Description
Location Address String 150 Location Address
Position Object Position Info
Name Type Size Description
Latitude String 20 Latitude
Longitude String 20 Longitude
Accuracy String 20 Accuracy

JSON request example:

Based on VIN

JSON response example:

{
"Pagination": {
"CurrentPageNo": 1,
"HasNextPage": true,
"HasPrevPage": false,
"Size": 30,
"TotalPages": 5
},
"History": {
    "eld-id": 2,
    "eld-name": "Geotab",
        "assets": [
              {
            "truck": {
            "truck-id": "G75E20E04ED0",
            "device-id": "b7",
            "number": null,
            "license": "G75E20E04ED0",
            "year": null,
            "model": null,
            "VIN": "b7"
            },
        "trailers": null,
        "location-history": [
          {
        "last-modified-at": "2019-07-12T00:00:52",
        "location-info": {
        "location-address": null,
        "position": {
        "lat": "41.8008308",
        "lon": "-83.6944656",
        "accuracy": null
        }
        }
        },
          {
        "last-modified-at": "2019-07-12T00:10:46",
        "location-info": {
        "location-address": null,
        "position": {
        "lat": "41.8008308",
        "lon": "-83.6944656",
        "accuracy": null
        }
        }
        },
          {
        "last-modified-at": "2019-07-12T00:20:40",
        "location-info": {
        "location-address": null,
        "position": {
        "lat": "41.8008308",
        "lon": "-83.6944656",
        "accuracy": null
        }
        }
        }...]]}}

Create Carrier in TruckerGig

Create Carrier in TruckerGig https://truckergig.com/loadapi/v1/carrier/
Description Broker or Shipper shall create a Carrier for their Load in Tranzlogix System through this service.
Method POST

Request Parameters

Name Type Size Description
Name String 50 Carrier Name
SCAC String 10 Standard Carrier Alpha Code
MC String 10 MC number is for all other carriers and brokers
MX String 10 MX Number is assigned to carriers domiciled in Mexico
FF String 10 Freight Forwarders Number
Contact Object Contact Info
Name Type Size Description
street_address String 50 Street Address
postal_code String 5 Postal Code
city String 25 City
country String 2 CountryCode
phone String 10 Phone Number
email String 50 Email

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Status String Whether the request is Success/Fail
Carrier SCAC Object Standard Carrier Alpha Code

JSON response example:

[
    { 
    "Status":"Success", 
    "Carrier SCAC": "by673" 
    }
]

Choose Valid Carrier

Choose Valid Carrier https://truckergig.com/loadapi/v1/carrier/{scacid}
Description Broker or Shipper can check or choose a Carrier for their Load in Tranzlogix System through this service.

The Carrier is identified by SCAC code in Tranzlogix Truckergig, If the valid code is found in the system this service will return the details of the Carrier there by the chosen carrier is validated.
Method GET

Request Parameters

Name Type Size Description
SCAC String 10 Uniquely identify the Carrier. Standard Carrier Alpha Code.

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Status String Whether the request is Success/Fail
Carrier String Carrier Name
CarrierInfo Object Carrier Information
Name Type Size Description
street_address String 50 Street Address
postal_code String 5 Postal Code
city String 25 City
country String 2 CountryCode
phone String 10 Phone Number
email String 50 Email
CarrierCode Object Carrier Code
Name Type Size Description
name String 50 Carrier Code Name
value String 5 Carrier Code Value

JSON response example:

[
    { "Status":"Success", 
      "Carrier": "Amex_Trucking_company", 
      "Carrier_Info":{
           "street_address":"Teststreet 10 A 34",
            "poatal_code":"70100", 
            "city":"Kuopio", 
            "country":"FI", 
            "phone":"0401231234",
             "email":"example@example.com" 
         } , 
      "Carriercode":[ 
          { "name":"SCAC#", 
            "value":"1234" 
          }, 
          { "name":"MC#", 
            "value":"MAZS92A004"
           }, 
           { "name":"MX#", 
             "value":"1234" 
           }, 
           { "name":"FF#",
             "value":"1234" 
           }
        ]
    }
]

Assign Load to Carrier in TruckerGig

Assign Load to Carrier in TruckerGig https://truckergig.com/loadapi/v1/assignLoad/
Description Broker or Shipper shall be able to assign a load to the carrier already been created in the Truckergig CRM.

The Carrier is identified by SCAC code in Tranzlogix Truckergig and the Load is identified by the Load Number..
Method POST

Request Parameters

Name Type Size Description
SCAC String 10 Uniquely identify the Carrier. Standard Carrier Alpha Code.
LoadNumber String 10 Load Number
LoadNumber_Date String 10 Load Number Date
PO String 10 Purchase Order Number
PO_Date String 10 Purchase Order Date
BOL String 10 Bill Of Lading Number
BOL_Date String 10 Bill Of Lading Date

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Status String Whether the request is Success/Fail
Carrier SCAC String Carrier SCAC
Load Number String Load Number
Load Number Date String Load Number Date

JSON response example:

[
    { 
      "Status":"Success",
      "Carrier SCAC": "by673", 
      “LoadNumber”:” MAZ6732309”,
      “LoadNumber_Date”: ” 15-12-2018” 
    }
]

Get Assigned Load to the Carrier

Get Assigned Load to the Carrier https://truckergig.com/loadapi/v1/assignLoad/{scacid}/{loadnumer}
Description On executing the Purchase Order, Bill of Lading with the carrier the details of the Load with PO, BOL or Load Number reference can be uploaded to the Truckergig through UI or API interface. This service will get the details of the Load and the carrier mapping information.
Method POST

Request Parameters

Name Type Size Description
SCAC String 10 Uniquely identify the Carrier. Standard Carrier Alpha Code.
LoadNumber String 10 Load Number

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Status Object Load Status
Name Type Size Description
Code String 5 Carrier Code
Description String 100 Description of Loads
Load Info Object Load Information
Name Type Size Description
Miles Integer 10 Miles
Weight Integer 10 Weight
Quantity Integer 10 Quantity
Commodity String 50 Commodity
Equipment Type String 10 Equipment Type
Temprature String 10 Temprature
Length Integer 10 Length
Width Integer 10 Width
Height Integer 10 Height
Pickup Object Pickup Details
Name Type Size Description
From String 50 Carrier Code
EarliestTime String 30 EarliestTime
LatestTime String 30 LatestTime
Delivery Object Delivery Details
Name Type Size Description
From String 50 Carrier Code
EarliestTime String 30 EarliestTime
LatestTime String 30 LatestTime
Load Reference Object Load Reference
Name Type Size Description
name String 50 Load Reference Name
Value String 50 Load Reference Value
Broker Info Object Broker Information
Name Type Size Description
Broker String 50 Broker Name
Company Phone String 10 Broker Company Phone
Company Fax String 10 Broker Company Fax
Agent Name String 50 Agent Name
Agent Phone String 10 Agent Phone
Agent Fax String 10 Agent Fax
Address String 10 Broker Address
Name Type Size Description
Street_address String 100 Street Address
Postal_code String 5 Postal Code
Carrier Info Object Carrier Information
Name Type Size Description
Carrier String 50 Carrier Name
Phone String 10 Carrier Phone
Fax String 10 Carrier Fax
Contact Name String 30 Contact Name
Dispatch Email String 30 Dispatch Email

JSON response example:

[
    {
      "Status":{
            "Code":"", 
            "Description":""
       } , 
       "Load_Info":{ 
            "Miles":"975",
             "Weight":"2400",
             "Quantity":"25", 
             "Commodity":"Floor Loaded Mattresses", 
             "Equipment Type":"Van",
             "Temprature":"", 
             "Length":"", 
             "Width":"", 
             "Height":"", 
             "PickUp":{
                "From":"1676 Montgomery Hwy. Dothan, AL 36303", 
                "EarliestTime":"11/10/2018 07:00",
                "LatestTime":"11/10/2018 08:00" 
              },
             "Delivery":{
                "To":"7402 Hodgson Memorial Ste 105 Savannah, GA 31406", 
                "EarliestTime":"11/10/2018 07:00",
                "LatestTime":"11/10/2018 08:00"  
              } ,
             "Load_Reference":[ 
                {
                 "name":"PO", 
                 "value":"1234"
                }, {
                 "name":"BOL",
                 "value":"MAZS92A004" 
                }, { 
                  "name":"BOL_Date",
                   "value":"15-10-2018" 
                }, { 
                  "name":"LoadNumber", 
                  "value":"MAZS92A004"
                }, { 
                  "name":"LoadNumber_Date", 
                  "value":"15-10-2018" 
                }
              ],
             "Broker_Info":{
                "Broker":"Blue Star Logistics",
                "Company Phone":"(800)-666-7200",
                "Company Fax":"(888)-611-8954", 
                "Agent Name":"Corey Hardee", 
                "Agent Phone":"(260)-755-4389",
                "Agent Fax":"(000)-000-0000",
                "Address":{
                    "street_address":"875 Old Roswell Road Suite $G-300 Roswell GA",
                    "poatal_code":"30076"
                 },
                "Carrier_Info":{
                    "Carrier":"On Time Transport LLC",
                    "Phone":"(402)-328-9082",
                    "Fax":"25", 
                    "Contact Name":"Stephen",
                    "Dispatch Email":"example@example.com" 
                }
            }
]

Assign Vehicle/Driver/Device to the Load by Carrier in TruckerGig

Assign Vehicle/Driver/Device to the Load by Carrier in TruckerGig https://truckergig.com/loadapi/v1/assignVehicle/
Description Carrier shall be able to assign his load to the Vehicle or Driver or Device in the Truckergig CRM.
The Carrier is identified by SCAC code in Tranzlogix Truckergig and the Load is identified by the Load Number. Carrier can link the load to his Vehicle or Driver or to the tracking device..
Method POST

Request Parameters

Name Type Size Description
SCAC String 10 Uniquely identify the Carrier. Standard Carrier Alpha Code.
LoadNumber String 10 Load Number
LinkBy Integer 1 LinkBy 0: by vehicle 1: by Driver 2: by Device
AssertId Integer 10 The assetId shall be the corresponding asset Id of the Vehicle or Driver or the Device in the system.

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Status String Whether the request is Success/Fail
Carrier SCAC String Carrier Code
Load Number String Load Number
AssetId Integer The assetId shall be the corresponding asset Id of the Vehicle or Driver or the Device in the system.

JSON response example:

[
    { 
        "status":"Success",
        "carrier SCAC": "by673", 
        “loadNumber”:” MAZ6732309”, 
        “assetId”: ” 9612303” 
    }
]

Get Vehicle/Driver to the Load

Get Vehicle/Driver to the Load https://truckergig.com/loadapi/v1/getVehicle/{scacid}/{loadNumber}
Description Through ELD Integration channel of Tranzlogix the Carrier can Identify their Driver and Vehicle in the Tranzlogix and can readily Map the Load reference to the assigned Driver or Vehicle. This request been sent to the Carrier and shall get the Driver or Vehicle Reference.
Method GET

Request Parameters

Name Type Size Description
SCAC String 10 Uniquely identify the Carrier. Standard Carrier Alpha Code.
LoadNumber String 10 For the Carrier code the Load Number may be PO Number or BOL Number. Which Identifies the Load

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Status String Whether the request is Success/Fail
Person Id Integer Person Id
Assign Date String Assign Date
Driver Name String Driver Name
Co-Drivers String Co-Drivers
CarrierId String CarrierId
Carrier Name String Carrier Name
Carrier Address String Carrier Address
Home-Terminal-Address String Home-Terminal-Address
Truck Object Truck
Name Type Size Description
Truck-id Integer 50 Truck-id
Vin_number String 30 Vehicle Identification Number
license String 30 license plate no
Device Object Device
Name Type Size Description
Device-id Integer 50 Device-id
Device_type String 30 Device_type
SSID String 30 SSID
Load Reference Object Load Reference
Name Type Size Description
Name Integer 50 Load Reference Name
Value String 30 Load Reference Value
Trailers String Load Reference Value
Shipments String Shipments
Remarks String Remarks

JSON response example:

[
    { 
      "Status":"Success",
      "person-id": "1", 
      "assign_date": "2014-05-23",
      "driver-name": "Lee Payne",
      "co-drivers": "Dan Collens", 
      "carrier_id":"89T633",
      "carrier-name": "Renegade Trucking",
      "carrier-address": "1401 Russell St, Baltimore, MD, 21230", 
      "home-terminal-address": "123 Another St", 
      "truck": {
          "truck-id": "22",
          "vin_number": "133iOS", 
          "license": "ALYJ 633"
       }, 
      "Device": { 
          "device-id": "22",
          "device_type": "133iOS",
          "SSID": "ALYJ 633"
       },
      "Load_Reference":[ {
          "name":"PO", 
          "value":"1234"
         },
         { "name":"PO_Date",
          "value":"12-10-2018" 
         }, 
         {"name":"BOL", 
          "value":"MAZS92A004"
         },
         { "name":"BOL_Date",
           "value":"15-10-2018" 
         },
         { "name":"LoadNumber",
           "value":"MAZS92A004"
         },
         { "name":"LoadNumber_Date",
           "value":"15-10-2018" 
       } ],
     "trailers": "4127 ",
     "shipments": "Q109A88667",
     "remarks": "Extreme weather caused unusual delay on this date.", 
 }
]

Start Tracking the Load.

Start Tracking the Load. https://truckergig.com/loadapi/v1/starTracking/
Description Broker, Shipper and Carrier shall be able to trigger or initiate the tracking of the Load. By default, the tracking data will not be available and exposed unless this service is called in the Truckergig CRM.
The Carrier is identified by SCAC code in Tranzlogix Truckergig and the Load is identified by the Load Number.
Method PUT

Request Parameters

Name Type Size Description
SCAC String 10 Standard Carrier Alpha Code.
Load Number String 10 If the Load and the Carrier are assigned to the Vehicle, then this service will initiate the tracking.

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Status String Whether the request is Success/Fail
carrier SCAC String carrier SCAC
Load Number String Load Number
assetId Integer assetId

JSON response example:

[
{ 
    "status":"Success", 
    "carrier SCAC": "by673", 
    “loadNumber”:” MAZ6732309”, 
    “assetId”: ” 9612303” 
}
]

Stop Tracking the Load.

Stop Tracking the Load. https://truckergig.com/loadapi/v1/stopTracking
Description Broker, Shipper and Carrier shall be able stop or hold the tracking of the Load. By default, the tracking data will not be available and exposed unless the start tracking service is called in the Truckergig CRM.
Once again this stop Tracking service can stop tracking the Load and the tracking data will not available to view.
The Carrier is identified by SCAC code in Tranzlogix Truckergig and the Load is identified by the Load Number..
Method PUT

Request Parameters

Name Type Size Description
SCAC String 10 Standard Carrier Alpha Code.
Load Number String 10 If the Load and the Carrier are assigned to the Vehicle, then this service will initiate the tracking.

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
Status String Whether the request is Success/Fail
carrier SCAC String carrier SCAC
Load Number String Load Number
assetId Integer assetId

JSON response example:

[
{ 
    "status":"Success", 
    "carrier SCAC": "by673", 
    “loadNumber”:” MAZ6732309”, 
    “assetId”: ” 9612303” 
}
]

Get History.

Get Load Tracking History. https://truckergig.com/loadapi/v1/history/{scacid}/{ELDId}/{VehicleId}/{startdate}/{enddate}
Description This API shall return the history of the location of the vehicle for 30 days. This history is for a particular Carrier and ELD vendor and for the given date range. If the date range is not provided it will return the current date location of all the vehicles. If vehicle id is provided it will filter and return only for that particular vehicle.
Method GET

Request Parameters

SCAC/DOT ELDId VehicleId StartDate EndDate
SCAC String 10 Standard Carrier Alpha Code.
ELDId Integer 11 The ELD vendor id provided by Tranzlogix. Example 15 is the ID provided for Samsara. The on boarded ELD vendor list with IDs can be provided through excel sheet on demand or API service can be used to get the list of ELD vendor name and .
VehicleId Integer 11 If vehicle id is provided then it will filter the history for that particular vehicle else it will return history for all the vehicles under the ELD vendor
StartDate Integer 11 The start date is by maximum 30 days from the current date, If not given it will return the current date location only
EndDate Integer 11 If end date is not given it will take the current date as end date,

Response Codes

HTTP Status Code Description
200-OK Successful
201-Created Created
400-BadRequest Bad input parameter. Error message should indicate which one and why
401 Unauthorized The client passed in the invalid Auth token. Client should refresh the token and then try again.

Response Parameters

Name Type Description
eld-id Integer EldId
eld-name String eld-name
AssetInfo Object Asset Details and location details

JSON response example:

[
{"eld-id": 15, 
 "eld-name":"Samsara", 
 "assets":[ 
    { "truck": 
            { "truck-id": "22", "device-id":"8913k993", "number": "133iOS", "license": "ALYJ 633", "year": "2010", "model": "Toyota", "VIN":"JA32U2FU3FU663033", },
     "trailers": "4127 ", 
     "location-history":
             [ {"last-modified-at": "2019-04-20T20:53:49.386Z",
              "location-info":
                    { "location-address": "Kitchener, ON",
                    "position":
                         { "lat": 43.421225, "lon": -80.502228, "accuracy": 5 } 
                     } 
                },
                { "last-modified-at": "2019-04-19T18:53:49.386Z", 
                "location-info":
                    { "location-address": "446 Illinois Street Tullahoma, TN 37388",
                    "position":
                     { "lat": 35.385810, "lon": -86.227110, "accuracy": 5 } } }, 
                     { "last-modified-at": "2019-04-18T04:53:49.386Z",
                "location-info":
                    { "location-address": "9059 Golden Star Street  Cartersville, GA 30120", 
                    "position": 
                        { "lat": 43.061270, "lon": -87.582940, "accuracy": 5 } } } ] } ,
                 {"truck": 
                    { "truck-id": "23", 
                     "device-id":"8913lo996", "number": "1891iOS", "license": "XNYJ 972", "year": "2010", "model": "Toyota", "VIN":"3VWSH29M71M073073", },
                   "trailers": "4127 ", 
                   "location-history": [
                     {"last-modified-at": "2019-04-18T20:53:49.386Z", "location-info":{ "location-address": "705 Gates Street Clinton, MD 20735", "position": { "lat": 38.767040, "lon": -76.897400, "accuracy": 5 } } }, 
                     { "last-modified-at": "2019-04-17T18:53:49.386Z", "location-info":{ "location-address": "776 Broad Court Manchester, NH 03102", 
                     "position":
                      { "lat": 42.988980, "lon": -71.495920, "accuracy": 5 } } },
                      { "last-modified-at": "2019-04-16T04:53:49.386Z"

                    "location-info":{ "location-address": "67 Vine Drive Greenville, NC 27834", 
                    "position": 
                     { "lat": 35.672450,
                       "lon": -77.439440,
                       "accuracy": 5 
                   } 
               }
             }
         ] 
     } 
     ]
     } 

]