Interface OrderCustomFieldChangedMessagePayload

Generated when an existing Custom Field has been changed using the Set CustomField action.

interface OrderCustomFieldChangedMessagePayload {
    name: string;
    previousValue?: any;
    type: "OrderCustomFieldChanged";
    value: any;
}

Hierarchy (View Summary)

IOrderMessagePayload
- OrderCustomFieldChangedMessagePayload

Index

Properties

name previousValue? type value

Properties

`Readonly`name

name: string

Name of the Custom Field that changed.

`Optional` `Readonly`previousValue

previousValue?: any

CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Order before, an Order Custom Field Added Message is generated instead.

`Readonly`type

type: "OrderCustomFieldChanged"

`Readonly`value

value: any

CustomFieldValue based on the FieldType after the Set CustomField update action.