Class DonationAlertsMerchandiseApi

API for managing DonationAlerts' merchandise sales and items.

The DonationAlertsMerchandiseApi provides methods to create, update, and manage merchandise items, as well as to notify DonationAlerts of new sales. Merchants can use this API to integrate sales systems with DonationAlerts' platform, enabling streamers to sell merchandise with flexible revenue sharing. Access is granted upon request. For details, refer to the official documentation.

Hierarchy

  • BaseApi
    • DonationAlertsMerchandiseApi

Methods

  • Updates an existing merchandise item.

    Parameters

    • user: UserIdResolvable

      The ID of the authorized user.

    • clientSecret: string

      The application client secret associated with the authorized application.

    • merchandiseId: string | number

      The ID of the merchandise to update.

    • data: Partial

      The modified data for the merchandise item.

    • OptionalrateLimiterOptions: RateLimiterRequestOptions

      Optional rate limiter settings.

    Returns Promise<DonationAlertsMerchandise>

    An updated instance of DonationAlertsMerchandise.

    HttpError if the response status code is not in the 200-299 range.

    UnregisteredUserError if the user is not registered in the authentication provider.