Skip to main content

Interface: OrderSetStatusInput

Defined in: type/OrderSetStatusInput.ts:4

Input object for OrderSetStatusInput

Properties​

addPDFAttachment?​

optional addPDFAttachment?: boolean

Defined in: type/OrderSetStatusInput.ts:14

Add the order overview as attached PDF to the order confirmation email


deleteCart?​

optional deleteCart?: boolean

Defined in: type/OrderSetStatusInput.ts:18

Delete the cart that created this order if the cart is still available


orderId​

orderId: number

Defined in: type/OrderSetStatusInput.ts:6

The id of the order to set the status for


payStatus?​

optional payStatus?: string

Defined in: type/OrderSetStatusInput.ts:10

The payment status of the order


sendOrderConfirmationEmail?​

optional sendOrderConfirmationEmail?: boolean

Defined in: type/OrderSetStatusInput.ts:12

Send the order confirmation email when the status is changed


status?​

optional status?: string

Defined in: type/OrderSetStatusInput.ts:8

The status of the order


triggerOrderSendConfirmEvent?​

optional triggerOrderSendConfirmEvent?: boolean

Defined in: type/OrderSetStatusInput.ts:16

Triggers the ORDER_SEND_CONFIRMATION event when the status is changed, which can be subscribed to via the Event Action Manager