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

    Interface GetReverseTrackingInfoResponseData

    GetReverseTrackingInfoResponseData sub-interface for GetReverseTrackingInfoResponse

    interface GetReverseTrackingInfoResponseData {
        collection_pin_code?: string;
        estimated_delivery_date_max?: number | Date;
        estimated_delivery_date_min?: number | Date;
        post_return_logistics_status?: string;
        post_return_logistics_tracking_info?: GetReverseTrackingInfoPostReturnLogisticsTrackingInfo[];
        post_return_logistics_update_time?: number | Date;
        return_refund_request_type?: number;
        return_sn?: string | number;
        reverse_logistics_status?: string;
        reverse_logistics_update_time?: number | Date;
        rts_tracking_number?: string;
        tracking_info?: GetReverseTrackingInfoTrackingInfo[];
        tracking_number?: string;
        validation_type?: string;
    }
    Index

    Properties

    collection_pin_code?: string

    The collection Pin Code to enter for seller to collect parcel in collection point or locker.Note: Only available for TW region.

    estimated_delivery_date_max?: number | Date

    The maximum estimated delivery date for the reverse logistics. This is calculated by Shopee Logistics Services once buyer ships out if there is historical tracking data available from third party logistics provider. Note: Only available for Normal RR with integrated reverse logistics.

    estimated_delivery_date_min?: number | Date

    The minimum estimated delivery date for the reverse logistics. This is calculated by Shopee Logistics Services once buyer ships out if there is historical tracking data available from third party logistics provider.Note: Only available for Normal RR with integrated reverse logistics.

    Optionalpost_return_logistics_status

    post_return_logistics_status?: string

    Post-return logistics status, referring to the current status of the warehouse shipping the return parcel back to the seller in warehouse validation mode. See "Data Definition - Post Return Logistics Status".Note: - Only available for Normal RR with return_solution = 0 (Return and Refund) and validation_type = warehouse_validation, and the warehouse ships the return parcel back to seller using integrated reverse logistics.- If validation_type = warehouse_validation AND the warehouse uses an integrated logistics channel to ship the return parcel back to the seller, there are two segments of reverse logistics: - The buyer first ships the return parcel back to the warehouse. Use the fields reverse_logistics_status, reverse_logistics_update_time, tracking_number, and tracking_info to obtain tracking information for this first segment.- The warehouse then ships the return parcel back to the seller. Use the fields post_return_logistics_status, post_return_logistics_update_time, rts_tracking_number, and post_return_logistics_tracking_info to obtain tracking information for this second segment (post-return logistics).- For Cross-Border Returns, if the second segment exists, the API returns information for both the first and second segments. For Local Returns, if the second segment exists, the API prioritizes and returns only the second segment information.

    Optionalpost_return_logistics_tracking_info

    post_return_logistics_tracking_info?: GetReverseTrackingInfoPostReturnLogisticsTrackingInfo[]

    Only available for Normal RR with return_solution = 0 (Return and Refund) and validation_type = warehouse_validation, and the warehouse ships the return parcel back to seller using integrated reverse logistics.In this scenario, the tracking logistics from warehouse to seller is called "post-return logistics", with the tracking information pushed by third party logistics provider to Shopee.Note: - If validation_type = warehouse_validation AND the warehouse uses an integrated logistics channel to ship the return parcel back to the seller, there are two segments of reverse logistics: - The buyer first ships the return parcel back to the warehouse. Use the fields reverse_logistics_status, reverse_logistics_update_time, tracking_number, and tracking_info to obtain tracking information for this first segment.- The warehouse then ships the return parcel back to the seller. Use the fields post_return_logistics_status, post_return_logistics_update_time, rts_tracking_number, and post_return_logistics_tracking_info to obtain tracking information for this second segment (post-return logistics).- For Cross-Border Returns, if the second segment exists, the API returns information for both the first and second segments. For Local Returns, if the second segment exists, the API prioritizes and returns only the second segment information.

    Optionalpost_return_logistics_update_time

    post_return_logistics_update_time?: number | Date

    The last update time of the post-return logistics status where warehouse sends return parcel from warehouse to seller.Note: - Only available for Normal RR with return_solution = 0 (Return and Refund) and validation_type = warehouse_validation, and the warehouse ships the return parcel back to seller using integrated reverse logistics.- If validation_type = warehouse_validation AND the warehouse uses an integrated logistics channel to ship the return parcel back to the seller, there are two segments of reverse logistics: - The buyer first ships the return parcel back to the warehouse. Use the fields reverse_logistics_status, reverse_logistics_update_time, tracking_number, and tracking_info to obtain tracking information for this first segment.- The warehouse then ships the return parcel back to the seller. Use the fields post_return_logistics_status, post_return_logistics_update_time, rts_tracking_number, and post_return_logistics_tracking_info to obtain tracking information for this second segment (post-return logistics).- For Cross-Border Returns, if the second segment exists, the API returns information for both the first and second segments. For Local Returns, if the second segment exists, the API prioritizes and returns only the second segment information.

    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_sn?: string | number

    Shopee's unique identifier for a return/refund request (serial number of return).

    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.Note: If validation_type = seller_validation, there is only one segment of reverse logistics (The buyer ships the return parcel directly back to the seller). Please use the fields reverse_logistics_status, reverse_logistics_update_time, tracking_number, and tracking_info to obtain the reverse logistics tracking information.

    reverse_logistics_update_time?: number | Date

    The last update time of the reverse logistics status including Normal RR, In-transit RR, and Return-on-the-Spot.Note: If validation_type = seller_validation, there is only one segment of reverse logistics (The buyer ships the return parcel directly back to the seller). Please use the fields reverse_logistics_status, reverse_logistics_update_time, tracking_number, and tracking_info to obtain the reverse logistics tracking information.

    rts_tracking_number?: string

    The tracking number for the post-return logistics (the logistics tracking number used when the warehouse ships the parcel back to the seller). RTS stands for "Return to Seller".Note: - Only available for Normal RR with return_solution = 0 (Return and Refund) and validation_type = warehouse_validation, and the warehouse ships the return parcel back to seller using integrated reverse logistics.- If validation_type = warehouse_validation AND the warehouse uses an integrated logistics channel to ship the return parcel back to the seller, there are two segments of reverse logistics: - The buyer first ships the return parcel back to the warehouse. Use the fields reverse_logistics_status, reverse_logistics_update_time, tracking_number, and tracking_info to obtain tracking information for this first segment.- The warehouse then ships the return parcel back to the seller. Use the fields post_return_logistics_status, post_return_logistics_update_time, rts_tracking_number, and post_return_logistics_tracking_info to obtain tracking information for this second segment (post-return logistics).- For Cross-Border Returns, if the second segment exists, the API returns information for both the first and second segments. For Local Returns, if the second segment exists, the API prioritizes and returns only the second segment information.

    The detailed tracking information list for the reverse logistics.Note: - Only available for Normal RR with integrated reverse logistics, with the tracking information pushed by third party logistics provider to Shopee.- If validation_type = seller_validation, there is only one segment of reverse logistics (The buyer ships the return parcel directly back to the seller). Please use the fields reverse_logistics_status, reverse_logistics_update_time, tracking_number, and tracking_info to obtain the reverse logistics tracking information.

    tracking_number?: string

    The tracking number for the reverse logistics (the logistics tracking number provided when the buyer ships the item back).Note: - Only available for Normal RR with integrated reverse logistics.- If validation_type = seller_validation, there is only one segment of reverse logistics (The buyer ships the return parcel directly back to the seller). Please use the fields reverse_logistics_status, reverse_logistics_update_time, tracking_number, and tracking_info to obtain the reverse logistics tracking information.

    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.