Skip to main content
GET
Get quote status

Authorizations

X-API-Key
string
header
required

Your ProvenMetal API key (pm_live_...). Authorization: Bearer <key> also works.

Path Parameters

quote_id
string
required
Maximum string length: 80

Response

Successful Response

ok
boolean
required
quote_id
string
required
status
string
required

quote_ready, awaiting_payment, sourcing_ready, sourcing_requested, sourcing_quoted, expired, ordered, in_production or shipped.

message
string | null
order_ref
string | null

The order's ProvenMetal reference once paid.

tracking
Tracking · object | null

Once shipped: carrier and number.

checkout_url
string | null

Until it is paid.

total
string | null
total_cents
integer | null
quantity
integer | null
requested_substitutions
Requested Substitutions · object[] | null