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

UserName

string

required

Assigned by Kuehne + Nagel, LTL

ClientCode

string

required

Assigned by Kuehne + Nagel, LTL

AuthenticationId

string

required

Assigned by Kuehne + Nagel, LTL

BillOfLadingNumber

string

optional

If left blank, LTL+ will generate a unique BL number

ProNumber

string

optional

PONumber

string

optional

CarrierName

string

required

CarrierSCAC

string

required

4 character code for the carrier

QuoteNumber

integer

optional

Provide the LTL+ quote number if generating PDF based off quote

ShipmentDate

string

required

Pickup Date in format yyyyMMdd

ShipperNumber

string

optional

TrailerNumber

string

optional

ShipperCompanyName

string

required

ShipperContactPhone

string

required

ShipperContactName

string

required

ShipperAddress

string

required

ShipperCity

string

required

ShipperState

string

required

ShipperZip

string

required

ConsigneeName

string

required

ConsigneePhone

string

required

ConsigneeContact

string

required

ConsigneeAddress

string

required

ConsigneeCity

string

required

ConsigneeState

string

required

ConsigneeZip

string

required

ThirdPartyName

string

optional

Optional

ThirdPartyPhone

string

optional

ThirdPartyContactName

string

optional

ThirdPartyAddress

string

optional

ThirdPartyCity

string

optional

ThirdPartyState

string

optional

ThirdPartyZip

string

optional

CustomerNumber

string

optional

SpecialInstructions

string

optional

StoreNumber

string

optional

DepartmentNumber

string

optional

HazContractNUM

string

optional

HazContactName

string

optional

HazContactPhone

string

optional

DeclaredValue

string

optional

DeclaredValueUnitsOfMeasure

string

optional

CODFeeCollect

boolean

optional

CODFeePrePaid

boolean

optional

CODAmt

string

optional

Collect

boolean

optional

CustomerCheckNotOK

boolean

optional

CustomerCheckOK

boolean

optional

AccessorialList

array [object {1}]

optional

ServiceCode

string

required

LineItems

array [object {7}]

required

>= 1 items

ShippingUnits

string

required

PKGType

string

required

Description

string

required

NMFC

string

required

ClassNum

integer

required

Weight

string

required

Haz

boolean

required

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
        }
    ]
}'

Responses

🟢200OK

application/json

Body

PDF

string

required

Base64 encoded PDF

ShipmentLabel

string

required

Base64 encoded PDF

BlNumber

string

required

ShipmentLabelZpl

array[string]

required

ZPL Format Shipment Label

ErrorMessage

string

required

Blank is no error

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: