Interface NotificationsApiModelEventFilter

A notificationType specific filter. This object contains all of the currently available filters and properties that you can use to define a notificationType specific filter.

Export

EventFilter

interface NotificationsApiModelEventFilter {
    aggregationSettings?: NotificationsApiModelAggregationSettings;
    eventFilterType:
        | NotificationsApiModelEventFilterEventFilterTypeEnum
        | "ANY_OFFER_CHANGED"
        | "ORDER_CHANGE";
    marketplaceIds?: string[];
    orderChangeTypes?: (
        | NotificationsApiModelOrderChangeTypeEnum
        | "OrderStatusChange"
        | "BuyerRequestedChange"
    )[];
}

Properties

aggregationSettings? eventFilterType marketplaceIds? orderChangeTypes?

Properties

OptionalaggregationSettings

aggregationSettings?: NotificationsApiModelAggregationSettings

Memberof

EventFilter

eventFilterType

eventFilterType:
    | NotificationsApiModelEventFilterEventFilterTypeEnum
    | "ANY_OFFER_CHANGED"
    | "ORDER_CHANGE"

An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter. Refer to Notification Type Values to determine if an eventFilterType is supported.

Memberof

EventFilter

OptionalmarketplaceIds

marketplaceIds?: string[]

A list of marketplace identifiers to subscribe to (for example: ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list.

Memberof

EventFilter

OptionalorderChangeTypes

orderChangeTypes?: (
    | NotificationsApiModelOrderChangeTypeEnum
    | "OrderStatusChange"
    | "BuyerRequestedChange"
)[]

A list of order change types to subscribe to (for example: BuyerRequestedChange). To receive notifications of all change types, do not provide this list.

Memberof

EventFilter

Settings

Member Visibility

On This Page

Properties