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

    Interface GetGmsItemPerformanceRequest

    Request parameters for get_gms_item_performance

    Get GMS Item performance

    1. The response returned is sorted by item_id
    2. Only items with performance will be returned
    interface GetGmsItemPerformanceRequest {
        campaign_id?: number;
        end_date: string;
        limit?: number;
        offset?: number;
        start_date: string;
    }
    Index

    Properties

    campaign_id? end_date limit? offset? start_date

    Properties

    campaign_id?: number

    The GMS Campaign ID. Provide if available.

    end_date: string

    End date of Campaign e.g. "11-11-2025". Maximum duration of 3 months between start_date & end_date.

    limit?: number

    Specifies the maximum number of records to show. Default is 50. Maximum is 100.

    offset?: number

    Specifies the starting point, or the number of records to skip. Default is 0.

    start_date: string

    Start date of Campaign e.g. "11-11-2025". Maximum duration of 3 months between start_date & end_date. Earliest start_date is 6 months before today.

    Settings

    Member Visibility

    On This Page

    Properties