Portal API Docs

# Rating

# Get rates

This is the most important endpoint of our API; below you will find how to create a load and get our available rates for transportation.

from is an object with the basic information of the location from which the load is sent:

zip_code: Data type: string with the zip code number.
city: A data type string with the name of the origin city state: A data type string with the abbreviation of the origin state name in capital letters.
country: data type string with the abbreviation of the origin country name in capital letters.

to is an object with basic information about where the load is going:

zip_code: Data type: string with the zip code number.
city: A data type string with the name of the destination city or state: A data type string with the abbreviation of the destination state name in capital letters.
country: data type string with the abbreviation of the destination country name in capital letters.

Caution

We currently only support lanes in two countries: the United States (US) and Canada (CA).

line_items is an array of objects. Each object is a single 'line item," which represents the characteristics and necessary information of an order, such as dimensions, weight, and quantity.

handling_unit_count: Data type number with the number of items for that handling unit.
handling_units: A data type string referring to any packaging unit and the goods it contains.

TIP

Available handling unit options:

Bags, Bales, Barrels, Bins, Baskets, Bottles, Boxes, Bundles, Canisters, Carboys, Cartons, Coils, Containers, Crates, Cylinders, Drums, Kegs, Packages, Pallets, Pieces, Reels, Rolls, Skids, Spools, Tanks, Trays, Truckloads, Tubes

length: Data type a float with length dimensions.
width: Data type: a float with width dimensions.
height: Data type: a float with height dimensions.
weight: Data type: a float with weight of line item.
description: A data type string with a brief description of the item cannot be equal to "general", "general cargo", "commodity" or "fak".
hazardous_materials: Data type: boolean that indicates if the element is hazardous or not.
stackable: Data type is a boolean that indicates if the element is stackable or not.

accessorials are an array of strings. Each string is an 'accessorial_id', representing additional services that the carrier could provide; some accessorials may generate surcharges in the carrier price.

accessorials: []

TIP

If you want to know more about accessorials, click here.

cargo_value: The cost of the goods to the shipper with its original invoice.
mode: Optional field type string used to define the load mode and quotes to request.

TIP

Our rating API allows users to access parcel, LTL, FTL, and expedited quotes. Available options:

LTL: includes parcel, LTL, and volume LTL quotes.

PARCEL: includes only parcel and local carriers.

FTL: includes full truckload dry van 53 quotes, In this mode, dimensions and handling unit count are not mandatory and not required in the request.

EXP: includes cargo van, large straight van, small van, and sprinter van quotes.

REEFER: includes reefer full truckload dry van 53 quotes, In this mode, dimensions and handling unit count are not mandatory and not required in the request, temperature is in °F and must be between -20 and 70.

FLATBED: includes full truckload flatbed quotes.

# Current available modes by country

Mode US CA MX
LTL ✓ ✓ ✓
PARCEL ✓ ✓ ✓
FTL ✓ ✓ ✗
EXP ✓ ✗ ✗
REEFER ✓ ✗ ✗
FLATBED ✓ ✗ ✗

size_units: Optional field type string used to define the dimension units (the avalible units: in, ft, cms, mts).
weight_units: Optional field type string used to define the weight units (the avalible units: lbs, kgs, ton).

✏️ Important information

Portal handles certain standards with units of measure, by default it handles size_units in inch and weight_units in lbs.
You can use the other unit measures, the API converts these measures and will return them to the standard measure.


Make a POST request with the required object to the following endpoint:


POST /api/v1/rates

DEV URL: https://dev.webservices.goglt.com/api/v1/rates

PROD URL: https://webservices.goglt.com/api/v1/rates

# Request

This is code with real data to create a load.


{
   "from":{
      "zip_code":"33122",
      "city":"miami",
      "state":"FL",
      "country":"US"
   },
   "to":{
      "zip_code":"12345",
      "city":"schenectady",
      "state":"NY",
      "country":"US"
   },
   "line_items":[
      {
         "handling_unit_count":1,
         "handling_units":"Pallets",
         "length":10,
         "width":10,
         "height":10,
         "weight":10,
         "description":"Mechanical parts,",
         "hazardous_materials":false,
         "is_stackable":false
      }
   ],
   "accessorials":[],
   "estimated_pickup_date":"2023-04-26",
   "cargo_value":0,
   "mode":"FTL",
   "size_units": "in",
   "weight_units": "lbs"
}

# Response

TIP

The most important fields after creating and quoting a load are "load_id", "id" within each object "from" and "to," and "line item" used to interact with this load in the other endpoints; "carrier_id" is needed in the tender process click here. and "shp" used by our operations team to provide any kind of support, please save them.

