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

    Interface GetPrincipalAffiliatePerformanceDetail

    GetPrincipalAffiliatePerformanceDetail sub-interface for GetPrincipalAffiliatePerformanceResponseData

    interface GetPrincipalAffiliatePerformanceDetail {
        buyers_confirmed?: number;
        buyers_placed?: number;
        currency?: string;
        estimated_commission_confirmed?: number;
        estimated_commission_placed?: number;
        new_buyers_confirmed?: number;
        new_buyers_placed?: number;
        orders_confirmed?: number;
        orders_placed?: number;
        region?: string;
        roi_confirmed?: number;
        roi_placed?: number;
        sales_confirmed?: number;
        sales_placed?: number;
        units_sold_confirmed?: number;
        units_sold_placed?: number;
    }
    Index

    Properties

    buyers_confirmed? buyers_placed? currency? estimated_commission_confirmed? estimated_commission_placed? new_buyers_confirmed? new_buyers_placed? orders_confirmed? orders_placed? region? roi_confirmed? roi_placed? sales_confirmed? sales_placed? units_sold_confirmed? units_sold_placed?

    Properties

    buyers_confirmed?: number

    Total number of unique buyers with confirmed affiliate marketing orders from this region during the selected period.

    buyers_placed?: number

    Total number of unique buyers who placed affiliate marketing orders from this region during the selected period.

    currency?: string

    Currency code used for all amount-based metrics of this region item.

    estimated_commission_confirmed?: number

    Estimated total payout from confirmed affiliate marketing orders during the selected period for this region.

    estimated_commission_placed?: number

    Estimated total payout from placed affiliate marketing orders during the selected period for this region.

    new_buyers_confirmed?: number

    Total number of unique new buyers with confirmed affiliate marketing orders from this region during the selected period.

    new_buyers_placed?: number

    Total number of unique new buyers who placed affiliate marketing orders from this region during the selected period.

    orders_confirmed?: number

    Total number of confirmed orders generated through affiliate marketing during the selected period for this region. Confirmed orders are either non-Cash On Delivery (non-COD) orders that have been paid for or COD orders that have been confirmed for shipping (usually 30 mins after placing the order).

    orders_placed?: number

    Total number of placed orders generated through affiliate marketing during the selected period for this region. Placed orders are orders (COD and non-COD) that buyers have successfully placed, including paid and unpaid orders.

    region?: string

    Region code of this detail item.

    roi_confirmed?: number

    Return on Investment = Sales Confirmed / Estimated Commission Confirmed. It can be used to evaluate the efficiency of your investment in affiliate marketing.

    roi_placed?: number

    Return on Investment = Sales Placed / Estimated Commission Placed. It can be used to evaluate the efficiency of your investment in affiliate marketing.

    sales_confirmed?: number

    Total value of confirmed orders generated through affiliate marketing during the selected period for this region. Confirmed orders are either non-Cash On Delivery (non-COD) orders that have been paid for or COD orders that have been confirmed for shipping (usually 30 mins after placing the order).

    sales_placed?: number

    Total value of placed orders generated through affiliate marketing during the selected period for this region. Placed orders are orders (COD and non-COD) that buyers have successfully placed, including paid and unpaid orders.

    units_sold_confirmed?: number

    Total number of items sold in confirmed orders generated through affiliate marketing during the selected period for this region.

    units_sold_placed?: number

    Total number of items sold in placed orders generated through affiliate marketing during the selected period for this region.

    Settings

    Member Visibility

    On This Page

    Properties