Significant OpenAPI Updates

Dear Developer,

To help sellers better manage Return Refund requests and Disputes, Shopee has made the following updates:

API/Push	Updates
v2.returns.get_return_list v2.returns.get_return_detail	1) Add the “return_refund_type” response parameter to indicate whether the return is RRBOC or RRAOC. 2) Add the “return_solution” response parameter to return the most updated Return/Refund request solution. 3) Add the “NOT_NEEDED” option for the “seller_proof_status” response parameter.
return_updates_push	Add the “return_updates_push” to send notifications when the following fields of Return/Refund change: return_status, return_solution, seller_proof_status, logistics_status.
v2.returns.get_return_dispute_reason	Add the following response parameters to return the proof requirement, sample evidence, and evidence modules of each dispute reason: -> dispute_reason_list -> dispute_reason -> dispute_requirement -> sample_evidence -> type -> url -> thumbnail -> evidence_module_list -> module_index -> requirement -> is_required Note: The existing dispute_reason response parameter will be sunset on 2025-03-31, please switch to use dispute_reason_list to get the dispute_reason and associated evidence list.
v2.returns.dispute	Add the following request parameters to upload evidence images: -> image_list -> module_index -> requirement -> image_url Note: The existing image request parameter will be sunset on 2025-03-31, please switch to use image_list to upload evidence images.
v2.returns.cancel_dispute	Add the “v2.returns.cancel_dispute” to allow sellers to cancel compensation disputes.

Related APIs:

v2.returns.get_return_list

v2.returns.get_return_detail

v2.returns.get_return_dispute_reason

v2.returns.dispute

v2.returns.cancel_dispute

Related Push:

return_updates_push

Effective Date on Live:

2024.12.31

尊敬的开发者，

为了帮助卖家更好地管理退货退款和Dispute，Shopee做出了以下更新：

接口/Push	更新内容
v2.returns.get_return_list v2.returns.get_return_detail	1) 新增 “return_refund_type” 响应参数来标识当前 Return/Refund 是 RRBOC 或 RRAOC。 2) 新增 “return_solutin” 响应参数来返回当前 Return/Refund 的最新解决方案。 3) 针对 “seller_proof_status” 响应参数新增 “NOT_NEEDED” 选项。
return_updates_push	新增 “return_updates_push”，当 Return/Refund 的下述信息发生更新时发送 Push 通知：return_status, return_solution, seller_proof_status, logistics_status。
v2.returns.get_return_dispute_reason	新增下述响应参数来返回每一个 Dispute Reason 的证据要求、证据示例和证据模板： -> dispute_reason_list -> dispute_reason -> dispute_requirement -> sample_evidence -> type -> url -> thumbnail -> evidence_module_list -> module_index -> requirement -> is_required 注意: 现有的 dispute_reason 响应参数将于 2025-03-31 下线, 请切换使用 dispute_reason_list 来获取 Dispute Reason及其相关的证据模板。
v2.returns.dispute	新增下述请求参数来上传证据图片： -> image_list -> module_index -> requirement -> image_url 注意: 现有的 image 请求参数将于 2025-03-31 下线, 请切换使用 image_list 来上传证据图片。
v2.returns.cancel_dispute	新增 “v2.returns.cancel_dispute” 接口来支持卖家撤回 Compensation Dispute。

影响接口: