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

    Interface GetVoucherListVoucher

    GetVoucherListVoucher sub-interface for GetVoucherListResponseData

    interface GetVoucherListVoucher {
        cmt_voucher_status?: number;
        current_usage?: number;
        discount_amount?: number;
        display_start_time?: number | Date;
        end_time?: number | Date;
        is_admin?: boolean;
        percentage?: number;
        reward_type?: number;
        start_time?: number | Date;
        usage_quantity?: number;
        voucher_code?: string;
        voucher_id?: number;
        voucher_name?: string;
        voucher_purpose?: number;
        voucher_type?: number;
    }
    Index

    Properties

    cmt_voucher_status?: number

    The voucher status in CMT. The available values are: 1:review, 2: approved, 3:reject. Only when this voucher is attending CMT campaign and not being rejected, api will return a value.

    current_usage?: number

    Up till now, how many times has this particular voucher already been used.

    discount_amount?: number

    The discount amount set for this particular voucher. Only when it is a fix amount voucher, api will return a value.

    display_start_time?: number | Date

    The timing of when voucher is displayed on shop pages; so buyer is allowed to claim.

    end_time?: number | Date

    The timing until when the voucher is still valid. Any time after this end_time, buyer is not allowed to claim or to use.

    is_admin?: boolean

    If the voucher is created by Shopee or not.

    percentage?: number

    The discount percentage set for this particular voucher. Only when it is a discount percentage voucher or coins cashback voucher, api will return a value.

    reward_type?: number

    The reward type of the voucher. The available values are: 1: fix_amount voucher, 2: discount_percentage voucher, 3: coin_cashback voucher.

    start_time?: number | Date

    The timing from when the voucher is valid; so buyer is allowed to claim and to use.

    usage_quantity?: number

    The number of times for this particular voucher could be used.

    voucher_code?: string

    Voucher Code

    voucher_id?: number

    The unique identifier for a voucher.

    voucher_name?: string

    Voucher Name

    voucher_purpose?: number

    The use case for the voucher. The available values are: 0: normal; 1: welcome, 2: referral; 3: shop_follow; 4:shop_game, 5: free_gift, 6: membership

    voucher_type?: number

    The type of the voucher. The available values are: 1: shop voucher, 2: product voucher.