{
   "load_id":"a0j7A000007bINfQAM",
   "shp":"SHP3067948",
   "from":{
      "zip_code":"33122",
      "city":"miami",
      "state":"FL",
      "country":"US",
      "id":"a0t7A0000029jrVQAQ"
   },
   "to":{
      "zip_code":"12345",
      "city":"schenectady",
      "state":"NY",
      "country":"US",
      "id":"a0t7A0000029jraQAA"
   },
   "line_items":[
      {
         "id":"a0g7A000001Q6nDQAS",
         "handling_unit_count":1,
         "handling_units":"Pallets",
         "length":10.0,
         "width":10.0,
         "height":10.0,
         "weight":10.0,
         "description":"Mechanical parts,",
         "hazardous_materials":false,
         "is_stackable":false,
         "nmfc_class": "70"
      }
   ],
   "accessorials":[],
   "cargo_value":26000.0,
   "carriers":[
      {
         "carrier_id":"641a76fde15e9a949fd74c7a",
         "used_liability":1.0,
         "new_liability":null,
         "transit_time":7,
         "service_class":"Standard Rate",
         "price":335.0,
         "direct_interline":null,
         "name":"AAA Cooper (LTL)",
         "prices_with_insurance":379.2,
         "pickup_performance":82.0,
         "delivery_performance":75.0,
         "expiration":"2023-04-20",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":null ,
         "scac": "AACT",
         "quote_number": "0040657170",
         "contract": "GL"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74c9c",
         "used_liability":1.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"Guarantee Amount 5 PM,",
         "price":310.0,
         "direct_interline":null,
         "name":"SAIA Motor Freight (LTL)",
         "prices_with_insurance":354.2,
         "pickup_performance":84.0,
         "delivery_performance":75.0,
         "expiration":"2023-03-28",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":null ,
         "scac": "SAIA",
         "quote_number": "VPRC396589437",
         "contract": "GL"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74ca2",
         "used_liability":5.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"Standard Rate",
         "price":396.0,
         "direct_interline":null,
         "name":"TForce Freight (LTL)",
         "prices_with_insurance":440.2,
         "pickup_performance":82.0,
         "delivery_performance":75.0,
         "expiration":"2023-04-20",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":10,
         "scac": "UPGF",
         "quote_number": "396589440",
         "contract": "GL"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74ca0",
         "used_liability":0.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"Standard Rate",
         "price":1187.0,
         "direct_interline":null,
         "name":"TForce Freight (VLTL)",
         "prices_with_insurance":1231.2,
         "pickup_performance":82.0,
         "delivery_performance":75.0,
         "expiration":"2023-03-28",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":10,
         "scac": "UPGF",
         "quote_number": "88fd2ea17a",
         "contract": "CTS"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74cac",
         "used_liability":0.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"3DaySelect",
         "price":28.0,
         "direct_interline":null,
         "name":"UPS 3DaySelect (Parcel)",
         "prices_with_insurance":72.19999999999999,
         "pickup_performance":97.0,
         "delivery_performance":97.0,
         "expiration":"2023-03-29",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":10,
         "scac": "UPSN",
         "quote_number": "rate_46301189ac0f4820b1c65d88fd2ea17a",
         "contract": "BA"
      }
   ]
}

The response object has the same fields as the request object, along with the following fields:

shp: Data type string is the name of the load, used by our operations department to identify the load in our internal system.

load_id: Data type string used to identify the load in the API requests.

line_items Data type array of objects with the same information was sent in the request, represents the line items associated with the load and extra properties.

nmfc_class: Data type string, the class is calculated by density and it MUST BE on the BOL.

carriers: a data type array of objects representing the carriers associated with the load.

carrier_id: Data type: string with the id of the quote used to tender the process.
used_liability: Data type float is the amount covered by the carrier if the cargo is used in any case of loss or damage (optional).
new_liability: Data type float is the amount covered by the carrier if the cargo is new in any case of loss or damage (optional).
transit_time is a data type integer with the transit time duration in days.
service_class: Data type: string with the name of the service provided by the carrier.
price: The data type floats with the cost of this quote in dollars.
direct_interline: The data type string is used to identify if the quote is "direct" or "interlined.".
name: Data type: string with the name of the carrier or model used.
prices_with_insurance: Data type float with the cost of this quote in dollars if the load is dispatched with insurance.
pickup_performance: Data type float is the carriers' indicator of pick-up performance, based on GLT's data (optional).
delivery_performance: Data type float is the carriers' indicator of delivery performance, based on GLT's data (optional).
expiration: data type string with date format yyyy-mm-dd with the expiration date of the quote.
is_expired: Data type: boolean to check if the quote is expired.
transit_time_hours: The data type number used to identify the transit time hours in the API requests (optional).
scac: Data type string is a single code used by every operator.
quote_number: Data type string identifies each carrier's tariff price.
contract: Data type string with unique identifier code for the carrier billing information.

