Get information about a quote

SecurityAuthToken
Request
path Parameters
rfqId
required
string <uuid>

The id of the rfq

quoteId
required
string <uuid>

The id of the quote

header Parameters
X-Company-Id
string

allows request to retrieve information about the company given in the header instead of the company associated with the requesting user

Responses
200

Successfully returned a Quote

Response Schema: application/json
accepted_at
string or null <date-time>
approved_by_rfq_at
string or null <date-time>

Not implemented

can_dispatch
boolean
object (Carrier)
carrier_code
string or null

SCAC Code Returned from p44

object (CEVAInstantRateQuote)
Array of objects (QuoteChargeLineItem)
created_at
string or null <date-time>
object (SlimCompany)
created_by_user
string or null <uuid>
currency
string or null
Default: "USD"

Read-only currency code describing the currency of line items on the quote

Enum: "CAD" "USD"
customer_markup
number or null <float>

Markup charge to the end customer, obfuscated so only authorized users can read/write its true value

delivery_date
string or null

Planned delivery date of the shipment, in string of the form YYYY-MM-DD

display_earliest_pickup
string or null

Human-readable date/time of earliest pickup, if one exists

earliest_pickup_date
string or null

Earliest date the shipment could be run, in string of the form YYYY-MM-DD

earliest_pickup_time
string or null <time>

Earliest time the shipment could be run

object (EquipmentType)

Equipment type

error_message
string or null

Error that happened during quoting

expires_at
string or null <date-time>
object (FedexDirectQuote)
id
string or null <uuid>
info_message
string or null

Description of caveats about the quote

is_csp_rate
boolean

True iff Quote originated from a rate that a Brokerage negotiated on behalf of one of their FreightAuthorities

is_failure
boolean

if true, this Quote does not represent an actual price but instead a failure to provide a Quote to an RFQ

lane_type
string or null
Default: "UNSPECIFIED"
Enum: "DIRECT" "INTERLINE" "UNSPECIFIED"
object (ShipmentMode)

Standardized code for a shipment mode

provider_logo_url
string or null

URL for the logo of the quote provider

Array of objects (Accessorial)
reference_number
string or null
revoked_at
string or null <date-time>

Not implemented

rfq
string or null <uuid>

Id of the RFQ to which this quote is related

object (ServiceLevel)

Standardized code for a shipment service level

source_type
string or null
Enum: "INSTANT" "MANUAL" "PRIVATE_MARKETPLACE"
object (SpotNegotiationQuoteInfo)
total
number or null <float>

Sum of all the charge line items of this quote

transit_days
integer or null <int32>
updated_at
string or null <date-time>
object (UPSDirectQuote)
object (USPSDirectQuote)
default

Default error response

get/quoting/rfqs/{rfqId}/quotes/{quoteId}/
Request samples
Response samples
application/json
{
  • "accepted_at": "2019-08-24T14:15:22Z",
  • "approved_by_rfq_at": "2019-08-24T14:15:22Z",
  • "can_dispatch": true,
  • "carrier": {
    },
  • "carrier_code": "string",
  • "ceva_instant_rate_quote": {
    },
  • "charge_line_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by_company": {
    },
  • "created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59",
  • "currency": "CAD",
  • "customer_markup": 0.1,
  • "delivery_date": "string",
  • "display_earliest_pickup": "string",
  • "earliest_pickup_date": "string",
  • "earliest_pickup_time": "14:15:22Z",
  • "equipment_type": {
    },
  • "error_message": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "fedex_direct_quote": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "info_message": "string",
  • "is_csp_rate": true,
  • "is_failure": true,
  • "lane_type": "DIRECT",
  • "mode": {
    },
  • "provider_logo_url": "string",
  • "quoted_non_dispatchable_accessorials": [
    ],
  • "reference_number": "string",
  • "revoked_at": "2019-08-24T14:15:22Z",
  • "rfq": "86078267-4e83-4409-a4a8-060d182cafeb",
  • "service_level": {
    },
  • "source_type": "INSTANT",
  • "spot_negotiation_quote": {
    },
  • "total": 0.1,
  • "transit_days": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "ups_direct_quote": {
    },
  • "usps_direct_quote": {
    }
}
Copyright © Shipwell 2024. All right reserved.