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

    Interface GetAffiliatePerformanceList

    GetAffiliatePerformanceList sub-interface for GetAffiliatePerformanceResponseData

    interface GetAffiliatePerformanceList {
        affiliate_id?: number;
        affiliate_name?: string;
        affiliate_username?: string;
        clicks?: number;
        est_commission?: string;
        items_sold?: number;
        new_buyers?: number;
        orders?: number;
        roi?: string;
        sales?: string;
        total_buyers?: number;
    }
    Index

    Properties

    affiliate_id?: number

    Unique identifier assigned to the affiliate. Used as a reference key in the system.

    affiliate_name?: string

    Display name of the affiliate, typically the Shopee display name.

    affiliate_username?: string

    Login or Shopee account username associated with the affiliate.

    clicks?: number

    Total number of clicks on your product links through affiliate marketing during the selected period.

    est_commission?: string

    Estimated payout through the affiliate's promotion.

    items_sold?: number

    Total number of the product sold through the affiliate's promotion.

    new_buyers?: number

    Total number of new buyers who have purchased the product through the affiliate's promotion.

    orders?: number

    Total number of orders generated through the affiliate's promotion.

    roi?: string

    Return on Investment, equal to GMV divided by Estimated Commission. It can be used to evaluate the efficiency of the affiliate's promotion. If it does not exist, the return value is --.

    sales?: string

    Total value of the product sold through the affiliate's promotion.

    total_buyers?: number

    Total number of buyers who have purchased the product through the affiliate's promotion.