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

    Interface GetIncomeDetailParams

    Parameters for v2.payment.get_income_detail

    interface GetIncomeDetailParams {
        cursor?: string;
        date_from: string;
        date_to: string;
        income_status: number;
        page_size: number;
        [key: string]: string | number | boolean | null | undefined;
    }

    Hierarchy

    • Record<string, string | number | boolean | null | undefined>
      • GetIncomeDetailParams

    Indexable

    • [key: string]: string | number | boolean | null | undefined
    Index

    Properties

    cursor? date_from date_to income_status page_size

    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.

    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.

    income_status: number

    Status of Seller Income payout. Supported values: Local: 1 - Released, 2 - Pending. CB: 0 - To Release, 1 - Released, 2 - Pending.

    page_size

    page_size: number

    Number of income detail records to retrieve per page

    Settings

    Member Visibility

    On This Page

    Properties