Order

Orders API

The Orders endpoint allows you to submit shipment requests that need to be scheduled within the Bill of Lading (BOL) application. This endpoint is primarily used for placing orders that are to be tracked and processed as shipments.

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:

Authentication:

UserName: User's unique identifier.

ClientCode: Code associated with the client.

AuthenticationID: Unique ID for session authentication.

Order Details:

ShipmentNumber: This must be unique

BillOfLadingNumber,InternalBOLNumber, ProNumber, PONumber: Various identifiers for the shipment or order.

CarrierName, CarrierSCAC, QuoteNumber: Carrier-specific details for the shipment.

ShipmentDate: Scheduled date of shipment in YYYY-MM-DD format.

Shipper & Consignee Information:

ShipperCompanyName, ShipperContactPhone, ShipperContactName: Details for the shipping company and contact.

ShipperAddress, ShipperCity, ShipperState, ShipperZip: Full address of the shipper.

ConsigneeName, ConsigneePhone, ConsigneeContact: Details for the consignee.

ConsigneeAddress, ConsigneeCity, ConsigneeState, ConsigneeZip: Full address of the consignee.

Third-Party Billing:

Details if a third party is involved, including ThirdPartyName, ThirdPartyPhone, ThirdPartyAddress, etc.

Special Instructions:

SpecialInstructions: Additional instructions or handling notes.

StoreNumber, DepartmentNumber: Identifiers for store or department if applicable.

COD & Hazardous Details:

CODFeeCollect, CODFeePrePaid, CODAmt: Information about Collect on Delivery fees.

HazContractNUM, HazContactName, HazContactPhone: Contact details for hazardous shipments.

Accessorials:

AccessorialList: List of optional services or handling codes (e.g., ServiceCode for each accessorial).

Shipping Confirmation:

ShippingConfirmationEmail: Array of email addresses to receive shipping confirmations.

Line Items:

Array of shipment line items, each with ShippingUnits, PKGType, Description, NMFC, ClassNum, Weight, and Haz (hazardous material status).

Output Structure:

ErrorMessage: If an error occurs, this field contains the error message; otherwise, it is null.

Accepted: Indicates if the order submission was successful (true or false).

Notes:

Ensure all required fields are completed based on the specific order’s needs.

For any additional services or requirements, specify in AccessorialList and SpecialInstructions.

Request

Body Params application/json

Example

{
    "UserName": "string",
    "ClientCode": "string",
    "AuthenticationID": "string",
    "BillOfLadingNumber": "string",
    "ShipmentNumber": "string",
    "InternalBOLNumber": "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,
    "ShippingConfirmationEmail": [
        "string"
    ],
    "AccessorialList": [
        {
            "ServiceCode": null
        }
    ],
    "LineItems": [
        {
            "ShippingUnits": "string",
            "PKGType": null,
            "Description": null,
            "NMFC": null,
            "ClassNum": null,
            "Weight": "string",
            "Haz": true
        }
    ]
}

Request Code 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/onlineorders' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserName": "string",
    "ClientCode": "string",
    "AuthenticationID": "string",
    "BillOfLadingNumber": "string",
    "ShipmentNumber": "string",
    "InternalBOLNumber": "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,
    "ShippingConfirmationEmail": [
        "string"
    ],
    "AccessorialList": [
        {
            "ServiceCode": null
        }
    ],
    "LineItems": [
        {
            "ShippingUnits": "string",
            "PKGType": null,
            "Description": null,
            "NMFC": null,
            "ClassNum": null,
            "Weight": "string",
            "Haz": true
        }
    ]
}'

Orders API#

Notes:#

Request

Request Code Samples

Responses

Orders API

Notes: