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

    Interface GetOpenCampaignNotAddedProductRequest

    Request parameters for get_open_campaign_not_added_product

    Retrieve eligible products not yet added to the Open Campaign

    interface GetOpenCampaignNotAddedProductRequest {
        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. When search_content is passed, search_type is required.

    search_type?: string

    Search type: ITEM_ID or ITEM_NAME

    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