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

    Interface AmsGetShopPerformanceResponse

    Response for get_shop_performance API

    interface AmsGetShopPerformanceResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            clicks?: number;
            est_commission?: string;
            fetched_date_range?: string;
            gross_item_sold?: number;
            new_buyers?: number;
            orders?: number;
            roi?: string;
            sales?: string;
            total_buyers?: number;
        };
        warning?: string
        | string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    error message request_id response warning?

    Properties

    error: string

    Error code if any error occurred

    message: string

    Error message if any error occurred

    request_id: string

    The identifier for an API request for error tracking

    response: {
        clicks?: number;
        est_commission?: string;
        fetched_date_range?: string;
        gross_item_sold?: number;
        new_buyers?: number;
        orders?: number;
        roi?: string;
        sales?: string;
        total_buyers?: number;
    }

    Type Declaration

    • Optionalclicks?: number

      Total clicks

    • Optionalest_commission?: string

      Estimated commission

    • Optionalfetched_date_range?: string

      Fetched date range

    • Optionalgross_item_sold?: number

      Gross items sold

    • Optionalnew_buyers?: number

      New buyers

    • Optionalorders?: number

      Total orders

    • Optionalroi?: string

      ROI

    • Optionalsales?: string

      Total sales

    • Optionaltotal_buyers?: number

      Total buyers

    warning?: string | string[]

    Warning message or list of warning messages

    Settings

    Member Visibility

    On This Page

    Properties