Shopee SDK API Reference - v2.8.0
    Preparing search index...

    Interface GetPunishmentHistoryRequest

    Request parameters for get_punishment_history

    Get the punishment records generated in the current quarter.

    interface GetPunishmentHistoryRequest {
        page_no?: number;
        page_size?: number;
        punishment_status: number;
    }
    Index

    Properties

    page_no?: number

    Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call. Default is 1.

    page_size?: number

    Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100. Default is 10.

    punishment_status: number

    The status of punishment. Applicable values: 1: Ongoing2: Ended