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

    Interface GetConversionReportRequest

    Request parameters for get_conversion_report

    Retrieve the shop's conversion report with details about each order, item, affiliate, campaign.You can filter results using one or multiple time ranges, and the final result will be the intersection of these ranges. Due to data volume limitations, the maximum queryable time span is three months, etc.Maximum data can be viewed is 500 pages, please export data for more details.

    interface GetConversionReportRequest {
        affiliate_id?: number;
        ams_deduction_time_end?: number | Date;
        ams_deduction_time_start?: number | Date;
        attr_campaign_id?: number;
        buyer_status?: string;
        campaign_partner?: string | number;
        conversion_completed_time_end?: number | Date;
        conversion_completed_time_start?: number | Date;
        deduction_method?: string;
        deduction_status?: string;
        item_id?: number;
        item_name?: string;
        l1_category_id?: number;
        l2_category_id?: number;
        l3_category_id?: number;
        order_completed_time_end?: number | Date;
        order_completed_time_start?: number | Date;
        order_sn?: string;
        order_status?: string;
        page_no: number;
        page_size: number;
        place_order_time_end?: number | Date;
        place_order_time_start?: number | Date;
        seller_campaign_type?: string;
        verified_status?: string;
    }
    Index

    Properties

    affiliate_id? ams_deduction_time_end? ams_deduction_time_start? attr_campaign_id? buyer_status? campaign_partner? conversion_completed_time_end? conversion_completed_time_start? deduction_method? deduction_status? item_id? item_name? l1_category_id? l2_category_id? l3_category_id? order_completed_time_end? order_completed_time_start? order_sn? order_status? page_no page_size place_order_time_end? place_order_time_start? seller_campaign_type? verified_status?

    Properties

    affiliate_id?: number

    ID of the affiliate who promoted the item.

    ams_deduction_time_end?: number | Date

    End time (inclusive) of fee deduction, in timestamp format.

    ams_deduction_time_start?: number | Date

    Start time (inclusive) of fee deduction, in timestamp format.

    attr_campaign_id?: number

    ID referencing the campaign rule applied.

    buyer_status?: string

    Buyer Status. Applicable values:NewExisting

    campaign_partner?: string | number

    Name/ID of campaign partner.

    conversion_completed_time_end?: number | Date

    End time (inclusive) of final completion, in timestamp format.

    conversion_completed_time_start?: number | Date

    Start time (inclusive) of final completion, in timestamp format.

    deduction_method?: string

    Deduction Method. Applicable values:OrderEscrowSellerWalletAutoAdjustmentSVSPaymentLinkOfflineSettlementAMSCredit

    deduction_status?: string

    Deduction Status. Applicable values:PendingDeductionDeducted

    item_id?: number

    ID of the product purchased.

    item_name?: string

    Product's name.

    l1_category_id?: number

    Hierarchical product category classification. (L1 Category)

    l2_category_id?: number

    Hierarchical product category classification. (L2 category)

    l3_category_id?: number

    Hierarchical product category classification. (L3 Category)

    order_completed_time_end?: number | Date

    End time (inclusive) of order completion, in timestamp format.

    order_completed_time_start?: number | Date

    Start time (inclusive) of order completion, in timestamp format.

    order_sn?: string

    Unique identifier of the order.

    order_status?: string

    Order Status. Applicable values:UnpaidPendingCompletedCancelled

    page_no

    page_no: number

    Specifies the page number of data to return in the current call. Starting from 1. If data is more than one page, the page_no can be some entry to start next call.

    page_size

    page_size: number

    Number of records returned per page, the maximum limit is 500, and page_no * page_size must be <= 10000.

    place_order_time_end?: number | Date

    End time (inclusive) of order placement, in timestamp format.

    place_order_time_start?: number | Date

    Start time (inclusive) of order placement, in timestamp format.

    seller_campaign_type?: string

    Seller Campaign Type. Applicable values:TargetCampaignOpenCampaignMCNCampaign

    verified_status?: string

    Verified Status. Applicable values:UnverifiedValidInvalid

    Settings

    Member Visibility

    On This Page

    Properties