Get Quotes

Retrieve the quotes of a single Shipment by its id.

This endpoint is useful for retrieving quotes when setting waitForRates to false on create requests.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

array of:

shipmentId

integer <int32>

optional

Gets or sets the shipment identifier.

ratingCompleted

boolean

optional

Gets or sets a value indicating whether [rating completed].

quotes

array[object (QuoteDto) {21}] | null

optional

Gets or sets the quotes.

quoteId

integer <int32>

optional

Banyan's primary quote identifier

carrierName

string

optional

Carrier name

carrierId

integer <int32>

optional

Banyan's primary carrier identifier

scac

string

optional

Carrier standard carrier alpha code

thirdPartyName

string | null

optional

Typically set when the quote is from a 3PL. This will contain the 3pl carrier's name.

thirdPartyScac

string | null

optional

3PL standard carrier alpha code

serviceId

string | null

optional

Quote service identifier

rawPrice

object (QuotePriceDto)

optional

Quote raw price (returned from the carrier)

carrierPrice

object (QuotePriceDto)

optional

Quote carrier price (carrier markups applied)

customerPrice

object (QuotePriceDto)

optional

Quote customer price (customer markups applied)

transitTime

integer <int32>

optional

Quote transit time

quoteNumber

string | null

optional

Carrier quote identifier

carrierPerson

string | null

optional

Carrier person

carrierNote

string | null

optional

Note returned by the carrier regarding the quote

dateStamp

string <date-time>

optional

Quote date

interline

boolean

optional

Set to true only when confirmed to be interline

accepted

boolean

optional

Quote has been accepted by client

currencyType

optional

Quote currency type

service

string | null

optional

Quote service

insuranceDetails

optional

Insurance Details related to the quote

accountNumber

string | null

optional

Account Number/ID used for Quote (if any)

failedQuotes

array[object (BanyanWebServices.Domain.Dtos.Quotes.FailedQuoteDto) {6}] | null

optional

Gets or sets the failed quotes.

carrierName

string | null

optional

Gets or sets the name of the carrier.

scac

string | null

optional

Gets or sets the scac.

service

string | null

optional

Gets or sets the service.

reasonCode

integer <int32>

optional

Gets or sets the reason code.

reason

string | null

optional

Gets or sets the reason.

dateStamp

string <date-time>

optional

Gets or sets the date stamp.

pendingQuotes

array[object (BanyanWebServices.Domain.Dtos.Quotes.PendingQuoteDto) {6}] | null

optional

Gets or sets the pending quotes.

dateStamp

string <date-time>

optional

Gets or sets the date stamp.

pendingQuoteType

string | null

optional

Gets or sets the type of the pending quote.

carrierName

string | null

optional

Gets or sets the name of the carrier.

scac

string | null

optional

Gets or sets the scac.

service

string | null

optional

Gets or sets the service.

quoteId

integer <int32>

optional

Gets or sets the quote identifier.

notes

array[object (NoteDto) {4}] | null

optional

Gets or sets the notes.

description

string | null

optional

Note text

noteTypeId

integer <int32>

optional

Note Type Id

userName

string | null

optional

Note creator

dateStamp

string <date-time>

optional

Note date

Example

[
  {
    "shipmentId": 0,
    "ratingCompleted": true,
    "quotes": [
      {
        "quoteId": 0,
        "carrierName": "string",
        "carrierId": 0,
        "scac": "string",
        "thirdPartyName": "string",
        "thirdPartyScac": "string",
        "serviceId": "string",
        "rawPrice": {
          "netPrice": 0,
          "freightCharge": 0,
          "discountAmount": 0,
          "fuelSurcharge": 0,
          "minimum": 0,
          "grossCharge": 0,
          "tariff": 0,
          "interline": 0,
          "accessorialCharges": 0,
          "otherCharges": 0,
          "charges": [
            {
              "name": "string",
              "amount": 0,
              "code": "string"
            }
          ],
          "markup": 0
        },
        "carrierPrice": {
          "netPrice": 0,
          "freightCharge": 0,
          "discountAmount": 0,
          "fuelSurcharge": 0,
          "minimum": 0,
          "grossCharge": 0,
          "tariff": 0,
          "interline": 0,
          "accessorialCharges": 0,
          "otherCharges": 0,
          "charges": [
            {
              "name": "string",
              "amount": 0,
              "code": "string"
            }
          ],
          "markup": 0
        },
        "customerPrice": {
          "netPrice": 0,
          "freightCharge": 0,
          "discountAmount": 0,
          "fuelSurcharge": 0,
          "minimum": 0,
          "grossCharge": 0,
          "tariff": 0,
          "interline": 0,
          "accessorialCharges": 0,
          "otherCharges": 0,
          "charges": [
            {
              "name": "string",
              "amount": 0,
              "code": "string"
            }
          ],
          "markup": 0
        },
        "transitTime": 0,
        "quoteNumber": "string",
        "carrierPerson": "string",
        "carrierNote": "string",
        "dateStamp": "2019-08-24T14:15:22Z",
        "interline": true,
        "accepted": true,
        "currencyType": "USDollar",
        "service": "string",
        "insuranceDetails": {
          "price": 0,
          "confirmation": "string",
          "insuranceNote": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "deductible": "string",
          "termsAndConditions": "string",
          "vendorCode": "string"
        },
        "accountNumber": "string"
      }
    ],
    "failedQuotes": [
      {
        "carrierName": "string",
        "scac": "string",
        "service": "string",
        "reasonCode": 0,
        "reason": "string",
        "dateStamp": "2019-08-24T14:15:22Z"
      }
    ],
    "pendingQuotes": [
      {
        "dateStamp": "2019-08-24T14:15:22Z",
        "pendingQuoteType": "string",
        "carrierName": "string",
        "scac": "string",
        "service": "string",
        "quoteId": 0
      }
    ],
    "notes": [
      {
        "description": "string",
        "noteTypeId": 0,
        "userName": "string",
        "dateStamp": "2019-08-24T14:15:22Z"
      }
    ]
  }
]

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠429Too Many Requests

Retrieve the quotes of a single Shipment by its id.#

Request

Request samples

Responses

Retrieve the quotes of a single Shipment by its id.