# Rating with hazmat

The following attribute in the linte_items object is not mandatory in the rating request, they can be sent in both the rating and the tender request, however remember that if your load has any hazmat elements these will be required to proceed with the tender

hazmat is an object describing hazardous load information with the following attributes:

hazmat_class_division: Data type string with one of the nine classifications and their subdivision according to the material type.
hazmat_number_type: Data type string with the number type, This help identify hazardous international cargo traveling in the United States. Goods that aren't classified or regulated by the United Nations receive North American (NA).
hazmat_number: Data type string with four-digit numbers ranging from 0004-3534 that identify dangerous goods or hazardous substances.
hazmat_packaging_group: Data type string with classification defined by the level of danger presented by a hazardous material that is being packaged for shipment. In accordance with the degree of danger they present:

Packing group I: substances presenting high danger.

Packing group II: substances presenting medium danger.

Packing group III: substances presenting low danger.

Here is an example of how the above request would look like sending the hazmat information

{
   "from":{
      "zip_code":"33122",
      "city":"miami",
      "state":"FL",
      "country":"US"
   },
   "to":{
      "zip_code":"12345",
      "city":"schenectady",
      "state":"NY",
      "country":"US"
   },
   "line_items":[
      {
         "handling_unit_count":1,
         "handling_units":"Pallets",
         "length":10,
         "width":10,
         "height":10,
         "weight":10,
         "description":"Mechanical parts,",
         "hazardous_materials":true,
         "is_stackable":false,
         "hazmat": {
            "hazmat_class_division":"1.1",
            "hazmat_number_type":"UN",
            "hazmat_number":"2",
            "hazmat_packaging_group":"II"
         }
      }
   ],
   "accessorials":["a011I00000325ItQAI"],
   "estimated_pickup_date":"2023-04-26",
   "cargo_value":0,
   "mode":"FTL",
   "size_units": "in",
   "weight_units": "lbs"
}

Note that the request in the "accessorials" attribute is sending the id a011I00000325ItQAI of the accessorial associated to hazmat and that the first line item has a new object type attribute with the previously described fields.

# Get carriers by load ID

To get the carriers associated with a specific load, you need to include the following path parameter in your API request:

load_id: A string representing the ID of the requested load.

Make a GET request to the following API endpoint, including the required object in your request:


GET /api/v1/rates/{load_id}

DEV URL: https://dev.webservices.goglt.com/api/v1/rates/{load_id}

PROD URL: https://webservices.goglt.com/api/v1/rates/{load_id}

# Request

{
  "load_id": "a0j7A000007bQ1iQAE"
}

# Response

[
      {
         "carrier_id":"641a76fde15e9a949fd74c7a",
         "used_liability":1.0,
         "new_liability":null,
         "transit_time":7,
         "service_class":"Standard Rate",
         "price":335.0,
         "direct_interline":null,
         "name":"AAA Cooper (LTL)",
         "prices_with_insurance":379.2,
         "pickup_performance":82.0,
         "delivery_performance":75.0,
         "expiration":"2023-04-20",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":null ,
         "scac": "AACT",
         "quote_number": "0040657170",
         "contract": "GL"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74c9c",
         "used_liability":1.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"Guarantee Amount 5 PM,",
         "price":310.0,
         "direct_interline":null,
         "name":"SAIA Motor Freight (LTL)",
         "prices_with_insurance":354.2,
         "pickup_performance":84.0,
         "delivery_performance":75.0,
         "expiration":"2023-03-28",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":null ,
         "scac": "SAIA",
         "quote_number": "VPRC396589437",
         "contract": "BA"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74ca2",
         "used_liability":5.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"Standard Rate",
         "price":396.0,
         "direct_interline":null,
         "name":"TForce Freight (LTL)",
         "prices_with_insurance":440.2,
         "pickup_performance":82.0,
         "delivery_performance":75.0,
         "expiration":"2023-04-20",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":10,
         "scac": "UPGF",
         "quote_number": "396589440",
         "contract": "GL"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74ca0",
         "used_liability":0.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"Standard Rate",
         "price":1187.0,
         "direct_interline":null,
         "name":"TForce Freight (VLTL)",
         "prices_with_insurance":1231.2,
         "pickup_performance":82.0,
         "delivery_performance":75.0,
         "expiration":"2023-03-28",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":10,
         "scac": "UPGF",
         "quote_number": "88fd2ea17a",
         "contract": "CTS"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74cac",
         "used_liability":0.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"3DaySelect",
         "price":28.0,
         "direct_interline":null,
         "name":"UPS 3DaySelect (Parcel)",
         "prices_with_insurance":72.19999999999999,
         "pickup_performance":97.0,
         "delivery_performance":97.0,
         "expiration":"2023-03-29",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":10,
         "scac": "UPSN",
         "quote_number": "rate_46301189ac0f4820b1c65d88fd2ea17a",
         "contract": "GL"
      }
   ]

