GetQuotes
POST
/services/api/rest/GetQuotesThis 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
#/definitions/3334519required
Banyan Credentials
LoadId
integer
required
Banyan's primary shipment identifier
Example
{
"AuthenticationData": {
"Username": "{{username}}",
"Password": "{{password}}",
"ClientRefNum": ""
},
"LoadID": 12345678
}
Request samples
Responses
GetQuotes - 200 OK(200)
GetQuotes - 200 OK
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
ExampleGetQuotes - 200 OK
{
"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
}
]
}
Last modified: 2 months ago