Shopee SDK API Reference - v1.11.0
    Preparing search index...

    Interface UpdateVoucherParams

    Parameters for updating a voucher

    interface UpdateVoucherParams {
        discount_amount?: number;
        display_channel_list?: number[];
        display_start_time?: number;
        end_time?: number;
        item_id_list?: number[];
        max_price?: number;
        min_basket_price?: number;
        percentage?: number;
        start_time?: number;
        usage_quantity?: number;
        voucher_id: number;
        voucher_name?: string;
    }
    Index

    Properties

    discount_amount? display_channel_list? display_start_time? end_time? item_id_list? max_price? min_basket_price? percentage? start_time? usage_quantity? voucher_id voucher_name?

    Properties

    discount_amount?: number

    The discount amount set for this particular voucher. Only for fix amount voucher

    display_channel_list?: number[]

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

    display_start_time?: number

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

    end_time?: number

    The timing until when the voucher is still valid. For ongoing vouchers, can only be shortened, not extended

    item_id_list?: number[]

    The list of items which is applicable for the voucher. Only for product type voucher

    max_price?: number

    The max amount of discount/value a user can enjoy by using this particular voucher. Only for discount percentage or coins cashback voucher

    min_basket_price?: number

    The minimum spend required for using this voucher

    percentage?: number

    The discount percentage set for this particular voucher. Only for discount percentage or coins cashback voucher

    start_time?: number

    The timing from when the voucher is valid; so buyer is allowed to claim and to use. Can only be updated if voucher has not started

    usage_quantity?: number

    The number of times for this particular voucher could be used. For ongoing vouchers, can only be increased

    voucher_id: number

    The unique identifier of the voucher which is going to be updated

    voucher_name?: string

    The name of the voucher

    Settings

    Member Visibility

    On This Page

    Properties