# Get requote

The following are the path parameters to requote a load:

load_id: Data type string representing the load to requote.
cargo_value: Data type number is the cost of the goods to the shipper with the original invoice.

Make a GET request with the required object to the following endpoint:


GET /api/v1/rates/requote/{load_id}?cargo_value={cargo_value}

DEV URL: https://dev.webservices.goglt.com/api/v1/rates/requote/{load_id}?cargo_value={cargo_value}

PROD URL: https://webservices.goglt.com/api/v1/rates/requote/{load_id}?cargo_value={cargo_value}

# Request

{
  "load_id": "a0j7A000007bQ1iQAE",
  "cargo_value": 0
}

# Response

{
   "load_id":"a0j7A000007bINfQAM",
   "shp":"SHP3067948",
   "from":{
      "zip_code":"33122",
      "city":"miami",
      "state":"FL",
      "country":"US",
      "id":"a0t7A0000029jrVQAQ"
   },
   "to":{
      "zip_code":"12345",
      "city":"schenectady",
      "state":"NY",
      "country":"US",
      "id":"a0t7A0000029jraQAA"
   },
   "line_items":[
      {
         "id":"a0g7A000001Q6nDQAS",
         "handling_unit_count":1,
         "handling_units":"Pallets",
         "length":10.0,
         "width":10.0,
         "height":10.0,
         "weight":10.0,
         "description":"Mechanical parts,",
         "hazardous_materials":false,
         "is_stackable":false,
         "nmfc_class": "70"
      }
   ],
   "accessorials":[],
   "cargo_value":26000.0,
   "carriers":[
      {
         "carrier_id":"641a76fde15e9a949fd74c7a",
         "used_liability":1.0,
         "new_liability":null,
         "transit_time":7,
         "service_class":"Standard Rate",
         "price":335.0,
         "direct_interline":null,
         "name":"AAA Cooper (LTL)",
         "prices_with_insurance":379.2,
         "pickup_performance":82.0,
         "delivery_performance":75.0,
         "expiration":"2023-04-20",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":null ,
         "scac": "AACT",
         "quote_number": "0040657170",
         "contract": "GL"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74c9c",
         "used_liability":1.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"Guarantee Amount 5 PM,",
         "price":310.0,
         "direct_interline":null,
         "name":"SAIA Motor Freight (LTL)",
         "prices_with_insurance":354.2,
         "pickup_performance":84.0,
         "delivery_performance":75.0,
         "expiration":"2023-03-28",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":null ,
         "scac": "SAIA",
         "quote_number": "VPRC396589437",
         "contract": "GL"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74ca2",
         "used_liability":5.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"Standard Rate",
         "price":396.0,
         "direct_interline":null,
         "name":"TForce Freight (LTL)",
         "prices_with_insurance":440.2,
         "pickup_performance":82.0,
         "delivery_performance":75.0,
         "expiration":"2023-04-20",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":10,
         "scac": "UPGF",
         "quote_number": "396589440",
         "contract": "BA"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74ca0",
         "used_liability":0.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"Standard Rate",
         "price":1187.0,
         "direct_interline":null,
         "name":"TForce Freight (VLTL)",
         "prices_with_insurance":1231.2,
         "pickup_performance":82.0,
         "delivery_performance":75.0,
         "expiration":"2023-03-28",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":10,
         "scac": "UPGF",
         "quote_number": "88fd2ea17a",
         "contract": "1A"
      },
      {
         "carrier_id":"641a76fee15e9a949fd74cac",
         "used_liability":0.0,
         "new_liability":null,
         "transit_time":3,
         "service_class":"3DaySelect",
         "price":28.0,
         "direct_interline":null,
         "name":"UPS 3DaySelect (Parcel)",
         "prices_with_insurance":72.19999999999999,
         "pickup_performance":97.0,
         "delivery_performance":97.0,
         "expiration":"2023-03-29",
         "is_expired":false,
         "load_id":"a0j7A000007bINfQAM",
         "transit_time_hours":10,
         "scac": "UPSN",
         "quote_number": "rate_46301189ac0f4820b1c65d88fd2ea17a",
         "contract": "GL"
      }
   ]
}

← Accessorials →