Interface SetCustomFieldChange

Change triggered by the following update actions:

- [Set CustomField](ctp:api:type:CartDiscountSetCustomFieldAction) on Cart Discounts.
- [Set CustomField](ctp:api:type:CategorySetCustomFieldAction) on Categories.
- [Set CustomField](ctp:api:type:ChannelSetCustomFieldAction) on Channels.
- [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) on Customers.
- [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) on Customer Groups.
- [Set CustomField](ctp:api:type:DiscountCodeSetCustomFieldAction) on Discount Codes.
- [Set CustomField](ctp:api:type:InventoryEntrySetCustomFieldAction) on Inventories.
- [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) on Orders.
- [Set CustomField](ctp:api:type:OrderEditSetCustomFieldAction) on Order Edits.
- [Set CustomField](ctp:api:type:PaymentSetCustomFieldAction) on Payments.
- [Set CustomField](ctp:api:type:ProductSelectionSetCustomFieldAction) on Product Selections.
- [Set CustomField](ctp:api:type:QuoteSetCustomFieldAction) on Quotes.
- [Set CustomField](ctp:api:type:QuoteRequestSetCustomFieldAction) on Quote Requests.
- [Set CustomField](ctp:api:type:ReviewSetCustomFieldAction) on Reviews.
- [Set CustomField](ctp:api:type:ShoppingListSetCustomFieldAction) on Shopping Lists.
- [Set CustomField](ctp:api:type:StagedOrderSetCustomFieldAction) on Staged Orders.
- [Set CustomField](ctp:api:type:StagedQuoteSetCustomFieldAction) on Staged Quotes.
- [Set CustomField](ctp:api:type:StoreSetCustomFieldAction) on Stores.
interface SetCustomFieldChange {
    change: string;
    customTypeId: string;
    name: string;
    nextValue: any;
    previousValue: any;
    type: "SetCustomFieldChange";
}

Properties

change customTypeId name nextValue previousValue type

Properties

Readonly change

change: string

Readonly customTypeId

customTypeId: string

id of the referenced Type.

Readonly name

name: string

Name of the Custom Field.

Readonly nextValue

nextValue: any

Value after the change.

Readonly previousValue

previousValue: any

Value before the change.

Readonly type

type: "SetCustomFieldChange"

Settings

Member Visibility

Theme

On This Page

changecustomTypeIdnamenextValuepreviousValuetype