Electronic Bill Of Lading Service (2.1.0)

Download OpenAPI specification:Download

This document provides an electronic Bill of Lading (eBOL). The eBOL is a legal document that provides a contract between the shipper, carrier and consignee stating what goods are being shipped, where the shipment is coming from and where it’s headed to. “Pro” number is the unique identifier for the document for update and delete functions.

Carrier API Standards

Create an Electronic Bill of Lading

Request Body schema: application/json
required

required	object
version required	string Indicates which minor version of the Digital LTL Council Bill of Lading spec you are consuming Valid values: 2.0.0, 2.0.1, 2.1.0
	object
	Array of objects include if you want notifications of shipment movements by text message or email
	object
required	object
required	object
	object
	object
required	object
required	object
required	object
	object

Responses

Request samples

Payload

Content type

application/json

{"bol": {"requestedPickupDate": "2022-11-20T00:00:00.000",
"function": "Create",
"isTest": true,
"requestorRole": "Third Party",
"specialInstructions": "Gate code 123 to enter complex"
},
"version": "2.1.0",
"images": {"includeBol": true,
"includeShippingLabels": true,
"shippingLabels": {"format": "Avery",
"quantity": 5,
"position": 2
},
"email": {"includeBol": true,
"includeLabels": true,
"addresses": ["dispatch@shipper.com"
]
}
},
"notifications": [{"phoneNumber": "8881234567",
"email": "dispatch@consignee.com"
}
],
"referenceNumbers": {"pro": "123456-7",
"quoteId": "E556724",
"shipmentId": "SID9743985",
"masterBol": "MBL98472587",
"trailerId": "string",
"manifestId": "string",
"bol": ["BL19498432",
"BL99744565"
],
"po": [{"number": "554238",
"pieces": 5,
"weight": 150,
"weightUnit": "Pounds",
"palletized": true,
"additionalShipperInfo": "Freight must always stay upright"
}
],
"additionalReferences": [{"name": "Customer Reference Id",
"value": "CRID3452-01"
}
]
},
"payment": {"terms": "Prepaid"
},
"commodities": {"lineItemLayout": "Nested",
"handlingUnits": [{"count": 2,
"type": "SKD",
"tareWeight": 5,
"weight": 1500,
"weightUnit": "Pounds",
"length": 48,
"width": 48,
"height": 48,
"dimensionsUnit": "Inches",
"stackable": false,
"lineItems": [{"description": "Small frameless mirrors",
"weight": 1500,
"weightUnit": "Pounds",
"pieces": 3,
"packagingType": "BOX",
"classification": "55",
"nmfc": "86900",
"nmfcSub": "3",
"hazardous": true,
"hazardousDescription": "UN 1090, Acetone, 3, PG II",
"hazardousDetails": {"weight": 45,
"weightUnit": "Pounds",
"class": 3,
"unnaNumber": "UN1234",
"propername": "Anhydrous ammonia",
"technicalName": "NH3",
"packingGroup": "2",
"contractNumber": "54321"
}
}
]
}
]
},
"shipmentTotals": {"grossWeight": 2000,
"netWeight": 1993,
"weightUnit": "Pounds",
"handlingUnits": 2,
"linearLength": 96,
"dimensionsUnit": "Inches",
"cube": 128,
"cubeDimensionsUnit": "Feet",
"declaredValue": 7,
"currency": "USD"
},
"accessorials": {"codes": ["IDL",
"LFTP"
],
"hazardousDetails": {"emergencyContact": {"name": "Manny Delgato",
"phone": "7775558899"
}
},
"cod": {"amount": "56.71",
"currency": "USD",
"terms": "Collect",
"customerCheckAcceptable": true,
"remitTo": {"name": "Dog Beds by Stella",
"address1": "121 S. Cliffwood Ave.",
"address2": "Suite 55",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA"
}
},
"sortAndSegregateDetails": {"pieces": 25
},
"fullValueCoverageDetails": {"monetaryValue": "100.00",
"currency": "USD"
},
"markDetails": {"pieces": 25
},
"limitedAccessType": {"origin": "Church",
"destination": "Secure"
},
"timeCriticalDetails": {"type": "Delivery Window",
"date": {"start": "2021-05-20T00:00:00.000",
"end": "2021-05-22T00:00:00.000"
}
},
"appointmentDetails": {"pickup": {"start": "2021-05-20T00:00:00.000",
"end": "2021-05-22T00:00:00.000"
},
"delivery": {"start": "2021-05-20T00:00:00.000",
"end": "2021-05-22T00:00:00.000"
}
}
},
"origin": {"account": "12345",
"locationId": "808",
"name": "Closets Closets Closets",
"address1": "12 S. Closets Place",
"address2": "ste 3",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA",
"contact": {"phone": "5552226666",
"phoneExt": "99",
"name": "Jay Pritchett",
"email": "jpritchett@closets.com"
}
},
"destination": {"account": "12345",
"locationId": "808",
"name": "Closets Closets Closets",
"address1": "12 S. Closets Place",
"address2": "ste 3",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA",
"contact": {"phone": "5552226666",
"phoneExt": "99",
"name": "Jay Pritchett",
"email": "jpritchett@closets.com"
}
},
"billTo": {"account": "12345",
"locationId": "808",
"name": "Closets Closets Closets",
"address1": "12 S. Closets Place",
"address2": "ste 3",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA",
"contact": {"phone": "5552226666",
"phoneExt": "99",
"name": "Jay Pritchett",
"email": "jpritchett@closets.com"
}
},
"customsBroker": {"type": "Import",
"name": "Closets Closets Closets",
"address1": "12 S. Closets Place",
"address2": "ste 3",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA",
"contact": {"phone": "5552226666",
"phoneExt": "99",
"name": "Jay Pritchett",
"email": "jpritchett@closets.com"
}
}
}

