Skip to content
HeyX API

Confirm Quote

Required scope: quote:confirm

Confirmation is the only public API path that creates a commercial order. There is no CreateOrder endpoint. The quote is confirmed and its order is created atomically; the response contains both records. The quote and order retain the same frozen pricing country and derived currency.

Pass the quote’s current version as expectedVersion. This optimistic concurrency check prevents confirmation from silently using a stale quote.

Generated Reference
POST /public-api/publicapi.v1.Quote/ConfirmQuote

Confirms a concept quote and atomically creates its commercial order. Repeating the operation for an already-confirmed quote returns its order.

Request ConfirmQuoteRequest
Response ConfirmQuoteResponse

ConfirmQuoteRequest

Field Type
id string
expected_version int32

ConfirmQuoteResponse

Field Type
quote Quote
order Order

Related Types

Quote

Field Type
id string
portfolio_id string
status QuoteStatus
currency string
version int32
reference_number string
items repeated QuoteItem
discounts repeated QuoteDiscount
created_at int64
updated_at int64
finalized_at int64
finalized_order_id optional string
pricing_country string

Order

Field Type
id string
portfolio_id string
quote_id optional string
status OrderStatus
reference_number string
version int32
items repeated OrderItem
finalized_at int64
created_at int64
updated_at int64
cancelled_at int64
cancel_reason string
pricing_country string
currency string

QuoteItem

Field Type
id string
product_id string
quantity int32
price_type PriceType
position int32
unit_price_cents optional int32
folder_id optional string

QuoteDiscount

Field Type
id string
discount_id string

OrderItem

Field Type
product_id string
quantity int32
line_id string
display_name string
price_once optional int32
price_monthly optional int32
price_yearly optional int32
currency string

Request

Section titled “Request”
{
  "id": "<quote-id>",
  "expectedVersion": 3
}

Response

Section titled “Response”
{
  "quote": {
    "id": "<quote-id>",
    "status": "PUBLIC_QUOTE_STATUS_CONFIRMED",
    "pricingCountry": "US",
    "currency": "USD",
    "version": 4,
    "finalizedOrderId": "<order-id>"
  },
  "order": {
    "id": "<order-id>",
    "quoteId": "<quote-id>",
    "status": "PUBLIC_ORDER_STATUS_CREATED",
    "pricingCountry": "US",
    "currency": "USD",
    "referenceNumber": "O-000123"
  }
}

Repeating confirmation after it succeeds returns the already-created order and does not create a duplicate. expectedVersion is enforced while the quote is still a concept.

HeyX API