Shopee SDK API Reference - v1.11.0
    Preparing search index...

    Interface GetIncomeOverviewResponse

    Response for v2.payment.get_income_overview

    interface GetIncomeOverviewResponse {
        error: string;
        message: string;
        request_id: string;
        response?: { latest_payout_date?: string; total_income?: TotalIncome };
        total_income?: TotalIncome;
        warning?: string | string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    error message request_id response? total_income? warning?

    Properties

    error: string

    Error code if any error occurred

    message: string

    Error message if any error occurred

    request_id: string

    The identifier for an API request for error tracking

    response?: { latest_payout_date?: string; total_income?: TotalIncome }

    Type Declaration

    • Optionallatest_payout_date?: string

      The latest payout date for the released income. Format: YYYY-MM-DD. Only for CN shops.

    • Optionaltotal_income?: TotalIncome

      Object containing total income components.

    total_income?: TotalIncome

    Object containing total income components (fallback top-level).

    warning?: string | string[]

    Warning message or list of warning messages

    Settings

    Member Visibility

    On This Page

    Properties