Portal API Docs

# Documents

This section outlines the data required to retrieve documents related to a load and how the process works.
Document available in the response:

  • BOL (Bill of Lading)
  • Labels
  • Signed BOL
  • POD (Proof of Delivery)
  • Weight Certificate

Before the load is in transit, available documents are BOL (Bill of Lading) and Labels. Signed BOLs will be available after the load is in transit, and PODs will be available after it is delivered.

TIP

Not all carriers support API document retrieval. Signed BOLs, PODs, and Weight Certificates will not be available in some cases.

The following path parameter is required to make a request and retrieve the documents:

load_id: Data type string representing the load related to the documents.

# Get documents

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

GET /api/v1/docs/{load_id}

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

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

# Response

The response to the request will be a JSON object with the following properties representing the links to the documents related to the requested load:

{
  "bol": "https://storage.googleapis.com/charlie-portal-prod/bol/a0j7A000007bQ0VQAU.pdf?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=charliebert%40charliebertvg.iam.gserviceaccount.com...",
  "shipping_labels": "https://storage.googleapis.com/charlie-portal-prod/shipping-labels/a0j7A000007bQ0VQAU.pdf?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=charliebert%40charliebertvg.iam.gserviceaccount.com...",
  "pod": "https://storage.googleapis.com/charlie-portal-prod/POD/a0j7A000007bQ0VQAU.pdf?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=charliebert%40charliebertvg.iam.gserviceaccount.com...",
  "weight_certificate":null,
  "signed_bol": "https://storage.googleapis.com/charlie-portal-prod/BOL/a0j7A000007bQ0VQAU.pdf?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=charliebert%40charliebertvg.iam.gserviceaccount.com..."
}

← Tracking →