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

    Interface GetProductPerformanceListParams

    interface GetProductPerformanceListParams {
        end_date?: string;
        endDate?: string;
        item_id?: number;
        item_name?: string;
        itemId?: number;
        itemName?: string;
        order_by?: string;
        orderBy?: string;
        page_no?: number;
        page_size?: number;
        pageNo?: number;
        pageSize?: number;
        period_type?: string;
        periodType?: string;
        sort?: string;
    }
    Index

    Properties

    end_date? endDate? item_id? item_name? itemId? itemName? order_by? orderBy? page_no? page_size? pageNo? pageSize? period_type? periodType? sort?

    Properties

    end_date?: string
    endDate?: string

    The end_date format should be "YYYY-MM-DD".- For Day, Last7d, Last15d, and Last30d, the end_date must before current day.- For Week, the end_date must be Sunday and must be less than or equal to the current week.- For Month, the end_date must be the end of the month and must be less than or equal to the current month.

    item_id?: number
    item_name?: string
    itemId?: number

    Shopee's unique identifier for an item.

    itemName?: string

    Search by product name.

    order_by?: string
    orderBy?: string

    Use this field to specify which field to use to sort the returned list. Available values:PlacedOrdersPlacedSalesPlacedUniqueBuyersConfirmedOrdersConfirmedSalesConfirmedUniqueBuyers

    Optionalpage_no

    page_no?: number

    Optionalpage_size

    page_size?: number
    pageNo?: number

    The start index of request. Starting from 1.

    pageSize?: number

    The number of item returned by this request. Max is 20.

    period_type?: string
    periodType?: string

    Period Type. Applicable values:DayWeekMonthLast7dLast15dLast30dNote: The end date must align with the Period Type.

    sort?: string

    Use this field to specify whether the returned list is sorted in ascending or descending order_by. Available values:ascdesc

    Settings

    Member Visibility

    On This Page

    Properties