Portal API Docs

# Get Loads Information

This section outlines the data required to retrieve Load information and how the process works.
View only for loads that are assigned, in transit, delivered and completed.

# Get Loads List

This function allows you to obtain a list of shipments or loads associated with a particular account. Optionally, various filters can be applied to refine the search based on dates, statuses, and other criteria.

The following parameters can be included in the URL to filter the results:

actual_pickup_date_gt: Returns loads with actual_pickup_date after the specified date. Format: YYYY-MM-DD (example: 2025-05-12).
actual_pickup_date_lt: Returns loads with actual_pickup_date before the specified date. Format: YYYY-MM-DD (example: 2025-05-16).
tender_accepted_date_gt: Returns loads with tender_accepted_date after the specified date. Format: YYYY-MM-DD (example: 2025-05-13).
tender_accepted_date_lt: Returns loads with tender_accepted_date before the specified date. Format: YYYY-MM-DD (example: 2025-05-16).
skip: (Integer) Number of loads to skip at the beginning of the results list (for pagination). Default is 0.
limit: (Integer) Maximum number of loads to return in the response (for pagination) with a maximum of 200. Default is 200.

Get /api/v1/loads

DEV URL: [https://dev.webservices.goglt.com/api/v1/loads](https://dev.webservices.goglt.com/api/v1/loads)
PROD URL: [https://webservices.goglt.com/api/v1/loads](https://webservices.goglt.com/api/v1/loads)

# Request

GET /api/v1/loads?actual_pickup_date_gt=2025-05-10&tender_accepted_date_lt=2025-05-18&skip=0&limit=1

# Response

{
  "skip": 0,
  "limit": 1,
  "count": 585,
  "data": [
    {
      "id": "a0jRc00000A0fF7IAJ",
      "name": "SHP5805521",
      "status": "Completed",
      "pro_number": "I927359874",
      "origin": "FORT WAYNE, Indiana",
      "destination": "GRAND RAPIDS, Michigan",
      "carrier": {
        "Name": "R+L Carriers",
        "Id": "0011I000004movKQAQ"
      },
      "accessorial": null,
      "price": 195.57,
      "created_date": "2025-04-01T01:57:53.000+0000",
      "estimated_pickup_date": "2025-04-02",
      "actual_pickup_date": "2025-04-02",
      "estimated_delivery_date": "2025-04-03",
      "actual_delivery_date": "2025-04-03",
      "tender_accepted_date": "2025-04-01T01:57:52.000+0000",
      "customer": {
        "Name": "INXPRESS CORPORATE",
        "Id": "0011I00000FpvKUQAZ"
      },
      "billing_reference": "1393268"
    }
  ]
}

# Get Load by ID

Make a GET request to the following endpoint with the id:

Information available in the response:

  • Load information
  • From address information
  • To address information
  • carrier information
  • Line items information
  • Accessorials information
  • Documents
    • BOL (Bill of Lading)
    • Labels
    • Signed BOL
    • POD (Proof of Delivery)
    • Weight Certificate
Get /api/v1/loads/{id}

DEV URL: [https://dev.webservices.goglt.com/api/v1/loads/{id}](https://dev.webservices.goglt.com/api/v1/loads/{id})
PROD URL: [https://webservices.goglt.com/api/v1/loads/{id}](https://webservices.goglt.com/api/v1/loads/id)

# Request

GET /api/v1/loads/a0jRt0000090rdRIAQ

{
  "type_notification": "load_created",
  "load_id": "a0jRt0000090rdRIAQ",
  "shp": "SHP5916005",
  "insurance": null,
  "cargo_value": null,
  "from_address": {
    "zip_code": "33166",
    "city": "Medley",
    "state": "FL",
    "country": "US",
    "location_name": "House",
    "street": "carrer 58",
    "contact_first_name": "Employee",
    "contact_last_name": "",
    "contact_phone": "1(000) 000-0000",
    "contact_email": "employee@gmail.com",
    "references": null,
    "instructions": null,
    "shipping_hours": "07:00-11:00",
    "departure_date": "2025-05-27"
  },
  "to_address": {
    "zip_code": "12345",
    "city": "Schenectady",
    "state": "NY",
    "country": "US",
    "location_name": "Work",
    "street": "calle 58",
    "contact_first_name": "Employee",
    "contact_last_name": "",
    "contact_phone": "1(000) 000-0000",
    "contact_email": "employee@gmail.com",
    "references": null,
    "instructions": null,
    "receiving_hours": "07:00-11:00"
  },
  "carrier": {
    "transit_time": 19,
    "transit_time_hours": null,
    "service_class": "NORMAL SERVICE",
    "name": "STG LTL",
    "price": 254.61481500000002,
    "discounted_price": 254.61481500000002, 
    "currency": "USD",
    "scac": "FCSY",
    "expiration": "2025-06-24"
  },
  "line_items": [
    {
      "handling_unit_count": 1,
      "handling_units": "Pallets",
      "length": 48,
      "width": 48,
      "height": 48,
      "weight": 500,
      "description": "apples",
      "hazardous_materials": false,
      "stackable": true
    }
  ],
  "billing_reference": null,
  "po_number": null,
  "accessorials": [
    "Stackable"
  ],
  "additional_info": {},
  "documents": {
    "bol": "https://storage.googleapis.com/charlie-portal-dev/generated-docs/bol/SHP5916005.pdf?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=charliebert%40charliebertvg.iam.gserviceaccount.com%2F20250526%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250526T192224Z&X-Goog-Expires=604740&X-Goog-SignedHeaders=host&X-Goog-Signature=9195d33dc9b56a071a1b0da5aad627719cf301547683048400668143379672c56dd64ac01933d0a4ee0cad0db23b46d4825faad92941e35d05bffacf6785d5a98faefaca789225b92473be9d9c7c44c24f90c4b0199ff44638e53d59fa77e69322e3837001144adf4991497b87d23ca172175360c6bbb5648191ba37c6115743d83b5a3b693785a15938213046f29d0a5197f9b337862767bd48a61939043f8fff8b8e5a6d65d8e874439583fc217edab9fee9cd3bfa1efe1bb3c2767e7259a645ab342eb32765c6786a2fb5353203d6a159018e6e9de292b4d416c9195c76171f54d595cc10835eba4edc3b19d83efac91aed33b7bf378a2aa04694aa5bba49",
    "shipping_labels": "",
    "pod": "",
    "weight_certificate": "",
    "signed_bol": ""
  }
}

← Quote file →