Skip to main content

Interface: PlaceOrderOptions

Defined in: composables/react/useCheckout.ts:54

Arguments for UseCheckoutReturn.placeOrder.

Properties​

cartId​

cartId: string

Defined in: composables/react/useCheckout.ts:56

Id of the cart to convert.

finalizeOrder?​

optional finalizeOrder?: boolean

Defined in: composables/react/useCheckout.ts:82

Whether this placement finalizes the order — i.e. sends the order confirmation email, fires the confirm event, attaches the order PDF, and clears the cart. Defaults to true for a normal order and false for a quote.

Set this to false for an order that still awaits an external payment (e.g. 'UNFINISHED' orders handed off to a PSP). The confirmation/cart deletion should then happen when the payment is confirmed (the PSP webhook), not at placement — otherwise the shopper is emailed and the cart cleared before they've paid.

isQuoteMode?​

optional isQuoteMode?: boolean

Defined in: composables/react/useCheckout.ts:69

When true, treats this as a quote: suppresses confirmation email/PDF and triggers a quote-send request.

notes?​

optional notes?: string

Defined in: composables/react/useCheckout.ts:67

Free-text order notes.

orderStatus​

orderStatus: string & object | "NEW" | "REQUEST" | "UNFINISHED"

Defined in: composables/react/useCheckout.ts:63

Order status to set. 'NEW' for a completed order, 'REQUEST' for a quote request, 'UNFINISHED' for an order awaiting an external payment (PSP) — the payment webhook promotes it to its final status later. Any other backend status string is also accepted.

reference?​

optional reference?: string

Defined in: composables/react/useCheckout.ts:65

Customer reference printed on the order.