BOL - Create a bill of lading PDF
POST
/billoflading/preparebillofladingLast modified: 17 days ago
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.
:::caution[PRO Numbers]
Kuehne + Nagel LTL+ does not generate PRO numbers on behalf of customers. Customers are required to 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
No schema defined
Example
Not configured
Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
Example
Not configured