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

    Interface GetReturnDetailResponseData

    GetReturnDetailResponseData sub-interface for GetReturnDetailResponse

    interface GetReturnDetailResponseData {
        activity?: GetReturnDetailActivity[];
        amount_before_discount?: number;
        buyer_videos?: GetReturnDetailBuyerVideo[];
        create_time?: number | Date;
        currency?: string;
        dispute_reason?: string[];
        dispute_text_reason?: string[];
        due_date?: number | Date;
        follow_up_action_list?: GetReturnDetailFollowUpAction[];
        has_uploaded_shipping_proof?: boolean;
        image?: string[];
        is_arrived_at_warehouse?: number;
        is_partial_quantity_return?: boolean;
        is_refund_amount_adjusted?: boolean;
        is_reverse_logistics_channel_integrated?: boolean;
        is_seller_arrange?: boolean;
        is_shipping_proof_mandatory?: boolean;
        item?: GetReturnDetailItem[];
        logistics_status?: string;
        needs_logistics?: boolean;
        negotiation?: GetReturnDetailNegotiation;
        order_sn?: string;
        package_query_number?: string;
        reason?: string;
        reassessed_request_reason?: string;
        refund_amount?: number;
        return_address?: GetReturnDetailReturnAddress;
        return_pickup_address?: GetReturnDetailReturnPickupAddress;
        return_refund_request_type?: number;
        return_refund_type?: string | number;
        return_seller_due_date?: number | Date;
        return_ship_due_date?: number | Date;
        return_sn?: string;
        return_solution?: number;
        reverse_logistics_channel_name?: string;
        reverse_logistics_status?: string;
        seller_compensation?: GetReturnDetailSellerCompensation;
        seller_proof?: GetReturnDetailSellerProof;
        shipping_fee_responsibility?: string;
        shipping_fee_responsibility_reason?: string;
        status?: string;
        text_reason?: string;
        tracking_number?: string;
        update_time?: number | Date;
        user?: GetReturnDetailUser;
        validation_type?: string;
        virtual_contact_number?: string;
    }
    Index

    Properties

    amount_before_discount?: number

    Order price before discount.

    buyer_videos?: GetReturnDetailBuyerVideo[]
    create_time?: number | Date

    The time of return create.

    currency?: string

    Currency of the return.

    dispute_reason?: string[]

    The reason of seller dispute return. While the return has been disputed, this field is useful. Applicable values: See Data Definition- ReturnDisputeReason.

    dispute_text_reason?: string[]

    The reason that seller provide. While the return has been disputed, this field is useful.

    due_date?: number | Date

    The last time seller deal with this return.

    follow_up_action_list?: GetReturnDetailFollowUpAction[]

    [Only for validation_type = warehouse_validation] Warehouse handling actions for each item in the parcel.

    has_uploaded_shipping_proof?: boolean

    To indicate whether seller has already uploaded shipping proof for this return.

    image?: string[]

    Image URLs of return.

    is_arrived_at_warehouse?: number

    [Only for validation_type = warehouse_validation] Indicates the parcel’s check-in status at the warehouse. This field helps sellers quickly determine whether the parcel has arrived at the warehouse or has been rejected. Applicable values:1: Pending Inbound2: Rejected3: Inbound4: Cancelled

    is_partial_quantity_return?: boolean

    To indicate whether the return includes items with partial quantities.

    is_refund_amount_adjusted?: boolean

    To indicate whether the actual refund amount is less than the maximum allowable refund.

    is_reverse_logistics_channel_integrated?: boolean

    To indicate whether the reverse logistic channel type selected is integrated or non-integrated.

    is_seller_arrange?: boolean

    To indicate whether the return_sn is using the “Seller Arrange” return method. This would only be True for TW and BR.

    is_shipping_proof_mandatory?: boolean

    To indicate whether uploading shipping proof is mandatory for seller to confirm "Arrange Pickup" when is_seller_arrange = true.

    logistics_status?: string

    To indicate the reverse logistics status. See "Data Definition - LogisticsStatus".Note: - This is a legacy field that only reflects the reverse logistics status of Normal RR. To determine whether the RR is a Normal RR, check if return_refund_request_type = 0.- If you need the reverse logistics status for Normal RR, In-transit RR, or Return-on-the-Spot, please use the newly released field reverse_logistic_status instead.

    needs_logistics?: boolean

    Items to be sent back to seller. Can be either integrated/non-integrated.

    order_sn?: string

    Shopee's unique identifier for an order.

    package_query_number?: string

    [Only for TW non-integrated channel] The query number used in virtual phone number calls to contact the recipient of this return.

    reason?: string

    Indicates the original return reason submitted by the buyer when initiating the return request.Applicable values: See Data Definition- ReturnReason and Reassessed Request Reason. Note: There may be cases where Shopee Agent updates the return request with a "Reassessed Return Reason" after reviewing more details about the buyer's return request and potentially after requesting evidence from the seller. If the platform updates the return reason during this process, the reassessed outcome will be provided separately in the reassessed_request_reason field.

    reassessed_request_reason?: string

    Indicates the return reason reassessed by the platform as more suitable.There may be cases where Shopee Agent updates the return request with a "Reassessed Return Reason" after reviewing more details about the buyer's return request and potentially after requesting evidence from the seller.Applicable values: See Data Definition- ReturnReason and Reassessed Request Reason. If no reassessment has been made, the value will be NONE.

    refund_amount?: number

    Amount of the refund.

    return_pickup_address?: GetReturnDetailReturnPickupAddress

    To indicate the buyer's pickup address

    return_refund_request_type?: number

    To indicate the type of return refund request, whether it is a Normal RR request, an In-transit RR request, and a Return on the Spot: 0: Normal RR (RR is raised by the buyer after delivery done / estimated delivery date)1: In-transit RR (RR is raised by the buyer while item is still in-transit to buyer)2: Return-on-the-Spot (RR is raised by the driver after buyer rejected parcel at delivery)For more details, see Data Definition- Return Refund Request Type.

    return_refund_type?: string | number

    To indicate whether the return is RRBOC (Return/Refund request raised before Order Complete) or RRAOC (Return/Refund request raised after Order Complete).

    return_seller_due_date?: number | Date

    The due date for seller to deal with this return when buyer have shipped order.

    return_ship_due_date?: number | Date

    The due date for buyer to ship order.

    return_sn?: string

    The serial number of return.

    return_solution?: number

    To indicate the most updated solution of the Return/Refund request (NOTE: this is not the solution during negotiation). Applicable value: - 0: Return and Refund- 1: Refund Only

    reverse_logistics_channel_name?: string

    To indicate reverse logistic carrier name.

    reverse_logistics_status?: string

    To indicate the latest reverse logistic status of a return, referring to the current status of the buyer shipping the return parcel back to the validation point (seller or warehouse), including Normal RR, In-transit RR, and Return-on-the-Spot.See "Data Definition - ReverseLogisticsStatus" as status displayed for Normal RR and In-transit RR or Return-on-the-Spot are different.

    seller_compensation?: GetReturnDetailSellerCompensation
    shipping_fee_responsibility?: string

    [Only for Local BR Sellers] To indicate the party responsible for the applicable shipping fees before accounting for Shopee Easy Return Programme coverage. Applicable Values: Pending, Seller, Shopee

    shipping_fee_responsibility_reason?: string

    [Only for Local BR Sellers] To indicate the reason corresponding to the Shipping Fee Responsibility. Applicable values: See Data Definition- Shipping Fee Responsibility Reason

    status?: string

    Enumerated type that defines the current status of the return. Applicable values: See Data Definition- ReturnStatus.

    text_reason?: string

    Reason that buyer provide.

    tracking_number?: string

    The tracking number assigned by the shipping carrier for item shipment.

    update_time?: number | Date

    The time of modify return.

    validation_type?: string

    To indicate whether seller or warehouse will expect to receive the return parcel from buyer and validate the condition of the parcel: - seller_validation - warehouse_validationFor more details, see Data Definition- ValidationType.

    virtual_contact_number?: string

    [Only for TW non-integrated channel] The virtual phone number to contact the recipient.