Skip to main content

Interface: PlaceOrderOptions

Defined in: composables/vue/useCheckout.ts:55

Properties​

finalizeOrder?​

optional finalizeOrder?: boolean

Defined in: composables/vue/useCheckout.ts:77

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.

Set this to false for an order awaiting 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/vue/useCheckout.ts:56

notes?​

optional notes?: string

Defined in: composables/vue/useCheckout.ts:58

orderStatus?​

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

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

Order status to set. When omitted it defaults to 'REQUEST' in quote mode and 'NEW' otherwise. Pass 'UNFINISHED' for an order awaiting an external payment (PSP) whose final status the payment webhook sets later. Any backend status string is accepted.

reference?​

optional reference?: string

Defined in: composables/vue/useCheckout.ts:57