Electronic Bill Of Lading Service (2.0.0)

Download OpenAPI specification:Download

Carrier API Standards

/bol/v1/app/

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: v1.0 or v1.1
	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": 1.1,
"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",
"bol": ["BL19498432",
"BL99744565"
],
"po": [{"number": "554238",
"pieces": 5,
"weight": 150,
"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,
"class": 3,
"unnaNumber": 1005,
"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": "v1",
"transactionDate": "2022-11-20T00:00:00.000",
"referenceNumbers": {"pro": "PRO1234",
"shipmentConfirmationNumber": "SCN1234"
},
"images": {"bol": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgOAovQ29sb3JTcGFjZSAvRGV2a......",
"shippingLabels": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJDb21wb25lbnQgOAovQ29sb3JTcGFjZSAvRGV2a......"
},
"messageStatus": {"status": "PASS",
"code": "10000000",
"message": "Transaction was successful.",
"resolution": "",
"information": [ ]
}
}

Electronic Bill Of Lading Service (2.0.0)

Carrier API Standards

/bol/v1/app/

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required