Banyan Technology LIVE Connect™
  1. Manual Quotes
Banyan Technology LIVE Connect™
  • Version 3
    • Authentication
      • Retrieve a token
    • Shipments
      • Creating
        • Create a Full Shipment
        • Create an EZ Rate Shipment
      • Updating
        • Add Document(s) to a Shipment
        • Update a Shipment
        • Adds one or more Reference Numbers to a Shipment
        • Mark as Exported
      • Retrieving
        • Get a Shipment
        • Get multiple Shipments
        • Get Quotes
        • Get Reference Numbers for a Shipment
        • Get documents for the specified shipment.
      • Booking
        • Book a Shipment
        • Unbooks the awarded quote on the specified load.
      • Canceling
        • Cancels a shipment.
    • Invoice
      • Get multiple invoices
      • Mark as Exported
    • Tracking
      • Get tracking statuses
      • Mark as exported.
    • StaticData
      • Accessorials
      • Document Types
      • Equipment Types
      • Package Types
      • Limited Access Types
      • Size UOMs
      • Weight UOMs
      • Pay Types
      • Ship Types
      • Countries
      • Statuses
      • Service Modes
  • Version 2
    • Recommended Workflow
      • Rating
        • ImportForQuote
        • ImportForQuote_Sync
        • GetQuotes
      • Booking/Dispatching
        • BookLoad
      • Tracking
        • GetTrackingStatuses
      • Documents
        • GetDocuments
      • Invoices
        • GetInvoices
        • GetInvoicesWithLoadDetails
    • Additional Offerings
      • Cancelling
        • Cancel a Load
      • Updating
        • UpdateLoad
        • UpdateLoadStatus
        • UpdateShipmentsExport
      • Importing
        • PendingImport
        • ImportForBook
      • Manual Quotes
        • AddManualQuote
          POST
      • EZ Rates
        • EzRate
        • EzRate_Sync
      • Waterfall Tendering
        • StartWaterfallTendering
        • CancelWaterfallTendering
      • Unbooking
        • UnBookLoad
      • Additional Dispatching
        • DispatchLoad
      • Load Details
        • GetLoadDetails
        • GetNotes
      • Additional Tracking
        • GetTrackingByLoad
      • Other
        • Normalized Charge Codes
      • SOAP
    • Changelog
  • Exports and Webhooks
    • Standard Load Export - v1
    • Standard Load Export - v2
    • Standard Load Export - v3
    • Push Tracking
  1. Manual Quotes

AddManualQuote

POST
/services/api/rest/AddManualQuote
This function will add a manual quote to a specified shipment. Primary use is when there is some type of unautomated relation with a carrier.
A valid SCAC code is required.

Request

Header Params
Accept
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
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
Example
{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "LoadID":"",
   "QuoteInformation":{
      "QuoteID":null,
      "Scac":"ABCD",
      "TransitTime":null,
      "TotalCharge":"300.0",
      "FreightCharge":null,
      "FuelSurcharge":null,
      "DiscountPercentage":null,
      "DiscountAmount":null,
      "AccessorialFees":null,
      "Minumum":null,
      "GrossCharge":null,
      "OtherCharge":null,
      "Tariff":"None",
      "Interline":"true",
      "Miles":null,
      "QuoteNumber":"4321",
      "AccountNumber":null,
      "CarrierPrice":"325.0",
      "CustomerPrice":"325.0",
      "Note":"Notes go here",
      "CurrencyID":"0"
   }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://ws.integration.banyantechnology.com/services/api/rest/AddManualQuote' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "LoadID":"",
   "QuoteInformation":{
      "QuoteID":null,
      "Scac":"ABCD",
      "TransitTime":null,
      "TotalCharge":"300.0",
      "FreightCharge":null,
      "FuelSurcharge":null,
      "DiscountPercentage":null,
      "DiscountAmount":null,
      "AccessorialFees":null,
      "Minumum":null,
      "GrossCharge":null,
      "OtherCharge":null,
      "Tariff":"None",
      "Interline":"true",
      "Miles":null,
      "QuoteNumber":"4321",
      "AccountNumber":null,
      "CarrierPrice":"325.0",
      "CustomerPrice":"325.0",
      "Note":"Notes go here",
      "CurrencyID":"0"
   }
}'

Responses

🟢200AddManualQuote - 200 OK
application/json
Body
Success
boolean 
required
Success related to the AddManualQuote request
Error
object (ErrorObject) 
optional
Error related to the failure of the request
Message
string 
required
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
Example
{
    "Success": true,
    "Error": null,
    "LoadID": 12345678,
    "QuoteInformation": {
        "QuoteID": 123456789,
        "SCAC": "ABCD",
        "TransitTime": 4,
        "TotalCharge": 300,
        "FreightCharge": null,
        "FuelSurcharge": null,
        "DiscountPercentage": 0,
        "DiscountAmount": 0,
        "AccessorialFees": null,
        "Minumum": null,
        "GrossCharge": null,
        "OtherCharges": null,
        "Tariff": "None",
        "Interline": true,
        "Miles": null,
        "QuoteNumber": "4321",
        "AccountNumber": null,
        "CarrierPrice": 325,
        "CustomerPrice": 325,
        "Note": "Notes go here",
        "CurrencyID": 0
    }
}
Modified at 2024-09-16 11:42:17
Previous
ImportForBook
Next
EzRate
Built with