Response samples

Content type

application/json

{"version": "2.1.0",
"transactionDate": "2022-11-20T00:00:00.000",
"referenceNumbers": {"pro": "PRO1234",
"shipmentConfirmationNumber": "SCN1234"
},
"scac": "AAAB",
"images": {"bol": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgOAovQ29sb3JTcGFjZSAvRGV2a......",
"shippingLabels": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgOAovQ29sb3JTcGFjZSAvRGV2a......"
},
"termsAndConditions": "Terms and Conditions text available for download at www.myurl-nmfta.org",
"messageStatus": {"status": "PASS",
"code": "10000000",
"message": "Transaction was successful.",
"resolution": "",
"information": [ ]
},
"resultStatusCodes": [null
]
}

Update an Electronic Bill of Lading

This operation updates an existing Electronic Bill of Lading.

path Parameters

pro

required

string

PRO Number of eBOL to update.

Request Body schema: application/json
required

required	object
version required	string Indicates which minor version of the Digital LTL Council Bill of Lading spec you are consuming Valid values: 2.0.0, 2.0.1, 2.1.0
	object
	Array of objects include if you want notifications of shipment movements by text message or email
	object
required	object
required	object
	object
	object
required	object
required	object
required	object
	object

Responses

Request samples

Payload

Content type

application/json

