Tender

This section outlines the necessary data for tendering and specifies the data types required.

Tender load

The following data types and properties are required for a tender load:

carrier_id: Data type string that refers to the selected carrier id.
load_id: Data type string that refers to the selected load id.
insurance: Data type boolean indicating whether the load is secured.
billing_reference: Data type string unique identifier assigned to any financial transaction, an external TMS BOL number, should be included as part of the billing reference.
po_number: Data type string that is a unique identifying number assigned to a purchase order.
temperature: Optional data type with temperature needed in truck, must be between -70°F and 20°F, only needed if selected carrier is a REEFER truck.
dropoff_package: Data type boolean with default value false. If set to true, it signifies that no pickup scheduling will be arranged from the from_address. Instead, the customer is responsible for delivering the package to the carrier's office. Only available for parcel carriers.

from_address is an object with the general contact information of the load origin:

location_name: Data type string with the name of the pickup location.
street: Data type string with the origin street, max length 22.
contact_first_name: Data type string with the first name contact.
contact_last_name: Data type string with the last name contact.
contact_phone: Data type string with the number phone, this requires 10 digits, if it starts with 1 it must be 11 digits.
contact_email: Data type string with the contact email.
shipping_hours: Data type string with the hours when the supplier gives the product to the carrier, this requires HH:mm-HH:mm format, example: 08:30-12:00.
departure_date: Data type string with the date that your shipment will leave the origin port, this requires YYYY-MM-DD format, example: 2023-04-26.
references: Data type string, with reference places to get to the origin place.
instructions: Data type string, with the instructions to get to the origin location, max length 22.

to_address is an object with the general contact information of the load destination:

location_name: Data type string with the first name of the delivery location.
street: Data type string with the destination street, max length 22.
contact_first_name: Data type string with the first name contact.
contact_last_name: Data type string with the last name contact.
contact_phone: Data type string with the number phone, this requires 10 digits, if it starts with 1 it must be 11 digits.
contact_email: Data type string with the contact email.
references: Data type string, with reference places to get to the destination place.
instructions: Data type string, with the instructions to get to the destination location, max length 22.

line_items is an array of objects. Each object is a single 'line item' which represents characteristics and necessary hazmat information of an order:

item_id: Data type string with the id.
hazmat: Data type boolean that indicates whether the element is hazardous or not.

✏️

Important information

When it is a hazardous material, it is required to complete the object with the characteristics of the material.

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.

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

POST /api/v1/tender

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

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

Request without Hazmat

{
   "carrier_id":"643630dd3ce2add554e66c78",
   "load_id":"a0j7A000007bNuQQAU",
   "insurance": false,
   "from_address": {
      "location_name": "stop 1",
      "street": "123 st",
      "contact_first_name": "Cristian",
      "contact_last_name": "Bustamante",
      "contact_phone": "3178380708",
      "contact_email": "cbustamante@mailbox.com",
      "references": "Pickup references",
      "instructions": "Pickup instructions",
      "shipping_hours": "19:00-16:00",
      "departure_date": "2023-05-25"
   },
   "to_address": {
      "location_name": "stop 2",
      "street": "Canal 10 street",
      "contact_first_name": "house",
      "contact_last_name": "fake",
      "contact_phone": "3203157300",
      "contact_email": "housefake@correo.com",
      "references": "Delivery references",
      "instructions": "Delivery instructions",
      "receiving_hours": "10:30-16:00"
   },
   "line_items": [],
   "billing_reference": "1171541",
   "po_number": "",
   "dropoff_package": false
}

Request with Hazmat

{
   "carrier_id":"643630dd3ce2add554e66c78",
   "load_id":"a0j7A000007bNuQQAU",
   "insurance":false,
   "from_address": {
      "location_name": "stop 1",
      "street": "123 st",
      "contact_first_name": "Cristian",
      "contact_last_name": "Bustamante",
      "contact_phone": "3178380708",
      "contact_email": "cbustamante@mailbox.com",
      "references": "Pickup references",
      "instructions": "Pickup instructions",
      "shipping_hours": "19:00-16:00",
      "departure_date": "2023-05-25"
   },
   "to_address": {
      "location_name": "stop 2",
      "street": "Canal 10 street",
      "contact_first_name": "house",
      "contact_last_name": "fake",
      "contact_phone": "3203157300",
      "contact_email": "housefake@correo.com",
      "references": "Delivery references",
      "instructions": "Delivery instructions",
      "receiving_hours": "10:30-16:00"
   },
   "line_items":[
      {
         "item_id":"a0g7A000001ckR4QAI",
         "hazmat":{
            "hazmat_class_division":"1.1",
            "hazmat_number_type":"UN",
            "hazmat_number":"2",
            "hazmat_packaging_group":"II"
         }
      }
   ],
   "billing_reference": "1171541",
   "po_number": ""
}

  

WARNING

The line_items field must be sent as an empty array in most cases like the first example, however if the load has the "hazmat" accessorial you must specify the hazmat information for each line_item marked as true in the field "hazardous_materials" in the rating request like the second request example.

"line_items":[
   {
      "item_id":"a0g7A000001ckR4QAI",
      "hazmat":{
         "hazmat_class_division":"1.1",
         "hazmat_number_type":"UN",
         "hazmat_number":"2",
         "hazmat_packaging_group":"II"
      }
   }
]

Available values for hazmat fields:

class_division_values: "1.1", "1.2", "1.3", "1.4", "1.5", "1.6", "2.1", "2.2", "2.3", "3", "4.1", "4.2", "4.3", "5.1", "5.2", "6.1", "6.2", "7", "8", "9"
hazmat_number_type: "UN", "NA", "ID"
hazmat_packaging_group: "I", "II", "III", "N/A

Response

{
   "load_id":"string",
   "load_number":"string",
   "carrier_id":"string",
   "bol":"string",
   "shipping_labels":"string",
   "pickup_number":"string",
   "scac": "string",
   "quote_number": "string",
   "message": "string",
   "billing_information": {
      "carrier_billing_state": "string",
      "carrier_billing_zip_code": "string",
      "carrier_billing_name": "string",
      "carrier_billing_country": "string",
      "carrier_billing_city": "string",
      "carrier_billing_address": "string"
  }
}

load_id: Data type string representing the load related to tender.
carrier_id: Data type string that refers to the selected carrier id.
bol: Data type string with the url to bol document.
shipping_labels: Data type string with the url to shipping labels documents.
pickup_number: Data type string with carrier pick-up confirmation number. LTL , VLTL carriers and Parcel Carriers sent a confirmation number via API to confirm pick-up request has been scheduled. Please note not every GLT carrier has enabled pick-ups via API, so not every tender request will return a number.

TIP

Every successful pickup request will trigger a notification and the pickup will be processed internally by GLT, not external action will be required.

scac: Data type string is a single code used by every operator.
quote_number: Data type string identifies each carrier's tariff price.
message: Data type string with additional information about the requested office.
billing_information: Data type object with the carrier billing information.

TIP

If you are not using the Bill of Lading provided by GLT in the tender or documents services, please include the following fields in the BOL, those are mandatory for billing purposes.