BOL - Create a bill of lading PDF

The BOL API endpoint is designed to create a Bill of Lading (BOL) for a shipment, which is a crucial document in the shipping process.

PRO Numbers

ProNumber is not a required field in this endpoint, and can be left blank.

Kuehne + Nagel LTL+ does not generate PRO numbers on behalf of customers.

Customers can supply their own PRO numbers, which must be issued by the carrier handling the shipment.

Input Parameters:

User Authentication:

UserName: The username of the person or system making the request.

ClientCode: A code associated with the client.

AuthenticationId: A unique identifier for authentication.

Shipment Details:

BillOfLadingNumber: The number assigned to the Bill of Lading.

ProNumber: The shipment's Pro number (tracking number).

PONumber: The associated purchase order number.

CarrierName: The name of the carrier handling the shipment.

CarrierSCAC: The Standard Carrier Alpha Code for the carrier.

QuoteNumber: An optional quote number associated with the shipment.

ShipmentDate: The date the shipment is scheduled.

ShipperNumber, TrailerNumber, ShipperCompanyName, ShipperContactPhone, ShipperContactName, ShipperAddress, ShipperCity, ShipperState, ShipperZip: Details about the shipper.

ConsigneeName, ConsigneePhone, ConsigneeContact, ConsigneeAddress, ConsigneeCity, ConsigneeState, ConsigneeZip: Details about the consignee (recipient).

ThirdPartyName, ThirdPartyPhone, ThirdPartyContactName, ThirdPartyAddress, ThirdPartyCity, ThirdPartyState, ThirdPartyZip: Optional third-party billing details.

CustomerNumber, SpecialInstructions, StoreNumber, DepartmentNumber: Additional shipment-related information.

HazContractNUM, HazContactName, HazContactPhone: Hazardous materials information.

DeclaredValue, DeclaredValueUnitsOfMeasure: The declared value of the shipment.

CODFeeCollect, CODFeePrePaid, CODAmt, Collect, CustomerCheckNotOK, CustomerCheckOK: Cash on delivery and payment-related options.

Accessorials: A list of additional services or charges with associated ServiceCode.

Line Items: An array of items being shipped, each with:

ShippingUnits, PKGType, Description, NMFC, ClassNum, Weight, Haz: Specifics about the items.

PKGType (Package Types)

Item	Code
Barrel	BBL
Bin	BIN
Box	BOX
Case	CAS
Container	CNT
Crate	CRT
Carton	CTN
Pieces	PCS
Package	PKG
Pallet	PLT
Skid	SKD
Unit	UNT
Bottle	BTL
Cylinder	CYL
Drum	DRM
Pail	PAL
Battery	BAT
Canister	CAN
Tote	TOT

Output Structure:

PDF: A base64-encoded string of the Bill of Lading PDF.

ShipmentLabel: A base64-encoded string of the shipment label.

BlNumber: The generated Bill of Lading number.

ShipmentLabelZpl: An array containing ZPL formatted shipment label strings for printing.

ErrorMessage: Any error messages that occur during the process.

This endpoint is essential for creating formal shipping documents, facilitating the transportation of goods.

Request

Body Params application/json

Example

