Get information about an RFQ

SecurityAuthToken
Request
path Parameters
rfqId
required
string <uuid>

The id of the rfq

query Parameters
include_failures
boolean

If true, include failed Quotes in the result set

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 an RFQ

Response Schema: application/json
autoquote
required
boolean

Whether or not this RFQ should perform an autoquoting process

company_owner_id
string or null <uuid>
created_at
string or null <date-time>
object (User)
did_finish_autoquote
boolean

Whether or not this RFQ completed an autoquoting process

Array of objects (EquipmentType)
has_parent_rfq
boolean
id
string or null <uuid>
Array of objects (SlimCompany)

Array of Companies that, if provided, the autoquoting process will restrict its quote results to only rates that come from those vendor companies. For each carrier/company, the id and name is required.

shipment
required
string <uuid>

Id of the Shipment for which this RFQ was created

Array of objects (ShipmentMode)
Array of objects <uuid>

All SpotNegotiation ids of the RFQ

updated_at
string or null <date-time>
object (FedexShipmentOptions)

Shipment rating and dispatch options specific to FedEx

object (SlimRFQ)
Array of objects (Quote)

All Quotes extended to this RFQ

object (UPSShipmentOptions)

Shipment rating and dispatch options specific to UPS

object (USPSShipmentOptions)

Shipment rating and dispatch options specific to USPS

default

Default error response

get/quoting/rfqs/{rfqId}/
Request samples 
Response samples 
application/json
{
  • "autoquote": true,
  • "company_owner_id": "1003e640-8bcc-41af-b855-ef79a4ec4475",
  • "created_at": "2019-08-24T14:15:22Z",
  • "creator": {
    },
  • "did_finish_autoquote": true,
  • "equipment_types": [
    ],
  • "has_parent_rfq": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "restrict_autoquote_to_companies": [
    ],
  • "shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
  • "shipment_modes": [
    ],
  • "spot_negotiations": [
    ],
  • "updated_at": "2019-08-24T14:15:22Z",
  • "fedex_specific_options": {
    },
  • "parent_rfq": {
    },
  • "quotes": [
    ],
  • "ups_specific_options": {
    },
  • "usps_specific_options": {
    }
}
Copyright © Shipwell 2024. All right reserved.