Skip to main content
POST
Record a manually-booked freight quote

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_ Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

Body

application/json
carrier_name
string
required
Maximum string length: 100
Example:

"Estes Express"

amount
number<float>
required
Required range: x >= 0
Example:

642.5

carrier_service
string | null
Maximum string length: 60
Example:

"Standard LTL"

quote_number
string | null
Maximum string length: 80
Example:

"EST-2026-77821"

transit_days
integer | null
Required range: x >= 0
Example:

4

currency
string
default:USD
Example:

"USD"

expires_at
string<date-time> | null
Example:

"2026-05-25T17:00:00Z"

notes
string | null
raw_response
object | null

Optional raw carrier payload for the audit trail.

Response

Freight quote created

data
object

A carrier rate-quote attached to a freight order. Created either manually (operator booked a carrier outside Shippo) via POST /freight_orders/{id}/quotes, or in bulk by pulling Shippo LTL rates via POST /freight_orders/{id}/quotes/shippo. Exactly one quote per order may carry a non-null accepted_at; accepting a quote rolls its amount into orders.shipping_total. Rule 23 SSOT: amount is written only by createFreightQuoteHandler and the Shippo rate-import; accepted_at is written only by acceptFreightQuoteHandler. Scope: orders:read / orders:write.