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

    Interface GetTargetedCampaignAddableProductListRequest

    Request parameters for get_targeted_campaign_addable_product_list

    Returns a list of products that can be added to a targeted campaign

    interface GetTargetedCampaignAddableProductListRequest {
        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 by item name or item ID, item_id should be split by comma and at most 50 items.Please specify search_type for it to be effective, otherwise search_content will be ignored.

    search_type?: string

    Search type: ITEM_NAME or ITEM_ID, used with search_content.

    sort_by?: string

    Use this field to specify which field to use to sort the returned item list. Available values:-sales: Sort by sales in descending order (default value)sales: Sort by sales in ascending order-stock: Sort by inventory in descending orderstock: Sort by inventory in ascending order-price: Sort by price in descending orderprice: Sort by price in ascending order