Full Integration API Workflow
This integration workflow outlines the sequential usage of each API endpoint to facilitate a complete shipment lifecycle—from obtaining a quote to tracking the shipment and retrieving relevant documents. This process enables efficient management of LTL shipments, using Kuehne + Nagel’s LTL+ APIs.
1. RateQuote API
- Purpose: Obtain shipping rates for a proposed shipment.
- Input:
- Origin and Destination details
- Shipment weight, dimensions, and any additional requirements (e.g., Hazmat, special handling).
- Output:
- Returns a list of carrier options with the cost estimate and expected transit time for the shipment.
- Example Workflow Step: First, use the
RateQuote
API to determine pricing and logistics details based on the shipment parameters.
2. Bill Of Lading (BOL) API
- Purpose: Generate a Bill of Lading for the shipment based on the confirmed rate.
- Input:
- Detailed shipper, consignee, and carrier information
- Selected carrier with rate details from the previous
RateQuote
step
- Output:
- A Bill of Lading (BOL) PDF for the shipment, which includes a unique BOL number. This document will be handed to the driver at pickup
- Example Workflow Step: Use the BOL API to create a BOL document that will accompany the shipment.
3. LoadTender API
- Purpose: Submit a pickup request to the carrier, initiating the shipping process.
- Input:
- BOL details from the previous step, pickup date, and additional shipment-specific information.
- Output:
- A confirmation ID and scheduled pickup details.
- Example Workflow Step: Submit a tender request to arrange pickup based on the BOL created, confirming carrier engagement.
4. Shipment Tracking API
- Purpose: Retrieve near-real-time tracking updates on the shipment.
- Input:
- Shipment identifier (e.g., BOL number, PO number, Pro number) from the
Bill Of Lading
.
- Shipment identifier (e.g., BOL number, PO number, Pro number) from the
- Output:
- Detailed status updates for the shipment’s journey.
- Example Workflow Step: Track the shipment’s progress and receive alerts on status changes or delays, ensuring up-to-date visibility.
5. Invoicing API
- Purpose: Generate an invoice for completed shipments.
- Input:
- BOL number or other shipment identifiers
- Additional invoicing details, if applicable
- Output:
- Invoice PDF and other billing information.
- Example Workflow Step: Upon delivery, use the Invoicing API to finalize billing, making sure all costs are accurately reflected for the shipment.
6. Document Retrieval API
- Purpose: Access and retrieve documents associated with the shipment, such as proof of delivery (POD) or signed BOL.
- Input:
- BOL number, Pro number, or other shipment identifier
- Output:
- PDF documents relevant to the shipment.
- Example Workflow Step: After invoicing, retrieve any signed documents to complete the shipment’s documentation requirements and archive the files as needed.
This full integration flow allows for streamlined shipment management and a cohesive view of the shipment lifecycle from start to finish.