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

    Interface GetReturnListRequest

    Request parameters for get_return_list

    Use this api to get detail information of many return by shop id.

    interface GetReturnListRequest {
        create_time_from?: number | Date;
        create_time_to?: number | Date;
        negotiation_status?: string;
        page_no: number;
        page_size: number;
        seller_compensation_status?: string;
        seller_proof_status?: string;
        status?: string;
        update_time_from?: number | Date;
        update_time_to?: number | Date;
    }
    Index

    Properties

    create_time_from? create_time_to? negotiation_status? page_no page_size seller_compensation_status? seller_proof_status? status? update_time_from? update_time_to?

    Properties

    create_time_from?: number | Date

    The create_time_from and create_time_to fields specify a date range for retrieving orders (based on the order create time). The create_time_from field is the starting date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days.

    create_time_to?: number | Date

    The create_time_from and create_time_to fields specify a date range for retrieving orders (based on the order create time). The create_time_from field is the starting date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days.

    negotiation_status?: string

    This is for filtering return request by counter status. See "Data Definition - NegotiationStatus"

    page_no

    page_no: number

    Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call.

    page_size

    page_size: number

    if many items are available to retrieve, you may need to call GetReturnList multiple times to retrieve all the data. Each result set is returned as a page of entries. Default is 40. Use the Pagination filters to control the maximum number of entries (<= 100) to retrieve per page (i.e., per call), the offset number to start next call. This integer value is usUed to specify the maximum number of entries to return in a single ""page"" of data.

    seller_compensation_status?: string

    This is for filtering return request by compensation status. See "Data Definition - SellerCompensationStatus"

    seller_proof_status?: string

    This is for filtering return request by proof status. See "Data Definition - SellerProofStatus"

    status?: string

    This is for filtering return request by return status. See "Data Definition - ReturnStatus"

    update_time_from?: number | Date

    The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the last return updated time). The update_time_from field is the starting date range. The maximum date range that may be specified with the update_time_from and update_time_to fields is 15 days. update_time_from should be >= create_time_from

    update_time_to?: number | Date

    The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the last return updated time). The update_time_from field is the starting date range. The maximum date range that may be specified with the update_time_from and update_time_to fields is 15 days. update_time_from should be >= create_time_from

    Settings

    Member Visibility

    On This Page

    Properties