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

    Interface GetCurrentInventoryRequest

    Request parameters for get_current_inventory

    Get Seller Center Current Inventory Page Data

    interface GetCurrentInventoryRequest {
        category_id?: number;
        inbound_pending_approval?: number;
        keyword?: string;
        not_moving_tag?: number;
        page_no?: number;
        page_size?: number;
        products_with_inventory?: number;
        search_type?: number;
        stock_levels?: string;
        whs_ids?: string[];
        whs_region: string;
    }
    Index

    Properties

    category_id?: number

    Category id. Here you need to call the get_category API to retrieve the first-tier category_id.

    inbound_pending_approval?: number

    Blank-All;0-No;1-Yes

    keyword?: string

    Bind Value and Search_type

    not_moving_tag?: number

    Blank-All;0-No;1-Yes

    page_no?: number

    Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call. If empty, the default value is 1.

    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), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.If empty, the default value is 10. The value should be between 1 and 100.

    products_with_inventory?: number

    Blank-All;0-No;1-Yes

    search_type?: number

    0-All data;1-Product Name;2-SKU ID;3-Variations;4-Item ID

    stock_levels?: string

    1-Low Stock & No Sellable stock; 2-Low Stock & To replenish; 3-Low Stock & Replenished; 4-Excess

    whs_ids?: string[]

    Whs ID list, comma-separated

    whs_region: string

    The warehouse region you want to query, can only query one region in a requestOptional value: BR、CN、ID、MY、MX、TH、TW、PH、VN、SGIf do not pass, will get error "block by gateway due to invalid cid"