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

    Interface UpdateVoucherRequest

    Request parameters for update_voucher

    Update voucher

    interface UpdateVoucherRequest {
        discount_amount?: number;
        display_channel_list?: number[];
        display_start_time?: number;
        end_time?: number | Date;
        item_id_list?: number[];
        max_price?: number;
        min_basket_price?: number;
        percentage?: number;
        start_time?: number | Date;
        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 fill in when you are updating a fix amount voucher.

    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

    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.

    item_id_list?: number[]

    The list of items which is applicable for the voucher. Only fill in when you are updating a product type of voucher.

    max_price?: number

    The max amount of discount/value a user can enjoy by using this particular voucher. Only fill in when you are updating a discount percentage voucher 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 fill in when you are updating a discount percentage voucher or coins cashback voucher.

    start_time?: number | Date

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

    usage_quantity?: number

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

    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