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

    Interface AddFollowPrizeParams

    Parameters for adding a new follow prize

    interface AddFollowPrizeParams {
        discount_amount?: number;
        end_time: number;
        follow_prize_name: string;
        max_price?: number;
        min_spend: number;
        percentage?: number;
        reward_type: FollowPrizeRewardType;
        start_time: number;
        usage_quantity: number;
    }
    Index

    Properties

    discount_amount?: number

    The discount amount. Required when reward_type is 1 (fix amount)

    end_time: number

    The timing until when the follow prize is still valid (unix timestamp). Must be at least 1 day after start_time

    follow_prize_name: string

    The name of the follow prize, max length is 20 characters

    max_price?: number

    The max amount of discount/value. Required when reward_type is 2 or 3

    min_spend: number

    The minimum spend required for using this follow prize

    percentage?: number

    The discount percentage. Required when reward_type is 2 (percentage) or 3 (coin cash back)

    The reward type of the follow prize (1: discount fix amount, 2: discount by percentage, 3: coin cash back)

    start_time: number

    The timing from when the follow prize is valid (unix timestamp)

    usage_quantity: number

    The usage quantity of the follow prize (1-200000)