Shopee SDK API Reference - v1.11.0
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    config: ShopeeConfig

    Methods

    • Confirm that lost push messages have been consumed up to a specific message ID

      Parameters

      • params: ConfirmConsumedLostPushMessageParams

        Parameters for confirming consumed lost push messages

        Parameters for confirming consumed lost push messages

        • last_message_id: number

          The last_message_id returned by getLostPushMessage

      Returns Promise<ConfirmConsumedLostPushMessageResponse>

      Response indicating the confirmation result

      This API confirms that all lost push messages up to and including the specified last_message_id have been successfully consumed/processed by your application. After confirmation, these messages will no longer be returned by the getLostPushMessage API.

      Use this method after you have successfully processed the messages returned by getLostPushMessage.

    • Get the lost push messages that were lost within 3 days of the current time and not confirmed to have been consumed

      Returns Promise<GetLostPushMessageResponse>

      Response containing up to 100 lost push messages

      This API retrieves the earliest 100 lost push messages from the past 3 days that haven't been confirmed as consumed. If there are more than 100 messages, the response will indicate this via the has_next_page field, and you'll need to make additional calls to retrieve the remaining messages.

      The returned messages contain:

      • shop_id: The shop identifier (absent for partner level pushes)
      • code: The push notification identifier
      • timestamp: When the message was lost
      • data: The actual push message content (as a JSON string)