{
    "UserName": "string",
    "ClientCode": "string",
    "AuthenticationId": "string",
    "BillOfLadingNumber": "string",
    "ProNumber": "string",
    "PONumber": "string",
    "CarrierName": "string",
    "CarrierSCAC": "string",
    "QuoteNumber": 0,
    "ShipmentDate": "string",
    "ShipperNumber": "string",
    "TrailerNumber": "string",
    "ShipperCompanyName": "string",
    "ShipperContactPhone": "string",
    "ShipperContactName": "string",
    "ShipperAddress": "string",
    "ShipperCity": "string",
    "ShipperState": "string",
    "ShipperZip": "string",
    "ConsigneeName": "string",
    "ConsigneePhone": "string",
    "ConsigneeContact": "string",
    "ConsigneeAddress": "string",
    "ConsigneeCity": "string",
    "ConsigneeState": "string",
    "ConsigneeZip": "string",
    "ThirdPartyName": "string",
    "ThirdPartyPhone": "string",
    "ThirdPartyContactName": "string",
    "ThirdPartyAddress": "string",
    "ThirdPartyCity": "string",
    "ThirdPartyState": "string",
    "ThirdPartyZip": "string",
    "CustomerNumber": "string",
    "SpecialInstructions": "string",
    "StoreNumber": "string",
    "DepartmentNumber": "string",
    "HazContractNUM": "string",
    "HazContactName": "string",
    "HazContactPhone": "string",
    "DeclaredValue": "string",
    "DeclaredValueUnitsOfMeasure": "string",
    "CODFeeCollect": true,
    "CODFeePrePaid": true,
    "CODAmt": "string",
    "Collect": true,
    "CustomerCheckNotOK": true,
    "CustomerCheckOK": true,
    "AccessorialList": [
        {
            "ServiceCode": "string"
        }
    ],
    "LineItems": [
        {
            "ShippingUnits": "string",
            "PKGType": "string",
            "Description": "string",
            "NMFC": "string",
            "ClassNum": 0,
            "Weight": "string",
            "Haz": true
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.ltlp.kuehne-nagel.com/api/billoflading/preparebilloflading' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserName": "string",
    "ClientCode": "string",
    "AuthenticationId": "string",
    "BillOfLadingNumber": "string",
    "ProNumber": "string",
    "PONumber": "string",
    "CarrierName": "string",
    "CarrierSCAC": "string",
    "QuoteNumber": 0,
    "ShipmentDate": "string",
    "ShipperNumber": "string",
    "TrailerNumber": "string",
    "ShipperCompanyName": "string",
    "ShipperContactPhone": "string",
    "ShipperContactName": "string",
    "ShipperAddress": "string",
    "ShipperCity": "string",
    "ShipperState": "string",
    "ShipperZip": "string",
    "ConsigneeName": "string",
    "ConsigneePhone": "string",
    "ConsigneeContact": "string",
    "ConsigneeAddress": "string",
    "ConsigneeCity": "string",
    "ConsigneeState": "string",
    "ConsigneeZip": "string",
    "ThirdPartyName": "string",
    "ThirdPartyPhone": "string",
    "ThirdPartyContactName": "string",
    "ThirdPartyAddress": "string",
    "ThirdPartyCity": "string",
    "ThirdPartyState": "string",
    "ThirdPartyZip": "string",
    "CustomerNumber": "string",
    "SpecialInstructions": "string",
    "StoreNumber": "string",
    "DepartmentNumber": "string",
    "HazContractNUM": "string",
    "HazContactName": "string",
    "HazContactPhone": "string",
    "DeclaredValue": "string",
    "DeclaredValueUnitsOfMeasure": "string",
    "CODFeeCollect": true,
    "CODFeePrePaid": true,
    "CODAmt": "string",
    "Collect": true,
    "CustomerCheckNotOK": true,
    "CustomerCheckOK": true,
    "AccessorialList": [
        {
            "ServiceCode": "string"
        }
    ],
    "LineItems": [
        {
            "ShippingUnits": "string",
            "PKGType": "string",
            "Description": "string",
            "NMFC": "string",
            "ClassNum": 0,
            "Weight": "string",
            "Haz": true
        }
    ]
}'

application/json

Body

Example

{
    "PDF": "string",
    "ShipmentLabel": "string",
    "BlNumber": "string",
    "ShipmentLabelZpl": [
        "string"
    ],
    "ErrorMessage": "string"
}

BOL - Create a bill of lading PDF

Input Parameters:#

PKGType (Package Types)#

Output Structure:#

Request

Request samples

Responses

Input Parameters:

PKGType (Package Types)

Output Structure: