Banyan Technology LIVE Connect™
  1. Version 2
  2. Recommended Workflow
  3. Rating
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
          POST
        • ImportForQuote_Sync
          POST
        • GetQuotes
          POST
      • 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
      • 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. Version 2
  2. Recommended Workflow
  3. Rating

GetQuotes

POST
/services/api/rest/GetQuotes
This function will retrieve all the valid quotes for a given shipment.

Request

Header Params
Content-Type
string 
required
Example:
application/json
Accept
string 
optional
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
Example
{
  "AuthenticationData": {
    "Username": "{{username}}",
    "Password": "{{password}}",
    "ClientRefNum": ""
  },
  "LoadID": 12345678
}

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/GetQuotes' \
--header 'Content-Type: application/json' \
--data-raw '{
   "AuthenticationData":{
      "Username":"{{username}}",
      "Password":"{{password}}",
      "ClientRefNum":""
   },
   "LoadID": 12345678
}'

Responses

🟢200GetQuotes - 200 OK
application/json
Body
Success
boolean 
required
Success of the GetQuotes request
Error
optional
Error message related to the failure of the request
Any of
Message
string 
required
LoadId
integer 
required
Banyan's primary shipment identifier
RatingCompleted
boolean 
required
Rating process complete
Quotes
array[object (Quote) {21}] 
required
List of Carrier Quotes
LoadID
integer 
required
Banyan's primary shipment identifier (In this object, the main shipment LoadID is reflected here)
QuoteID
integer 
required
Banyan's primary quote identifier
CarrierName
string 
required
Carrier name
SCAC
string 
required
Carrier standard carrier alpha code
ThirdPartyName
string 
required
ThirdPartySCAC
string 
required
ServiceID
string 
required
Quote service identifier
RawPrice
object (PriceBreakout) 
required
Quote raw price (returned from the carrier)
CarrierPrice
object (PriceBreakout) 
required
Quote carrier price (carrier markups applied)
CustomerPrice
object (PriceBreakout) 
required
Quote customer price (customer markups applied)
TransitTime
integer 
required
Quote transit time
QuoteNumber
string 
optional
Carrier quote identifier
AccountNumber
string 
optional
Account Number/ID used for Quote (if any)
CarrierPerson
string 
optional
Carrier person
CarrierNote
string 
optional
Note returned by the carrier regarding the quote
Datestamp
string 
required
Quote date
Interline
boolean 
required
Set to true only when confirmed to be interline
Accepted
boolean 
required
Quote has been accepted by client
CurrencyType
enum<string> 
required
Quote currency type
Allowed values:
US_DollarCanadian_DollarMexican_Peso
Service
enum<string> 
required
Quote service
Allowed values:
ParcelLTLVolumeAirOceanGFPLocal CarrierFTLDriveawayIntermodalExpedite
InsuranceDetails
object (InsuranceDetails) 
optional
Insurance Details related to the quote
PendingQuotes
array[object (PendingQuote) {6}]  | null 
required
List of Pending Carrier Quotes
QuoteID
integer 
required
The primary identifier for the quote
CarrierName
string 
required
The carrier's name that is related to this quote
SCAC
string 
required
The carrier's SCAC code that is related to this quote
PendingQuoteType
enum<string> 
required
The pending quote type
Allowed value:
EmailQuote
Datestamp
string 
required
The date and time this request was sent out
Service
enum<string> 
required
Quote service
Allowed values:
ParcelLTLVolumeAirOceanGFPLocal CarrierFTLDriveawayIntermodalExpedite
FailedQuotes
array[object (FailedQuote) {6}]  | null 
required
List of Failed Carrier Quotes
CarrierName
string 
required
The carrier's name that is related to this quote
SCAC
string 
required
The carrier's SCAC code that is related to this quote
ReasonCode
enum<string> 
required
Code for failure reason
Allowed values:
GeneralIssueAuthorizationAccountTariffConfigurationManualRatingRequiredCoverageAreaHazardousMaterialPackageTypeEquipmentTypeShipTypePayTypeShipTypePayTypeCombinationPickupDateBillToFreightClassMaximumProductThresholdMissingProductDimensionsMaximumDimensionsProductDimensionsProductDescriptionNMFCMaximumWeightThresholdMinimumWeightThresholdShippingUnitsMinimumShippingUnitsMaximumShippingUnitsMissingShipmentDimensionsShipperConsigneeShipperOrConsigneeLimitedAccessTypeAccessorialCODAmount
Reason
enum<string> 
required
Message regarding failure reason
Allowed values:
GeneralIssueAuthorizationAccountTariffConfigurationManualRatingRequiredCoverageAreaHazardousMaterialPackageTypeEquipmentTypeShipTypePayTypeShipTypePayTypeCombinationPickupDateBillToFreightClassMaximumProductThresholdMissingProductDimensionsMaximumDimensionsProductDimensionsProductDescriptionNMFCMaximumWeightThresholdMinimumWeightThresholdShippingUnitsMinimumShippingUnitsMaximumShippingUnitsMissingShipmentDimensionsShipperConsigneeShipperOrConsigneeLimitedAccessTypeAccessorialCODAmount
Datestamp
string <date-time>
required
The date and time this request was sent out
Service
enum<string> 
required
Quote service
Allowed values:
ParcelLTLVolumeAirOceanGFPLocal CarrierFTLDriveawayIntermodalExpedite
Notes
array[object (Note) {4}] 
required
Shipment & carrier notes
Text
string 
required
Note text
User
string 
required
Note creator
DateStamp
string 
required
Note date
NoteType
enum<string> 
required
Note Type
Allowed values:
AccountingAdjustmentEmailArchivingQuoteUpdateCarrierAwardedQuoteTechnicalNoteWebTrackingEdiSystemEventInstructionsPublicBookReasonWebDispatchQuoteRequestPrivateContactAccountingTerminalUrlCustomerDockUpdateAddressDeleteQuotePackageRateExceptionBillingReasonAdditionalServiceValidationQuoteQuoteRequestEmail
Example
{
  "Success": true,
  "Error": null,
  "LoadID": 62339134,
  "RatingCompleted": true,
  "Quotes": [
    {
      "LoadID": 62339134,
      "QuoteID": 486574985,
      "CarrierName": "Banyan Test Carrier",
      "SCAC": "BTST",
      "ThirdPartyName": "",
      "ThirdPartySCAC": "",
      "ServiceID": "67593586",
      "RawPrice": {
        "NetPrice": 134.33,
        "FreightCharge": 100.02,
        "DiscountAmount": 1270.05,
        "FuelSurcharge": 34.31,
        "Minimum": 0,
        "GrossCharge": 1370.07,
        "Tariff": 0,
        "Interline": 0,
        "AccessorialCharges": 0,
        "OtherCharges": 0,
        "Charges": [],
        "Markup": 0
      },
      "CarrierPrice": {
        "NetPrice": 134.33,
        "FreightCharge": 100.02,
        "DiscountAmount": 1270.05,
        "FuelSurcharge": 34.31,
        "Minimum": 0,
        "GrossCharge": 1370.07,
        "Tariff": 0,
        "Interline": 0,
        "AccessorialCharges": 0,
        "OtherCharges": 0,
        "Charges": [],
        "Markup": 0
      },
      "CustomerPrice": {
        "NetPrice": 161.2,
        "FreightCharge": 120.03,
        "DiscountAmount": 1524.1,
        "FuelSurcharge": 41.17,
        "Minimum": 0,
        "GrossCharge": 1644.12,
        "Tariff": 0,
        "Interline": 0,
        "AccessorialCharges": 0,
        "OtherCharges": 0,
        "Charges": [],
        "Markup": 20
      },
      "TransitTime": 1,
      "QuoteNumber": "12037974",
      "CarrierPerson": "Test Carrier Automated Quote",
      "CarrierNote": "",
      "Datestamp": "2024-03-07T15:47:28",
      "Interline": false,
      "Accepted": false,
      "CurrencyType": 0,
      "Service": 1,
      "InsuranceDetails": null,
      "AccountNumber": "TOT799"
    },
    {
      "LoadID": 62339134,
      "QuoteID": 486574986,
      "CarrierName": "Old Dominion Frt Line",
      "SCAC": "ODFL",
      "ThirdPartyName": "",
      "ThirdPartySCAC": "",
      "ServiceID": "67593586",
      "RawPrice": {
        "NetPrice": 457.9,
        "FreightCharge": 350.88,
        "DiscountAmount": 52.9,
        "FuelSurcharge": 107.02,
        "Minimum": 0,
        "GrossCharge": 403.78,
        "Tariff": 0,
        "Interline": 0,
        "AccessorialCharges": 0,
        "OtherCharges": 0,
        "Charges": [],
        "Markup": 0
      },
      "CarrierPrice": {
        "NetPrice": 457.9,
        "FreightCharge": 350.88,
        "DiscountAmount": 52.9,
        "FuelSurcharge": 107.02,
        "Minimum": 0,
        "GrossCharge": 403.78,
        "Tariff": 0,
        "Interline": 0,
        "AccessorialCharges": 0,
        "OtherCharges": 0,
        "Charges": [],
        "Markup": 0
      },
      "CustomerPrice": {
        "NetPrice": 549.48,
        "FreightCharge": 421.06,
        "DiscountAmount": 63.48,
        "FuelSurcharge": 128.42,
        "Minimum": 0,
        "GrossCharge": 484.54,
        "Tariff": 0,
        "Interline": 0,
        "AccessorialCharges": 0,
        "OtherCharges": 0,
        "Charges": [],
        "Markup": 20
      },
      "TransitTime": 1,
      "QuoteNumber": "942483625",
      "CarrierPerson": "Old Dominion Automated Quote",
      "CarrierNote": "",
      "Datestamp": "2024-03-07T15:47:32",
      "Interline": false,
      "Accepted": false,
      "CurrencyType": 0,
      "Service": 1,
      "InsuranceDetails": null,
      "AccountNumber": "12402756"
    }
  ],
  "PendingQuotes": null,
  "FailedQuotes": [
    {
      "CarrierName": "AAA Cooper",
      "SCAC": "AACT",
      "Service": 1,
      "ReasonCode": 1,
      "Reason": "Carrier’s website returned an error when rating this shipment.",
      "Datestamp": "2024-03-07T15:47:26.717"
    },
    {
      "CarrierName": "American Transport Group",
      "SCAC": "AMTG",
      "Service": 1,
      "ReasonCode": 3,
      "Reason": "Account with this carrier is not valid.",
      "Datestamp": "2024-03-07T15:47:29.647"
    }
  ],
  "Notes": [
    {
      "Text": "Load exported via FTP.",
      "User": "Automation",
      "DateStamp": "2024-03-07T15:47:50",
      "NoteType": 10
    },
    {
      "Text": "REGRESSION TESTING",
      "User": "Automation",
      "DateStamp": "2024-03-07T15:47:50",
      "NoteType": 12
    },
    {
      "Text": "Dayton Freight Standard: Unable to process your rating request, please contact our Pricing department at the email address: pricing@daytonfreight.com. Error: Invalid or Inactive Account specified.",
      "User": "Automation",
      "DateStamp": "2024-03-07T15:47:26",
      "NoteType": 15
    },
    {
      "Text": "Patch.IO carbon footprint: 149.172 kg\n Estimated offset cost: 0.72 USD",
      "User": "Test User",
      "DateStamp": "2024-03-07T15:47:25",
      "NoteType": 18
    },
    {
      "Text": "No carbon project configured for your vendor. Patch.io will select a project.",
      "User": "Test User",
      "DateStamp": "2024-03-07T15:47:25",
      "NoteType": 5
    },
    {
      "Text": "Load Created",
      "User": "Test User",
      "DateStamp": "2024-03-07T15:47:22",
      "NoteType": 10
    },
    {
      "Text": "Original BOLID: BOL1234",
      "User": "Automation",
      "DateStamp": "2024-03-07T15:47:22",
      "NoteType": 7
    }
  ]
}
Modified at 2024-09-16 11:42:17
Previous
ImportForQuote_Sync
Next
BookLoad
Built with