{"bol": {"requestedPickupDate": "2022-11-20T00:00:00.000",
"function": "Create",
"isTest": true,
"requestorRole": "Third Party",
"specialInstructions": "Gate code 123 to enter complex"
},
"version": "2.1.0",
"images": {"includeBol": true,
"includeShippingLabels": true,
"shippingLabels": {"format": "Avery",
"quantity": 5,
"position": 2
},
"email": {"includeBol": true,
"includeLabels": true,
"addresses": ["dispatch@shipper.com"
]
}
},
"notifications": [{"phoneNumber": "8881234567",
"email": "dispatch@consignee.com"
}
],
"referenceNumbers": {"pro": "123456-7",
"quoteId": "E556724",
"shipmentId": "SID9743985",
"masterBol": "MBL98472587",
"trailerId": "string",
"manifestId": "string",
"bol": ["BL19498432",
"BL99744565"
],
"po": [{"number": "554238",
"pieces": 5,
"weight": 150,
"weightUnit": "Pounds",
"palletized": true,
"additionalShipperInfo": "Freight must always stay upright"
}
],
"additionalReferences": [{"name": "Customer Reference Id",
"value": "CRID3452-01"
}
]
},
"payment": {"terms": "Prepaid"
},
"commodities": {"lineItemLayout": "Nested",
"handlingUnits": [{"count": 2,
"type": "SKD",
"tareWeight": 5,
"weight": 1500,
"weightUnit": "Pounds",
"length": 48,
"width": 48,
"height": 48,
"dimensionsUnit": "Inches",
"stackable": false,
"lineItems": [{"description": "Small frameless mirrors",
"weight": 1500,
"weightUnit": "Pounds",
"pieces": 3,
"packagingType": "BOX",
"classification": "55",
"nmfc": "86900",
"nmfcSub": "3",
"hazardous": true,
"hazardousDescription": "UN 1090, Acetone, 3, PG II",
"hazardousDetails": {"weight": 45,
"weightUnit": "Pounds",
"class": 3,
"unnaNumber": "UN1234",
"propername": "Anhydrous ammonia",
"technicalName": "NH3",
"packingGroup": "2",
"contractNumber": "54321"
}
}
]
}
]
},
"shipmentTotals": {"grossWeight": 2000,
"netWeight": 1993,
"weightUnit": "Pounds",
"handlingUnits": 2,
"linearLength": 96,
"dimensionsUnit": "Inches",
"cube": 128,
"cubeDimensionsUnit": "Feet",
"declaredValue": 7,
"currency": "USD"
},
"accessorials": {"codes": ["IDL",
"LFTP"
],
"hazardousDetails": {"emergencyContact": {"name": "Manny Delgato",
"phone": "7775558899"
}
},
"cod": {"amount": "56.71",
"currency": "USD",
"terms": "Collect",
"customerCheckAcceptable": true,
"remitTo": {"name": "Dog Beds by Stella",
"address1": "121 S. Cliffwood Ave.",
"address2": "Suite 55",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA"
}
},
"sortAndSegregateDetails": {"pieces": 25
},
"fullValueCoverageDetails": {"monetaryValue": "100.00",
"currency": "USD"
},
"markDetails": {"pieces": 25
},
"limitedAccessType": {"origin": "Church",
"destination": "Secure"
},
"timeCriticalDetails": {"type": "Delivery Window",
"date": {"start": "2021-05-20T00:00:00.000",
"end": "2021-05-22T00:00:00.000"
}
},
"appointmentDetails": {"pickup": {"start": "2021-05-20T00:00:00.000",
"end": "2021-05-22T00:00:00.000"
},
"delivery": {"start": "2021-05-20T00:00:00.000",
"end": "2021-05-22T00:00:00.000"
}
}
},
"origin": {"account": "12345",
"locationId": "808",
"name": "Closets Closets Closets",
"address1": "12 S. Closets Place",
"address2": "ste 3",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA",
"contact": {"phone": "5552226666",
"phoneExt": "99",
"name": "Jay Pritchett",
"email": "jpritchett@closets.com"
}
},
"destination": {"account": "12345",
"locationId": "808",
"name": "Closets Closets Closets",
"address1": "12 S. Closets Place",
"address2": "ste 3",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA",
"contact": {"phone": "5552226666",
"phoneExt": "99",
"name": "Jay Pritchett",
"email": "jpritchett@closets.com"
}
},
"billTo": {"account": "12345",
"locationId": "808",
"name": "Closets Closets Closets",
"address1": "12 S. Closets Place",
"address2": "ste 3",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA",
"contact": {"phone": "5552226666",
"phoneExt": "99",
"name": "Jay Pritchett",
"email": "jpritchett@closets.com"
}
},
"customsBroker": {"type": "Import",
"name": "Closets Closets Closets",
"address1": "12 S. Closets Place",
"address2": "ste 3",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "USA",
"contact": {"phone": "5552226666",
"phoneExt": "99",
"name": "Jay Pritchett",
"email": "jpritchett@closets.com"
}
}
}

Response samples

Content type

application/json

{"version": "2.1.0",
"transactionDate": "2022-11-20T00:00:00.000",
"referenceNumbers": {"pro": "PRO1234",
"shipmentConfirmationNumber": "SCN1234"
},
"scac": "AAAB",
"images": {"bol": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgOAovQ29sb3JTcGFjZSAvRGV2a......",
"shippingLabels": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgOAovQ29sb3JTcGFjZSAvRGV2a......"
},
"termsAndConditions": "Terms and Conditions text available for download at www.myurl-nmfta.org",
"messageStatus": {"status": "PASS",
"code": "10000000",
"message": "Transaction was successful.",
"resolution": "",
"information": [ ]
},
"resultStatusCodes": [null
]
}

Delete an Electronic Bill of Lading

This operation deletes an existing Electronic Bill of Lading.

path Parameters

pro

required

string

PRO Number of eBOL to delete.

Responses

Response samples

Content type

application/json

[null
]

Electronic Bill Of Lading Service (2.1.0)

Carrier API Standards

Create an Electronic Bill of Lading

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update an Electronic Bill of Lading

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an Electronic Bill of Lading

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required