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

    Interface GetVoucherListRequest

    Request parameters for get_voucher_list

    Get Voucher List

    interface GetVoucherListRequest {
        page_no?: number;
        page_size?: number;
        status: string | number;
    }
    Index

    Properties

    page_no?: number

    Specifies the page number of data to return in the current call. Default to be 1 and allowed input is from 1 - 5000.

    page_size?: number

    Use the 'page_size' filters to control the maximum number of entries to retrieve per page (i.e., per call). Default to be 20 and allowed input is from 1- 100.

    status: string | number

    The status filter for retrieving voucher list. Available value: upcoming/ongoing/expired/all.