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

    Interface GetOpenCampaignAddedProductRequest

    Request parameters for get_open_campaign_added_product

    Retrieve all products currently in the Open Campaign, including campaign status, commission rate, and promotion period

    interface GetOpenCampaignAddedProductRequest {
        cursor?: string;
        page_size: number;
        search_content?: string;
        search_type?: string;
        sort_by?: string;
    }
    Index

    Properties

    cursor?: string

    Specifies the starting entry of data to return in the current call. Default is "" or not passed. If data is more than one page, the cursor can be some entry to start next call.

    page_size: number

    Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100.

    search_content?: string

    Search for item_name or item_id, item_id should be split by comma and at most 50 items.

    search_type?: string

    Search type: ITEM_NAME or ITEM_ID

    sort_by?: string

    Use this field to specify which field to use to sort the returned item list. Sort by update_time and commission_id in descending order by default. Available values:commission_rate: Sort by commission_rate in ascending order-commission_rate: Sort by commission_rate in descending order