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

    Interface GetIncomeOverviewRequest

    Request parameters for get_income_overview

    Retrieves a consolidated snapshot of the seller’s income amounts categorized by income status for a specified shop. This API provides a holistic overview similar to Seller Center’s “Income Overview” section, allowing external systems to reflect the same current payout view.

    Data is dynamically determined based on the shop type (Local or Cross Border) and the income status requested. Historical income results are not retrievable, providing consistent information as Seller Centre.

    interface GetIncomeOverviewRequest {
        income_status?: number;
    }
    Index

    Properties

    Properties

    income_status?: number

    Status of Seller Income payout (Enum - Desc)Local Shop1 -Released2 - PendingCB Shop0 - To Release1 - Released2 - PendingNote: By default, if Income Status was not provided in the request params (non mandatory), API response will return all values for all Income status based on either Local/CB