Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    Interface NotificationsApiGetSubscriptionsRequest

    Request parameters for getSubscriptions operation in NotificationsApi.

    interface NotificationsApiGetSubscriptionsRequest {
        nextToken?: string;
        notificationTypes: string[];
        pageSize?: number;
        payloadVersion?: string;
    }
    Index
    nextToken? notificationTypes pageSize? payloadVersion?
    nextToken?: string

    A token to retrieve the next page of results. If this field is not empty in a response, pass its value in the next request to retrieve the next page.

    notificationTypes: string[]

    A list of notification types to retrieve subscriptions for. Currently limited to a single notification type per request. For more information about notification types, refer to the Notifications API v1 Use Case Guide.

    pageSize?: number

    The maximum number of subscriptions to return per page. Minimum value is 30. Maximum value is 100. Default is 30.

    payloadVersion?: string

    The version of the payload object to be used in the notification.

    Settings
    Member Visibility

    On This Page
    Properties