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

    Interface GetFollowPrizeDetailResponseData

    GetFollowPrizeDetailResponseData sub-interface for GetFollowPrizeDetailResponse

    interface GetFollowPrizeDetailResponseData {
        campaign_id?: number;
        campaign_status?: string | number;
        discount_amount?: number;
        end_time?: number | Date;
        follow_prize_name?: string;
        max_price?: number;
        min_spend?: number;
        percentage?: number;
        reward_type?: number;
        start_time?: number | Date;
        usage_quantity?: number;
    }
    Index

    Properties

    campaign_id? campaign_status? discount_amount? end_time? follow_prize_name? max_price? min_spend? percentage? reward_type? start_time? usage_quantity?

    Properties

    campaign_id?: number

    The unique identifier for the created follow prize.

    campaign_status?: string | number

    The status of follow prize,the campagin status have upcoming/ongoing/expired.

    discount_amount?: number

    The discount amount set for this particular follow prize.Only fill in when you are creating a fix amount follow prize.

    end_time?: number | Date

    The timing until when the follow prize is still valid,the end time must be greater than the start time by at least 1 day and end time cannot exceed 3 months after start time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."

    follow_prize_name?: string

    The name of the follow prize,The follow prize name length max limit is 20.

    max_price?: number

    The max amount of discount/value a user can enjoy by using this particular follow prize. Only fill in when you are creating a discount percentage follow prize or coins cashback follow prize.

    min_spend?: number

    The minimum spend required for using this follow prize.

    percentage?: number

    The discount percentage set for this particular follow prize. Only fill in when you are creating a discount percentage follow prize or coins cashback follow prize.Discount percentage (reward_type ==2) or Percentage of coins cash back (reward_type==3).

    reward_type?: number

    The reward type of the follow prize.The available values are:1:discount---fix amount,2:discount---by percentage,3:coin cash back.

    start_time?: number | Date

    The timing from when the follow prize is valid,the start time later than the current time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."

    usage_quantity?: number

    Please enter a value between 1 and 200000.

    Settings

    Member Visibility

    On This Page

    Properties