ImportForBook - Banyan Technology LIVE Connect™

This function will add a shipment, add a manual quote to that shipment, and book that manual quote.

Dispatching the requested manual quote is optional.

Request

Header Params

Body Params application/json

Example

{
   "PickupDateTime":"2018-07-25T00:00:00",
   "BOLNumber":"",
   "DispatchLoad":false,
   "DispatchOverride":true,
   "SubmitPickup":false,
   "ProNumber":"",
   "ActualCarrierName":"YRC Inc.",
   "QuoteInformation":{
      "QuoteID":null,
      "SCAC":"RDWY",
      "TransitTime":5,
      "TotalCharge":259.50,
      "FreightCharge":2.00,
      "FuelSurcharge":5.00,
      "DiscountPercentage":0.25,
      "DiscountAmount":0.50,
      "AccessorialFees":0.0,
      "Minumum":0.0,
      "GrossCharge":58.00,
      "OtherCharges":200.00,
      "Tariff":"1",
      "Interline":false,
      "Miles":100,
      "QuoteNumber":"",
      "AccountNumber":"123",
      "CarrierPrice":50.00,
      "CustomerPrice":51.50,
      "Note":"This is a note.",
      "CurrencyID":0
   },
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "Loadinfo":{
      "LoadID":null,
      "ManifestID":null,
      "BOLNumber":"SFBOL1",
      "CustomerPO":"SPPO1",
      "InvoiceID":"SPINVOICE1",
      "BillingID":null,
      "IncoTermID":null
   },
   "BillTo":{
      "Name":" Test BillTo Address",
      "Note":" Test BillTo",
      "ShipType":0,
      "PayType":1,
      "UseDefaultBillTo":true,
      "AddressInfo":{
         "Address1":null,
         "Address2":null,
         "City":null,
         "CountryName":null,
         "CountryCode":null,
         "State":null,
         "Zipcode":null,
         "LocationName":null
      },
      "ContactInfo":{
         "FirstName":"Test",
         "LastName":"User",
         "ContactName":"Test Contact",
         "Phone":"555-555-5555",
         "PhoneExt":null,
         "Fax":null,
         "Email":"test@.test.com"
      }
   },
   "RateServices":[
      {
         "ServiceCode":"LTL",
         "ShippingQty":1,
         "PackageType":29,
         "EquipmentType":5,
         "AdditionalWeight":0.0,
         "SpecialInstructions":null,
         "Length":null,
         "Width":null,
         "Height":null,
         "WeightUom":0,
         "SizeUom":0
      }
   ],
   "Shipper":{
      "ContactInfo":{
         "FirstName":"Test",
         "LastName":" User",
         "ContactName":"Test Contact",
         "Phone":"555-555-5555",
         "PhoneExt":null,
         "Fax":null,
         "Email":"test@.test.com"
      },
      "AddressInfo":{
         "Address1":"123 Main",
         "Address2":"",
         "City":"Cleveland",
         "CountryName":"USA",
         "CountryCode":"US",
         "State":"OH",
         "Zipcode":"12345",
         "LocationName":" Test Address"
      },
      "CompanyName":"Test Company",
      "Note":"This is a test shipper",
      "CompanyID":"SFTC",
      "LocationName":"Test Location",
      "VendorID":null,
      "DCRefNum":"Test Ref Num",
      "Dock":{
         "Name":" Test Dock",
         "Note":" Test Note",
         "OpenTime":null,
         "ShipmentDateTime":null,
         "CloseTime":null,
         "ConfirmationNumber":"12345",
         "FCFS":null
      }
   },
   "Consignee":{
      "ContactInfo":{
         "FirstName":"Test",
         "LastName":"User",
         "ContactName":" Test Contact",
         "Phone":"555-555-5555",
         "PhoneExt":null,
         "Fax":null,
         "Email":"test@.test.com"
      },
      "AddressInfo":{
         "Address1":"123 Main",
         "Address2":"",
         "City":"Cleveland",
         "CountryName":"USA",
         "CountryCode":"US",
         "State":"OH",
         "Zipcode":"12345",
         "LocationName":" Test Address"
      },
      "CompanyName":" Test Consignee Company",
      "Note":" Test Consignee",
      "CompanyID":"SFTC",
      "LocationName":" Test Consignee Location",
      "VendorID":null,
      "DCRefNum":null,
      "Dock":{
         "Name":" Test Dock",
         "Note":" Test Note",
         "OpenTime":null,
         "ShipmentDateTime":null,
         "CloseTime":null,
         "ConfirmationNumber":"12345",
         "FCFS":null
      }
   },
   "PackageInfo":{
      "CODAmount":null,
      "DeclaredLiability":null
   },
   "Products":[
      {
         "Quantity":1,
         "PackageType":29,
         "Weight":10.0,
         "Class":0,
         "NMFC":"12345",
         "SKU":null,
         "IsHazmat":false,
         "HazmatPhoneNumber":null,
         "HazmatPhoneExt":null,
         "Description":"TestProduct",
         "Length":10.0,
         "Width":10.0,
         "Height":10.0,
         "UOM":1,
         "SortOrder":0,
         "ReferenceNumber":"123",
         "ParcelOptions":{
            "DeliveryConfirmation":0,
            "COD":0,
            "CODAmount":0.0,
            "InsuranceAmount":0.0
         }
      }
   ],
   "ShipperAccessorials":{
      "AppointmentRequired":false,
      "InsidePickup":false,
      "SortSegregate":false,
      "PalletJack":false,
      "ResidentialPickup":false,
      "LiftgatePickup":false,
      "MarkingTagging":false,
      "TradeShowPickup":false,
      "NYCMetro":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,
      "LimitedAccessType":null
   },
   "LoadAccessorials":{
      "Guaranteed":false,
      "TimeDefinite":false,
      "Expedited":false,
      "HolidayPickup":false,
      "HolidayDelivery":false,
      "WeightDetermination":false,
      "BlindShipment":false,
      "BlanketService":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,
      "TankerEndorsedDriverRequired":false
   },
   "UserDefined":[

   ],
   "ReferenceField":[

   ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ws.integration.banyantechnology.com/services/api/rest/ImportForBook' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
   "PickupDateTime":"2018-07-25T00:00:00",
   "BOLNumber":"",
   "DispatchLoad":false,
   "DispatchOverride":true,
   "SubmitPickup":false,
   "ProNumber":"",
   "ActualCarrierName":"YRC Inc.",
   "QuoteInformation":{
      "QuoteID":null,
      "SCAC":"RDWY",
      "TransitTime":5,
      "TotalCharge":259.50,
      "FreightCharge":2.00,
      "FuelSurcharge":5.00,
      "DiscountPercentage":0.25,
      "DiscountAmount":0.50,
      "AccessorialFees":0.0,
      "Minumum":0.0,
      "GrossCharge":58.00,
      "OtherCharges":200.00,
      "Tariff":"1",
      "Interline":false,
      "Miles":100,
      "QuoteNumber":"",
      "AccountNumber":"123",
      "CarrierPrice":50.00,
      "CustomerPrice":51.50,
      "Note":"This is a note.",
      "CurrencyID":0
   },
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "Loadinfo":{
      "LoadID":null,
      "ManifestID":null,
      "BOLNumber":"SFBOL1",
      "CustomerPO":"SPPO1",
      "InvoiceID":"SPINVOICE1",
      "BillingID":null,
      "IncoTermID":null
   },
   "BillTo":{
      "Name":" Test BillTo Address",
      "Note":" Test BillTo",
      "ShipType":0,
      "PayType":1,
      "UseDefaultBillTo":true,
      "AddressInfo":{
         "Address1":null,
         "Address2":null,
         "City":null,
         "CountryName":null,
         "CountryCode":null,
         "State":null,
         "Zipcode":null,
         "LocationName":null
      },
      "ContactInfo":{
         "FirstName":"Test",
         "LastName":"User",
         "ContactName":"Test Contact",
         "Phone":"555-555-5555",
         "PhoneExt":null,
         "Fax":null,
         "Email":"test@.test.com"
      }
   },
   "RateServices":[
      {
         "ServiceCode":"LTL",
         "ShippingQty":1,
         "PackageType":29,
         "EquipmentType":5,
         "AdditionalWeight":0.0,
         "SpecialInstructions":null,
         "Length":null,
         "Width":null,
         "Height":null,
         "WeightUom":0,
         "SizeUom":0
      }
   ],
   "Shipper":{
      "ContactInfo":{
         "FirstName":"Test",
         "LastName":" User",
         "ContactName":"Test Contact",
         "Phone":"555-555-5555",
         "PhoneExt":null,
         "Fax":null,
         "Email":"test@.test.com"
      },
      "AddressInfo":{
         "Address1":"123 Main",
         "Address2":"",
         "City":"Cleveland",
         "CountryName":"USA",
         "CountryCode":"US",
         "State":"OH",
         "Zipcode":"12345",
         "LocationName":" Test Address"
      },
      "CompanyName":"Test Company",
      "Note":"This is a test shipper",
      "CompanyID":"SFTC",
      "LocationName":"Test Location",
      "VendorID":null,
      "DCRefNum":"Test Ref Num",
      "Dock":{
         "Name":" Test Dock",
         "Note":" Test Note",
         "OpenTime":null,
         "ShipmentDateTime":null,
         "CloseTime":null,
         "ConfirmationNumber":"12345",
         "FCFS":null
      }
   },
   "Consignee":{
      "ContactInfo":{
         "FirstName":"Test",
         "LastName":"User",
         "ContactName":" Test Contact",
         "Phone":"555-555-5555",
         "PhoneExt":null,
         "Fax":null,
         "Email":"test@.test.com"
      },
      "AddressInfo":{
         "Address1":"123 Main",
         "Address2":"",
         "City":"Cleveland",
         "CountryName":"USA",
         "CountryCode":"US",
         "State":"OH",
         "Zipcode":"12345",
         "LocationName":" Test Address"
      },
      "CompanyName":" Test Consignee Company",
      "Note":" Test Consignee",
      "CompanyID":"SFTC",
      "LocationName":" Test Consignee Location",
      "VendorID":null,
      "DCRefNum":null,
      "Dock":{
         "Name":" Test Dock",
         "Note":" Test Note",
         "OpenTime":null,
         "ShipmentDateTime":null,
         "CloseTime":null,
         "ConfirmationNumber":"12345",
         "FCFS":null
      }
   },
   "PackageInfo":{
      "CODAmount":null,
      "DeclaredLiability":null
   },
   "Products":[
      {
         "Quantity":1,
         "PackageType":29,
         "Weight":10.0,
         "Class":0,
         "NMFC":"12345",
         "SKU":null,
         "IsHazmat":false,
         "HazmatPhoneNumber":null,
         "HazmatPhoneExt":null,
         "Description":"TestProduct",
         "Length":10.0,
         "Width":10.0,
         "Height":10.0,
         "UOM":1,
         "SortOrder":0,
         "ReferenceNumber":"123",
         "ParcelOptions":{
            "DeliveryConfirmation":0,
            "COD":0,
            "CODAmount":0.0,
            "InsuranceAmount":0.0
         }
      }
   ],
   "ShipperAccessorials":{
      "AppointmentRequired":false,
      "InsidePickup":false,
      "SortSegregate":false,
      "PalletJack":false,
      "ResidentialPickup":false,
      "LiftgatePickup":false,
      "MarkingTagging":false,
      "TradeShowPickup":false,
      "NYCMetro":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,
      "LimitedAccessType":null
   },
   "LoadAccessorials":{
      "Guaranteed":false,
      "TimeDefinite":false,
      "Expedited":false,
      "HolidayPickup":false,
      "HolidayDelivery":false,
      "WeightDetermination":false,
      "BlindShipment":false,
      "BlanketService":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,
      "TankerEndorsedDriverRequired":false
   },
   "UserDefined":[

   ],
   "ReferenceField":[

   ]
}'

Responses

🟢200ImportForBook - 200 OK

application/json

Body

Example

{
    "LoadID": 12345678,
    "QuoteInformation": {
        "QuoteID": 123456789,
        "SCAC": "RLCA",
        "TransitTime": 5,
        "TotalCharge": 259.5,
        "FreightCharge": 2,
        "FuelSurcharge": 5,
        "DiscountPercentage": 0.25,
        "DiscountAmount": 0.5,
        "AccessorialFees": 0,
        "Minumum": 0,
        "GrossCharge": 58,
        "OtherCharges": 200,
        "Tariff": "1",
        "Interline": false,
        "Miles": 100,
        "QuoteNumber": "",
        "AccountNumber": "123",
        "CarrierPrice": 50,
        "CustomerPrice": 51.5,
        "Note": "This is a note.",
        "CurrencyID": 0
    },
    "BookResponse": {
        "Success": true,
        "Error": null,
        "request": {
            "AuthenticationData": {
                "Username": null,
                "Password": null,
                "ClientRefNum": null
            },
            "Loadinfo": {
                "LoadID": null,
                "ManifestID": null,
                "BOLNumber": null,
                "CustomerPO": null,
                "InvoiceID": null,
                "BillingID": null,
                "IncoTermID": null
            },
            "BillTo": {
                "Name": null,
                "Note": null,
                "ShipType": 0,
                "PayType": 0,
                "UseDefaultBillTo": false,
                "AddressInfo": null,
                "ContactInfo": null
            },
            "InsuranceInfo": null,
            "RateServices": [],
            "Shipper": {
                "ContactInfo": {
                    "FirstName": null,
                    "LastName": null,
                    "ContactName": null,
                    "Phone": "",
                    "PhoneExt": null,
                    "Fax": null,
                    "Email": null
                },
                "AddressInfo": {
                    "Address1": null,
                    "Address2": null,
                    "City": null,
                    "CountryName": null,
                    "CountryCode": null,
                    "State": null,
                    "Zipcode": null,
                    "LocationName": null
                },
                "CompanyName": null,
                "Note": null,
                "CompanyID": null,
                "LocationName": null,
                "VendorID": null,
                "DCRefNum": null,
                "Dock": {
                    "Name": null,
                    "Note": null,
                    "OpenTime": null,
                    "ShipmentDateTime": null,
                    "CloseTime": null,
                    "ConfirmationNumber": null,
                    "FCFS": null
                }
            },
            "Consignee": {
                "ContactInfo": {
                    "FirstName": null,
                    "LastName": null,
                    "ContactName": null,
                    "Phone": "",
                    "PhoneExt": null,
                    "Fax": null,
                    "Email": null
                },
                "AddressInfo": {
                    "Address1": null,
                    "Address2": null,
                    "City": null,
                    "CountryName": null,
                    "CountryCode": null,
                    "State": null,
                    "Zipcode": null,
                    "LocationName": null
                },
                "CompanyName": null,
                "Note": null,
                "CompanyID": null,
                "LocationName": null,
                "VendorID": null,
                "DCRefNum": null,
                "Dock": {
                    "Name": null,
                    "Note": null,
                    "OpenTime": null,
                    "ShipmentDateTime": null,
                    "CloseTime": null,
                    "ConfirmationNumber": null,
                    "FCFS": null
                }
            },
            "PackageInfo": {
                "CODAmount": null,
                "DeclaredLiability": null
            },
            "Products": [],
            "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,
                "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
            },
            "UserDefined": [],
            "ReferenceField": []
        },
        "DispatchResponse": {
            "LoadID": 0,
            "Success": false,
            "PickupNumber": null,
            "CarrierName": null,
            "QuoteNumber": null,
            "EstimatedDeliveryDate": "0001-01-01T00:00:00",
            "ProNumber": null,
            "UserMessage": null,
            "BOLLink": null,
            "Errors": null,
            "Warnings": null
        },
        "ProNumber": null
    }
}