BookLoad - Banyan Technology LIVE Connect™

This function will book a quote that belongs to the requested shipment. Functionality exists to also dispatch the shipment.

Booking a quote only awards a quote in Banyan, and no communication is done with the given carrier. When dispatching the shipment, the communication is controlled by the SubmitPickup bit.

Additionally, the quote ID is required for a successful response. You obtain this via the GetQuotes call.

Request

Header Params

Body Params application/json

Example

{
   "AuthenticationData":{
      "Username":"{{username}}",
      "Password":"{{password}}",
      "ClientRefNum":"{{clientRefNum}}"
   },
   "LoadID":"62339134",
   "QuoteID":"486574985",
   "PickupDateTime":"04/17/2024 12:00",
   "ReturnLatestLoadData":"true",
   "DispatchRequest":{
      "DispatchLoad":"true",
      "DispatchOverride":"false",
      "SubmitPickup":"false"
   }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200BookLoad - 200 OK

application/json

Body

Example

{
    "Success": true,
    "Error": null,
    "request": {
        "AuthenticationData": {
            "Username": "_",
            "Password": "_",
            "ClientRefNum": "_"
        },
        "DebugMode": false,
        "Loadinfo": {
            "LoadID": 62339134,
            "ManifestID": "624500165",
            "BOLNumber": "BWS2406700014",
            "CustomerPO": "Cust PO Number",
            "InvoiceID": "",
            "BillingID": "",
            "IncoTermID": null,
            "UltimateDestinationCountryCode": "",
            "PickupNumber": "",
            "EstimatedDeliveryDate": "2024-04-18T00:00:00",
            "EstimatedPickupDate": "2024-04-17T00:00:00",
            "ActualPickupDate": "2024-04-17T00:00:00",
            "ActualDeliveryDate": "2024-04-18T00:00:00"
        },
        "BillTo": {
            "Name": "1-Landstar",
            "Note": "Corporate",
            "ShipType": 0,
            "PayType": 1,
            "UseDefaultBillTo": false,
            "AddressInfo": {
                "Address1": "13410 Sutton Park Drive S.",
                "Address2": "ATTN: LTL Payables",
                "City": "Jacksonville",
                "CountryName": "United States",
                "CountryCode": "USA",
                "State": "FL",
                "Zipcode": "32224",
                "LocationName": "Landstar Global Logistics"
            },
            "ContactInfo": {
                "FirstName": "",
                "LastName": "",
                "ContactName": "",
                "Phone": "800-840-1378",
                "PhoneExt": "",
                "Fax": "",
                "Email": "ltlbus@landstar.com"
            },
            "UseDefaultShipType": false,
            "UseDefaultPayType": false
        },
        "InsuranceInfo": null,
        "RateServices": [
            {
                "ServiceCode": 1,
                "ShippingQty": 1,
                "PackageType": 29,
                "EquipmentType": 5,
                "AdditionalWeight": 50,
                "SpecialInstructions": "Do not break",
                "Length": 40,
                "Width": 48,
                "Height": 40,
                "WeightUom": 1,
                "SizeUom": 1
            }
        ],
        "Shipper": {
            "ContactInfo": {
                "FirstName": "Jon",
                "LastName": "Snow",
                "ContactName": "Jon Snow",
                "Phone": "867-5309",
                "PhoneExt": "",
                "Fax": "",
                "Email": ""
            },
            "AddressInfo": {
                "Address1": "123245 Test St.",
                "Address2": "",
                "City": "North Ridgeville",
                "CountryName": "United States",
                "CountryCode": "USA",
                "State": "OH",
                "Zipcode": "44039",
                "LocationName": "Test"
            },
            "CompanyName": "Test",
            "Note": "",
            "CompanyID": "",
            "LocationName": null,
            "VendorID": "",
            "DCRefNum": null,
            "Dock": {
                "Name": "Main Dock",
                "Note": "",
                "OpenTime": "2024-04-17T08:00:00",
                "ShipmentDateTime": "2024-04-17T12:00:00",
                "CloseTime": "2024-04-17T17:00:00",
                "ConfirmationNumber": "",
                "FCFS": false
            }
        },
        "Consignee": {
            "ContactInfo": {
                "FirstName": "Al",
                "LastName": "Bundy",
                "ContactName": "Al Bundy",
                "Phone": "",
                "PhoneExt": "",
                "Fax": "",
                "Email": ""
            },
            "AddressInfo": {
                "Address1": "9764 Jeopardy Lane",
                "Address2": "",
                "City": "Chicago",
                "CountryName": "United States",
                "CountryCode": "USA",
                "State": "IL",
                "Zipcode": "60015",
                "LocationName": "The Bundy house"
            },
            "CompanyName": "Test1 comp name",
            "Note": "",
            "CompanyID": "",
            "LocationName": null,
            "VendorID": "",
            "DCRefNum": null,
            "Dock": {
                "Name": "Main Dock",
                "Note": "",
                "OpenTime": "2024-04-18T08:00:00",
                "ShipmentDateTime": "2024-04-18T12:00:00",
                "CloseTime": "2024-04-18T17:00:00",
                "ConfirmationNumber": "",
                "FCFS": false
            }
        },
        "ReturnLocation": null,
        "PackageInfo": {
            "CODAmount": 0,
            "DeclaredLiability": 0,
            "RouteNumber": ""
        },
        "Products": [
            {
                "Quantity": 12,
                "PackageType": 7,
                "Weight": 600,
                "Class": 9,
                "NMFC": "2070",
                "SKU": "Sku-12345",
                "IsHazmat": false,
                "HazmatPhoneNumber": "",
                "HazmatPhoneExt": "",
                "Description": "Women's shoes",
                "Length": 12,
                "Width": 10,
                "Height": 12,
                "UOM": 0,
                "SortOrder": 1,
                "ReferenceNumber": "",
                "ParcelOptions": {
                    "DeliveryConfirmation": 0,
                    "COD": 0,
                    "CODAmount": 0,
                    "AdditionalHandling": false,
                    "LargePackage": false,
                    "DeclaredValue": 0,
                    "UnitValue": null,
                    "UnitWeight": null,
                    "UnitType": null
                },
                "UnNumber": "",
                "HazMatShippingName": "",
                "HazMatPkgGroup": "",
                "HazMatClass": "",
                "InternationalOptions": {
                    "ScheduleBCode": null,
                    "HarmonizedSystemCode": null,
                    "ECCN": null,
                    "UnitOriginCountryCode": null
                },
                "HazMatContact": "",
                "HazMatPoison": false
            }
        ],
        "ShipperAccessorials": {
            "AppointmentRequired": false,
            "InsidePickup": false,
            "SortSegregate": false,
            "PalletJack": false,
            "ResidentialPickup": false,
            "LiftgatePickup": false,
            "MarkingTagging": false,
            "TradeShowPickup": false,
            "NYCMetro": false,
            "NonBusinessHourPickup": false,
            "LimitedAccessType": null
        },
        "ConsigneeAccessorials": {
            "AppointmentRequired": false,
            "InsideDelivery": false,
            "SortSegregate": false,
            "PalletJack": false,
            "ResidentialDelivery": false,
            "LiftgateDelivery": false,
            "MarkingTagging": false,
            "TradeShowDelivery": false,
            "NYCMetro": false,
            "DeliveryNotification": false,
            "TwoHourSpecialDelivery": false,
            "NonBusinessHourDelivery": false,
            "LimitedAccessType": null
        },
        "LoadAccessorials": {
            "Guaranteed": false,
            "TimeDefinite": false,
            "Expedited": false,
            "HolidayPickup": false,
            "HolidayDelivery": false,
            "WeightDetermination": false,
            "BlindShipment": false,
            "BlanketService": false,
            "ProtectFromFreezing": false,
            "SingleShipment": false,
            "CustomsInBond": false,
            "OverDimension": false,
            "Stackable": false,
            "Turnkey": false,
            "FoodGradeProducts": false,
            "TSA": false,
            "Bulkhead": false,
            "SignatureRequired": false,
            "BlanketServiceChilled": false,
            "BlanketServiceFrozen": false,
            "SaturdayDelivery": false,
            "SecondMan": false,
            "ReturnReceipt": false,
            "ShipmentHold": false,
            "ProactiveResponse": false,
            "ShipperRelease": false,
            "WhiteGlove": false,
            "RestrictedDelivery": false,
            "TankerEndorsedDriverRequired": false
        },
        "UserDefined": [],
        "ReferenceField": []
    },
    "DispatchResponse": {
        "LoadID": 62339134,
        "Success": true,
        "PickupNumber": null,
        "CarrierName": "Banyan Test Carrier",
        "QuoteNumber": "12037974",
        "EstimatedDeliveryDate": "2024-04-18T12:00:00",
        "ProNumber": "624500165",
        "UserMessage": null,
        "BOLLink": null,
        "Errors": null,
        "Warnings": null
    },
    "ProNumber": null
}

🟠400Bad Request