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

string

required

Example:

application/json

Body Params application/json

AuthenticationData

object (Authentication Data)

required

Banyan Credentials

Username

string

required

Banyan Username

Password

string

required

Banyan Password

ClientRefNum

string | null

optional

Client Reference Number - Used during multiple client integrations

BOLNumber

string

optional

Requested BOL number for the shipment

PickupDateTime

string <date-time>

optional

Date and Time for the requested dispatch

DispatchLoad

boolean

required

Move the shipment into dispatch status

DispatchOverride

boolean

required

If dispatch fails with carrier, attempt the follow in order till success: - Attempt EDI 204 (Load Tender) - Attempt email to carrier - Move load into dispatched status, return note

SubmitPickup

boolean

required

When true, a dispatch request will be sent to the carrier.

ProNumber

string

optional

Update the pro number on the shipment

ActualCarrierName

string

optional

Carrier name of the requested quote

QuoteInformation

object (ManualQuote)

required

The manual quote information

quoteID

integer | null

optional

Banyan's primary quote identifier

scac

string

required

Carrier's standard carrier alpha code - SCAC must belong to a carrier that client is subscribed to

transitTime

integer | null

optional

Quote's assigned transit time

totalCharge

number <float>

required

Quote total charge amount

freightCharge

number <float> | null

optional

Quote freight charge amount

fuelSurcharge

number <float> | null

optional

Quote fuel surcharge amount

discountPercentage

number <float> | null

optional

Quote discount percentage

discountAmount

number <float> | null

optional

Quote discount amount

accessorialFees

number <float> | null

optional

Quote accessorial fees amount

minumum

number <float> | null

optional

Quote minimum charge amount

grossCharge

number <float> | null

optional

Quote gross charge amount

otherCharges

number <float> | null

optional

Quote's other charges amount

tariff

string | null

optional

Quote tariff

interline

boolean

required

Set to true only when confirmed to be interline

miles

integer | null

optional

Quote's mileage amount

quoteNumber

string | null

optional

Quote identifier (carrier assigned)

accountNumber

string | null

optional

Account Number for carrier to use if more than 1 subscription exists

carrierPrice

number <float> | null

optional

Quote's carrier pricing amount

customerPrice

number <float> | null

optional

Quote's customer pricing amount

note

string | null

optional

Quote Note

currencyID

enum<string>

required

Quote's currency

Allowed values:

US_DollarCanadian_DollarMexican_Peso

thirdPartySCAC

string | null

optional

Carrier's standard carrier alpha code of third party

carrierName

string | null

optional

Carrier name used on the manual quote

serviceLevel

string | null

optional

Carrier service level used on the manual quote

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.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
  },
  "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,
      "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,
      "Class": 0,
      "NMFC": "12345",
      "SKU": null,
      "IsHazmat": false,
      "HazmatPhoneNumber": null,
      "HazmatPhoneExt": null,
      "Description": "TestProduct",
      "Length": 10,
      "Width": 10,
      "Height": 10,
      "UOM": 1,
      "SortOrder": 0,
      "ReferenceNumber": "123",
      "ParcelOptions": {
        "DeliveryConfirmation": 0,
        "COD": 0,
        "CODAmount": 0,
        "InsuranceAmount": 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 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

LoadId

integer

required

Banyan's primary Shipment Identifier

QuoteInformation

object (ManualQuote)

required

The manual quote information

quoteID

integer | null

optional

Banyan's primary quote identifier

scac

string

required

Carrier's standard carrier alpha code - SCAC must belong to a carrier that client is subscribed to

transitTime

integer | null

optional

Quote's assigned transit time

totalCharge

number <float>

required

Quote total charge amount

freightCharge

number <float> | null

optional

Quote freight charge amount

fuelSurcharge

number <float> | null

optional

Quote fuel surcharge amount

discountPercentage

number <float> | null

optional

Quote discount percentage

discountAmount

number <float> | null

optional

Quote discount amount

accessorialFees

number <float> | null

optional

Quote accessorial fees amount

minumum

number <float> | null

optional

Quote minimum charge amount

grossCharge

number <float> | null

optional

Quote gross charge amount

otherCharges

number <float> | null

optional

Quote's other charges amount

tariff

string | null

optional

Quote tariff

interline

boolean

required

Set to true only when confirmed to be interline

miles

integer | null

optional

Quote's mileage amount

quoteNumber

string | null

optional

Quote identifier (carrier assigned)

accountNumber

string | null

optional

Account Number for carrier to use if more than 1 subscription exists

carrierPrice

number <float> | null

optional

Quote's carrier pricing amount

customerPrice

number <float> | null

optional

Quote's customer pricing amount

note

string | null

optional

Quote Note

currencyID

enum<string>

required

Quote's currency

Allowed values:

US_DollarCanadian_DollarMexican_Peso

thirdPartySCAC

string | null

optional

Carrier's standard carrier alpha code of third party

carrierName

string | null

optional

Carrier name used on the manual quote

serviceLevel

string | null

optional

Carrier service level used on the manual quote

BookResponse

object (BookLoadResponse)

required

Object that contains booking/dispatching responses

Success

boolean

required

Success of booking of the requested manual quote

Error

object (ErrorObject)

optional

Error message supplied when request fails

Request

object

required

Full shipment details

DispatchResponse

object (DispatchResponse)

required

Response of the dispatch request (supplied when dispatching is requested)

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
  }
}