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

    Interface GetDiscountListRequest

    Request parameters for get_discount_list

    Use this api to get shop discount activity list

    interface GetDiscountListRequest {
        discount_status: string | number;
        page_no: number;
        page_size: number;
        update_time_from?: number | Date;
        update_time_to?: number | Date;
    }
    Index

    Properties

    discount_status: string | number

    The status filter for retriveing discount list. Available value: upcoming/ongoing/expired/all.

    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.

    page_size: number

    If many items are available to retrieve, you may need to call GetDiscountsList multiple times to retrieve all the data. Each result set is returned as a page of entries. Use the Pagination filters to control the maximum number of entries (<= 100) to retrieve per page (i.e., per call), the offset number to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.

    update_time_from?: number | Date

    The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the discount update time). The maximum date range that may be specified with the update_time_from and update_time_to fields is 30 days.

    update_time_to?: number | Date

    The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the discount update time). The maximum date range that may be specified with the update_time_from and update_time_to fields is 30 days.