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

    Interface GetVoucherResponseData

    GetVoucherResponseData sub-interface for GetVoucherResponse

    interface GetVoucherResponseData {
        cmt_voucher_status?: number;
        current_usage?: number;
        discount_amount?: number;
        display_channel_list?: number[];
        display_start_time?: number | Date;
        end_time?: number | Date;
        is_admin?: boolean;
        item_id_list?: number[];
        max_price?: number;
        min_basket_price?: number;
        percentage?: number;
        reward_type?: number;
        start_time?: number | Date;
        target_voucher?: number;
        usage_quantity?: number;
        usecase?: number;
        voucher_code?: string;
        voucher_id?: number;
        voucher_name?: string;
        voucher_purpose?: number;
        voucher_type?: number;
    }
    Index

    Properties

    cmt_voucher_status? current_usage? discount_amount? display_channel_list? display_start_time? end_time? is_admin? item_id_list? max_price? min_basket_price? percentage? reward_type? start_time? target_voucher? usage_quantity? usecase? voucher_code? voucher_id? voucher_name? voucher_purpose? voucher_type?

    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_channel_list?: number[]

    The FE channel where the voucher will be displayed. The available values are: 1: display_all, 2: order page, 3: feed, 4: live streaming, [] (empty - which is hidden).

    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.

    item_id_list?: number[]

    The list of items which is applicable for the voucher. Only return a value when it is a product type of voucher.

    max_price?: number

    The max amount of discount/value a user can enjoy by using this particular voucher. Only when it is a discount percentage voucher or coins cashback voucher, api will return a value.

    min_basket_price?: number

    The minimum spend required for using this voucher.

    percentage?: number

    The discount percentage is 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.

    target_voucher?: number

    The field is used to mark new user voucher/ repeat buyer voucher 1: new user voucher 2: repeat buyer voucher: with 1 orders3. repeat buyer voucher: with 2 orders

    usage_quantity?: number

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

    usecase?: number

    usecase indicates a specific business scenario that the voucher is created and used for, i.e., new buyer voucher, live voucher, follow shop voucher, etc.shop voucher:1product voucher:2new buyer voucher:3repeat buyer voucher:4private voucher:5live voucher:6video voucher:7campaign voucher:8follow prize voucher:9membership voucher:10game prize voucher:11sample voucher:12

    voucher_code?: string

    Voucher Code

    voucher_id?: number

    The unique identifier of the voucher whose details are returned.

    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，7: Ads

    voucher_type?: number

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

    Settings

    Member Visibility

    On This Page

    Properties