Requests
Retrieve Waybill - Retrieve current active waybill/bill of lading information for a given equipment.
<b>Changelog</b>
<ul> <li>November 17, 2021: Added customerWaybillReferenceNumbers array.</li> </ul>get/v1/waybill
Request
- Base URLhttps://api.bnsf.com:6443
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
equipmentInitialstring required
Example:BNSF
Equipment initial.
equipmentNumberstring required
Example:12345
Equipment number.
Response
OK
The request has succeeded.
Example response
{
"customerWaybillDetails": {
"equipmentInitial": "AOKX",
"equipmentNumber": "79005",
"loadEmptyCode": "E",
"equipmentGrossScaleWeightPounds": "270648",
"equipmentTareWeightPounds": "10000",
"shipmentNetScaleWeightPounds": "202348",
"carKindCode": "C5G",
"billOfLadingId": "017415FD",
"waybillNumber": "836486",
"waybillVersionNumber": "4",
"shippingManifestId": "205481286",
"waybillDate": "11-12-2000",
"waybillEdiCode": "TBL",
"waybillStatusCode": "C",
"waybillParties": [
{
"waybillPartyRoleName": "Consignee",
"waybillPartyFullName": "Company ABC"
}
],
"waybillDetails": {
"originStationName": "VANCOUVER",
"originStateCode": "WA",
"destinationStationName": "CHICAGO",
"destinationStateCode": "IL",
"stcc": "9999",
"commodityDescription": "CORN",
"contractFreightRateQuoteNumber": "9999",
"aarRule11Indicator": "Y",
"shipmentUnitCount": "11"
},
"waybillRoutes": [
{
"waybillRouteSequenceNumber": "5"
}
],
"waybillDiversions": [
{
"consigneeFullName": "Consignee ABC",
"waybillDiversionAuthorizedByName": "John Doe",
"waybillDiversionRequesterPhoneNumber": "999-999-9999",
"waybillDiversionDate": "11-30-2020",
"waybillDiversionTime": "08:33:52",
"waybillDiversionComments": [
{
"waybillDiversionComment": "ABC"
}
]
}
],
"waybillHazardousCommodities": [
{
"unNorthAmericanHazardousCommodityNumber": "UN3257",
"hazardousCommodityTechnicalName": "ASPHALT",
"hazardousCommodityProperShippingName": "ELEVATED TEMPERATURE LIQUID",
"hazardousSubstanceChemicalComponent": "ACETIC ACID",
"hazardousCommodityClassificationCode": "9",
"canadianHazardousCommoditySubsidiaryClassification1": "6.1",
"canadianHazardousCommoditySubsidiaryClassification2": "6.4",
"packagingGroupCode": "ABC",
"stcc": "9999",
"commodityAdditionalDescriptiveInformation": "CONTAINS NOT LESS THAN 48% WATER BY WEIGHT",
"hazardousMaterialShipmentWeightPounds": "172954",
"reportableHazardousMaterialQuantityIndicator": "N",
"customerNotificationPhoneNumber": "999-999-9999",
"waybillHazardousMaterialComment": "ABC"
}
],
"waybillVessels": [
{
"sailingDate": "2021-01-31",
"sailingTime": "20:00",
"vesselInboundOutboundCode": "O",
"vesselName": "ABC XYZ",
"vesselVoyageNumber": "038W",
"vesselTerminalName": "ABC123",
"vesselPortName": "LONG BEACH",
"pierName": "ABC123",
"vesselBookingNumber": "6286500640",
"vesselBookingDate": "2021-01-25",
"scheduledUnitAvailabilityDate": "2021-01-25",
"scheduledUnitAvailabilityTime": "08:30"
}
],
"integratedServiceDetails": {
"requestedUnitAvailabilityDate": "2021-01-25",
"requestedUnitAvailabilityTime": "18:15",
"plannedUnitAvailabilityDate": "2021-01-25",
"plannedUnitAvailabilityTime": "20:20"
},
"waybillErrors": [
{
"waybillErrorDescription": "ORIGIN ROAD (BNSF) DOES NOT SERVE ORIGIN (TOLUCA EM)."
}
],
"waybillSpecialInstructions": [
{
"waybillSpecialInstructions": "RULE 705: OPTIM TEMP 0 OR LESS DO NOT HEAT IN CANADA"
}
],
"waybillSpecialConditions": [
{
"waybillSpecialConditionCode": "ZZ",
"waybillSpecialConditionName": "Abcde"
}
],
"waybillAdditionalUnits": [
{
"totalLadingWeightPounds": "197404"
}
],
"customerWaybillReferenceNumbers": [
{
"waybillReferenceNumberTypeCode": "BM",
"waybillReferenceNumberTypeName": "Bill of Lading",
"waybillReferenceNumber": "A1B2C3"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.