XGS APIs (1.0)

Reterive a token to access XGS APIs

This API allows you to reschedule an existing pickup. To successfully reschedule a pickup, the request must include the pickup number (pickupNumber) and a pickup window (pickupWindow) that contains the new scheduled date and time

1. Pickup Window Constraints:
   • The pickup window date cannot be earlier than the current scheduled date for the pickup.
2. Status Conflict:
   • A pickup cannot be rescheduled if its current status is one of the following:
     • Assigned: The pickup is already assigned to a driver.
     • Cancelled: The pickup has been cancelled.
     • Completed: The pickup has already been completed.

⚠️ Important

Please note: The pickup number changes upon successful rescheduling.
For tracking or future reference, always use the new pickup number returned in the response.

Responses

• 200 OK: The pickup was successfully rescheduled. The response includes the updated pickup details. Please refer the response schema for details.

• 400 Bad Request: The request is invalid. Common reasons include missing required fields or invalid formats. Pleae refer the bad request examples for more details.

• 422 Unprocessable Entity: The pickup cannot be rescheduled due to business rule violations (e.g., attempting to reschedule to a date in the past or if the pickup has a conflicting status). Pleae refer the unprocessable entity request examples for more details.

Example Scenarios:

• If you try to reschedule the pickup to a date that is earlier than the current date, the API will return a 422 Unprocessable Entity with a message indicating that the new pickup date cannot be earlier than the current scheduled date.
• If the pickup has already been assigned, cancelled, or completed, it cannot be rescheduled, and the API will return a 422 Unprocessable Entity.

Notes:

• The pickup number must be valid and non-empty.
• The pickup window time should be in 24-hour format (HH:MM).
• Ensure that the pickup window date follows the YYYY-MM-DD format.

This endpoint allows users to cancel a previously scheduled pickup request.

1. Status Conflict:
   • A pickup cannot be rescheduled if its current status is one of the following:
     • Assigned: The pickup is already assigned to a driver.
     • Cancelled: The pickup has been cancelled.
     • Completed: The pickup has already been completed.

Responses

• 200 OK: The pickup was successfully cancelled. Please refer the response schema for details.

• 400 Bad Request: The request is invalid. Common reasons include missing required fields or invalid formats. Pleae refer the bad request examples for more details.

• 422 Unprocessable Entity: The pickup cannot be cancelled due to business rule violations (e.g., attempting to cancel if the pickup has a conflicting status). Pleae refer the unprocessable entity request examples for more details.

Get list of all live shipments with current status and details. API uses pagination, to get all shipments keep incrementing the value of pageNumber(check param for more details)

Get the current status and details of a Shipment by probill number.

Get the current status and details of a Shipment by BOL number.

This endpoint allows you to retrieve the current status and tracking details of a shipment using the pickupNumber.

Shipment Lifecycle Coverage

The API provides a comprehensive view of the entire shipment lifecycle, covering:

• Pickup Phase (First Mile)

  • Statuses like:
    PICKUP PENDING, PICKUP ASSIGNED TO DRIVER, PICKED UP FROM SHIPPER, TENDERED AT ORIGIN, MANIFESTED AT ORIGIN

• Linehaul Journey (Middle Mile)

  • Transit status events such as:
    DEPARTED ORIGIN, IN TRANSIT TO SERVICE CENTER, TRANSFERRED AT HUB, IN TRANSIT TO HUB

• Final Mile (Delivery Phase)

  • Delivery status updates including:
    ARRIVED At DEST.SRV CNTR, LOADED FOR DELIVERY, OUT FOR DELIVERY, DELIVERED

Create a BOL and Pickup request

This API provides documents realted to Pickups, this includes XGS BOL and Shipping Labels.

This API provides XGS BOL document for pickup

This API provides XGS Shipping Labels for pickup

This API generates a rate quote for Less-Than-Truckload (LTL) shipments based on origin and destination zip codes, tender date, special services, and shipment details. It supports multiple items with various freight class codes, units of measure, and weights.

API provides a paginated list of all probills dispatched for the agent, organized by page size and page number. This API is useful for obtaining active shipments in real-time. Continue incrementing the pageNumber parameter until an empty response is received to cover all entries.

Provides detailed information about a specific probill, including associated items, consignee details, and identifiers like Probill Number, Bill of Lading (BOL) Number, and Purchase Order Number

API provides a list of probills assigned to a specified manifest that has been dispatched for the agent

Marks a manifest as 'Arrived' at the agent's facility, signaling that the shipments within the manifest are now ready for unloading or further processing.

Get Delivery Receipt for a Probill. The API provides a base64 encoded document for the requested probill delivery receipt.

Provide status of a dispatched probill. The API allows to post the status along with envent timestamp. This API provides a means for logistics agents to communicate precise shipment status updates (e.g., “PICKED_UP” or “OUT_FOR_DELIVERY”) in real time to all stakeholders. Accurate status updates ensure transparency and help agents keep customers informed of any logistical changes or expected delivery times

Provide POD info for a probill, this updates the probill status to DELIVERED along with indexing the image. The POD image should contain signature from the customer.

Create shipment appointment for Probill

Fetch documents associated with a specific XGS Probill Number and document type. This endpoint returns one or more documents for the provided probill number and requested document type. All returned files are Base64-encoded, allowing you to decode and use them as actual files.

How to Decode Base64 Content

To use the document, decode the contentBase64 string and save it using the correct file type.

Node.js

const fs = require('fs');

const base64Content = response.documents[0].contentBase64;
const fileName = response.documents[0].fileName;

const buffer = Buffer.from(base64Content, 'base64');
fs.writeFileSync(fileName, buffer);

Java

import java.util.Base64;
import java.io.FileOutputStream;

public class DecodeBase64 {
    public static void main(String[] args) throws Exception {
        String base64Content = "yourBase64StringHere";
        byte[] decodedBytes = Base64.getDecoder().decode(base64Content);
        try (FileOutputStream stream = new FileOutputStream("output.tiff")) {
            stream.write(decodedBytes);
        }
    }
}

Python

import base64

base64_content = "yourBase64StringHere"
file_name = "output.tiff"

with open(file_name, "wb") as file:
    file.write(base64.b64decode(base64_content))

❗ Notes

• If no documents are available for the given probill and type, the documents array will be empty.
• Files are returned in Base64 format—you must decode them to use as files.