Skip to main content
Fetch a quote request

Path Parameters

id
string
required

Preview: Customer-facing id of the quote request.

Response

Preview: The quote request.

Preview: Quote request visible to the customer.

id
string

Preview: Customer-facing REST reference of the quote request, using the same historical or full form as the shipment resource.

name
string

Preview: Customer dossier name.

status
enum<string>

Preview: Quote-request lifecycle status, with one public value for each platform status. draft: the request is being prepared. Leaving draft or cancelling the request changes this value. awaiting_quote: the request has no customer-visible quote yet. A sent quote, acceptance or cancellation changes this value. quote_sent: at least one customer-visible quote was sent. Acceptance or cancellation changes this value; for a request that remains open, further quotes keep it, while all visible quotes being declined or expiring can change it. accepted: a quote was accepted or the request became a shipment. Cancelling that shipment changes this value to cancelled. declined: every customer-visible quote was declined. A newly sent customer-visible quote changes this value to quote_sent, and cancellation changes it to cancelled. expired: every customer-visible quote expired. A newly sent customer-visible quote changes this value to quote_sent, and cancellation changes it to cancelled. cancelled: the request was cancelled. Clearing its cancellation lets the platform recalculate the request or shipment status. Further values may be added. Clients should handle an unknown value as an unrecognized status.

Available options:
accepted,
awaiting_quote,
cancelled,
declined,
draft,
expired,
quote_sent
service
enum<string> | null

Preview: Service requested for the quote.

Available options:
chartering,
courier
freight_mode
enum<string>

Preview: Freight mode requested for the quote.

Available options:
air,
ocean,
rail,
truck
load_type
enum<string>

Preview: Load type requested for the quote.

Available options:
fcl,
lcl
incoterm
enum<string>

Preview: Incoterm requested for the quote.

Available options:
exw,
fca,
fas,
fob,
cpt,
cfr,
cif,
cip,
dap,
ddp,
dpu,
dat
cargo_ready_date
string<date>

Preview: Date when the cargo is ready for collection.

desired_delivery_date
string<date> | null

Preview: Desired delivery date.

route
object

Preview: Route requested for the quote.

cargo
object

Preview: Cargo requested for the quote.

goods_description
string

Preview: Description of the goods being transported.

specific_instructions
string

Preview: Instructions for the transport.

commercial_value
object
insurance_type
enum<string>

Preview: Insurance selected for the quote.

Available options:
not_insured,
ad_valorem_ordinary_risk,
ad_valorem_war_risk
urgent
boolean

Preview: Whether the request is urgent.