Interface OrderSetParcelCustomFieldAction

interface OrderSetParcelCustomFieldAction {
    action: "setParcelCustomField";
    name: string;
    parcelId?: string;
    parcelKey?: string;
    value?: any;
}

Properties

action name parcelId? parcelKey? value?

Properties

Readonly action

action: "setParcelCustomField"

Readonly name

name: string

Name of the Custom Field.

Optional Readonly parcelId

parcelId?: string

id of an existing Parcel.

Either `parcelId` or `parcelKey` must be provided.

Optional Readonly parcelKey

parcelKey?: string

key of an existing Parcel.

Either `parcelId` or `parcelKey` must be provided.

Optional Readonly value

value?: any

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Settings

Member Visibility

Theme

On This Page

actionnameparcelIdparcelKeyvalue