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

    Interface GetIncomeDetailRequest

    Request parameters for get_income_detail

    Retrieves detailed order-level income information across various income statuses for a specified time period. This API enables partners to display granular transaction-level income data consistent with Seller Center’s “Income Details” view, segmented by income status and payout stage.

    The API dynamically adapts data fields based on the seller’s shop type (Local or Cross Border) and the selected income status (e.g., Pending, To Release, Released).

    interface GetIncomeDetailRequest {
        cursor?: string;
        date_from: string;
        date_to: string;
        income_status: number;
        page_size: number;
    }
    Index

    Properties

    cursor?: string

    Pagination token for the next set of results. Use an empty string "" for the first request.

    date_from: string

    Start date (YYYY-MM-DD) of the income reference period. This field is only used for Income Status = Released, the other statuses will display all records currently in that status.For income Status = Released, For Released → Payout released date:1. date_to must be later than date_from2. date range cannot exceed 14 days3. Input must follow valid date format.

    date_to: string

    End date (YYYY-MM-DD) of the income reference period. Must be later than date_from. This field is only used for Income Status = Released, the other statuses will display all records currently in that status.For income Status = Released, For Released → Payout released date:1. date_to must be later than date_from2. date range cannot exceed 14 days3. Input must follow valid date format.

    income_status: number

    Status of Seller Income payout (Enum - Desc)Local1 -Released2 - PendingCB0 - To Release1 - Released2 - Pending

    page_size: number

    Number of income detail records to retrieve per page