Interface UpdateOrderOptions

Options for updating an order status

interface UpdateOrderOptions {
    msgId: string | MsgKey;
    offset?: number;
    orderNote?: string;
    orderStatus: OrderStatus;
    paymentMethod?: string;
    paymentStatus?: PaymentStatus;
    referenceId?: string;
}

Index

Properties

msgId offset? orderNote? orderStatus paymentMethod? paymentStatus? referenceId?

Properties

msgId

msgId: string | MsgKey

The message ID or message key of the order message

`Optional`offset

offset?: number

The decimal offset for amount values (default: 2 for cents)

`Optional`orderNote

orderNote?: string

Optional note to include with the status update

orderStatus

orderStatus: OrderStatus

The new order status

`Optional`paymentMethod

paymentMethod?: string

Optional payment method

`Optional`paymentStatus

paymentStatus?: PaymentStatus

Optional payment status update

`Optional`referenceId

referenceId?: string

Reference ID for the order