快工助手跨境电商知识与商机助手

v2.returns.get_return_dispute_reason

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.returns.get_return_dispute_reason

To get the dispute return reason.

#

§2 Overview

Overview

FieldValue
ModuleReturns
API typeShop
HTTP methodGET
Path/api/v2/returns/get_return_dispute_reason
Production URLhttps://partner.shopeemobile.com/api/v2/returns/get_return_dispute_reason
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/returns/get_return_dispute_reason
PermissionERP System; Seller In House System; Customer Service; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
return_snstringYes24112301K66SQXMThe serial number of return.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
request_idstringopenapi-e3e3e7f32a7c6d903377b902ac7e7a00:01000237d706e07e:0000004e4d5c1f2fThe identifier for an API request for error tracking
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
responseobjectDetail informations you are querying.
response.dispute_reason_listobject[]The dispute_reason and associated evidence list.
response.dispute_reason_list.dispute_reasonstring50The dispute_reason for one specific case. See Data Definition - DisputeReason.
response.dispute_reason_list.dispute_requirementstringRegarding to your refund request, Shopee would like to request more information as follows :Indicate the importance of uploading required proof.
response.dispute_reason_list.sample_evidenceobject[]The URL of sample evidence to upload.
response.dispute_reason_list.sample_evidence.typeint321The type of sample evidence. Applicable value: - 1: Image
response.dispute_reason_list.sample_evidence.urlstringhttps://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_e9c9e5473d3345d08671a8cc3bc1a6de.jpgThe link of sample evidence.
response.dispute_reason_list.sample_evidence.thumbnailstringhttps://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_e9c9e5473d3345d08671a8cc3bc1a6de_tn.jpgThe link of the thumbnail of sample evidence.
response.dispute_reason_list.evidence_module_listobject[]The associated evidence module list for current dispute reason.
response.dispute_reason_list.evidence_module_list.module_indexint321The index of current evidence module.
response.dispute_reason_list.evidence_module_list.requirementstringPhoto(s) or Video of unboxing the returned parcel with the consignment note (Airway Bill).The specific requirement of current evidence module.
response.dispute_reason_list.evidence_module_list.is_requiredbooleantrueIndicate if current evidence module is mandatory or not.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2
#

§6 Request samples

Request samples

#

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/returns/get_return_dispute_reason?access_token=access_token&partner_id=partner_id&return_sn=2412120MA60NDP1&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();
#

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/returns/get_return_dispute_reason?access_token=access_token&partner_id=partner_id&return_sn=2412120MA60NDP1&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/returns/get_return_dispute_reason?access_token=access_token&partner_id=partner_id&return_sn=2412120MA60NDP1&shop_id=shop_id&sign=sign&timestamp=timestamp' 
#

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/returns/get_return_dispute_reason?access_token=access_token&partner_id=partner_id&return_sn=2412120MA60NDP1&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§11 Response sample

Response sample

#

§12 JSON

JSON

{
    "error": "",
    "message": "success",
    "request_id": "openapi-e3e3e7f32a7c6d903377b902ac7e7a00:01000237d706e07e:0000004e4d5c1f2f",
    "response": {
        "dispute_reason_list": [
            {
                "dispute_reason": 50,
                "dispute_requirement": "กรุณาส่งหลักฐานมาให้เราเพื่อประกอบการพิจารณาข้อพิพาท โดยสามารถดูตัวอย่างการส่งหลักฐานได้ที่นี่/Regarding to your refund request, Shopee would like to request more information as follows :\n\n",
                "evidence_module_list": [
                    {
                        "is_required": true,
                        "module_index": 1,
                        "requirement": "รูปภาพและวิดีโอเปิดกล่องสินค้าที่ได้รับคืนทั้งหมด โดยแสดงให้เห็นใบปะหน้าพัสดุชัดเจน/ Photo(s) or Video of unboxing the returned parcel with the consignment note (Airway Bill)."
                    },
                    {
                        "is_required": true,
                        "module_index": 2,
                        "requirement": "รูปภาพและวิดีโอสินค้าที่ได้รับคืน /Photo(s) or Video of all returned item(s) "
                    },
                    {
                        "is_required": true,
                        "module_index": 3,
                        "requirement": "รูปภาพและวิดีโอการบรรจุสินค้าลงกล่องพัสดุก่อนนำส่ง โดยเห็นใบปะหน้าสินค้าอย่างชัดเจน/ Photo(s) or Video while packing the parcel with the consignment note (Airway Bill)."
                    },
                    {
                        "is_required": true,
                        "module_index": 4,
                        "requirement": "รูปภาพภาพและวิดีโอหลักฐานตรวจสอบสินค้า /Photo or Video  of the product that is follow the details in description."
                    }
                ],
                "sample_evidence": [
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_e9c9e5473d3345d08671a8cc3bc1a6de_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_e9c9e5473d3345d08671a8cc3bc1a6de.jpg"
                    },
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_1733e9f051994b56ae748d4ebd40d0ee_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_1733e9f051994b56ae748d4ebd40d0ee.jpg"
                    },
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_7ba5c34525ef401ea326388c45c5cece_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_7ba5c34525ef401ea326388c45c5cece.jpg"
                    }
                ]
            },
            {
                "dispute_reason": 49,
                "dispute_requirement": "กรุณาส่งหลักฐานมาให้เราเพื่อประกอบการพิจารณาข้อพิพาท โดยสามารถดูตัวอย่างการส่งหลักฐานได้ที่นี่/Regarding to your refund request, Shopee would like to request more information as follows ;",
                "evidence_module_list": [
                    {
                        "is_required": true,
                        "module_index": 1,
                        "requirement": "รูปภาพและวิดีโอเปิดกล่องสินค้าที่ได้รับคืนทั้งหมด โดยแสดงให้เห็นใบปะหน้าพัสดุชัดเจน/ Photo(s) or Video of unboxing the returned parcel with the consignment note (Airway Bill). "
                    },
                    {
                        "is_required": true,
                        "module_index": 2,
                        "requirement": "รูปภาพและวิดีโอสินค้าที่ได้รับคืน /Photo(s) or Video of all returned item(s) "
                    },
                    {
                        "is_required": true,
                        "module_index": 3,
                        "requirement": "รูปภาพและวิดีโอการบรรจุสินค้าลงกล่องพัสดุก่อนนำส่ง โดยเห็นใบปะหน้าสินค้าอย่างชัดเจน/ Photo(s) or Video while packing the parcel with the consignment note (Airway Bill)."
                    }
                ],
                "sample_evidence": [
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_fa3b61a46dda4e95b0dfbc6c68c6dd17_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_fa3b61a46dda4e95b0dfbc6c68c6dd17.jpg"
                    },
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_fef717d33acc402098d8e526d25b1e24_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_fef717d33acc402098d8e526d25b1e24.jpg"
                    },
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_11cfc95634cd461ab4b2d672b169f12a_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_11cfc95634cd461ab4b2d672b169f12a.jpg"
                    }
                ]
            },
            {
                "dispute_reason": 48,
                "dispute_requirement": "กรุณาส่งหลักฐานมาให้เราเพื่อประกอบการพิจารณาข้อพิพาท โดยสามารถดูตัวอย่างการส่งหลักฐานได้ที่นี่/Regarding to your refund request, Shopee would like to request more information as follows ;:",
                "evidence_module_list": [
                    {
                        "is_required": true,
                        "module_index": 1,
                        "requirement": "รูปภาพและวิดีโอเปิดกล่องสินค้าที่ได้รับคืนทั้งหมด โดยแสดงให้เห็นใบปะหน้าพัสดุชัดเจน/ Photo(s) or Video of unboxing the returned parcel with the consignment note (Airway Bill). "
                    },
                    {
                        "is_required": true,
                        "module_index": 2,
                        "requirement": "รูปภาพและวิดีโอสินค้าที่ได้รับคืน /Photo(s) or Video of all returned item(s) "
                    },
                    {
                        "is_required": true,
                        "module_index": 3,
                        "requirement": "  รูปภาพและวิดีโอการบรรจุสินค้าลงกล่องพัสดุก่อนนำส่ง โดยเห็นใบปะหน้าสินค้าอย่างชัดเจน/ Photo(s) or Video while packing the parcel with the consignment note (Airway Bill)."
                    },
                    {
                        "is_required": true,
                        "module_index": 4,
                        "requirement": "วีดีโอหรือรูปภาพจำลองการชั่งน้ำหนักสินค้าทุกชิ้นที่จัดส่งพร้อมบรรจุภัณฑ์ขณะอยู่บนตราชั่ง โดยให้เห็นสินค้าและน้ำหนักอย่างชัดเจน /Clear Video or Photo showing the weight measurement of parcel with all items (able to see the weight and all items clearly)."
                    }
                ],
                "sample_evidence": [
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_295ac2f409ef472ea4296f32d3cc3780_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_295ac2f409ef472ea4296f32d3cc3780.jpg"
                    },
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_1fbc593ce18940bdbdc6f86b1b7bd856_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_1fbc593ce18940bdbdc6f86b1b7bd856.jpg"
                    },
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_7a6295db5fda4c7691fbeb05e1162526_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_7a6295db5fda4c7691fbeb05e1162526.jpg"
                    }
                ]
            },
            {
                "dispute_reason": 47,
                "dispute_requirement": "กรุณาส่งหลักฐานมาให้เราเพื่อประกอบการพิจารณาข้อพิพาท โดยสามารถดูตัวอย่างการส่งหลักฐานได้ที่นี่/Regarding to your refund request, Shopee would like to request more information as follows ;",
                "evidence_module_list": [
                    {
                        "is_required": true,
                        "module_index": 1,
                        "requirement": "รูปภาพและวิดีโอเปิดกล่องสินค้าที่ได้รับคืนทั้งหมด โดยแสดงให้เห็นใบปะหน้าพัสดุชัดเจน/ Photo(s) or Video of unboxing the returned parcel with the consignment note (Airway Bill)."
                    },
                    {
                        "is_required": true,
                        "module_index": 2,
                        "requirement": "รูปภาพและวิดีโอสินค้าที่ได้รับคืนที่เกิดความเสียหาย /Photo(s) or Video showing the damaged point(s) of returned item(s)."
                    },
                    {
                        "is_required": true,
                        "module_index": 3,
                        "requirement": "รูปภาพและวิดีโอการบรรจุสินค้าลงกล่องพัสดุก่อนนำส่ง โดยเห็นใบปะหน้าสินค้าอย่างชัดเจน/ Photo(s) or Video while packing the parcel with the consignment note (Airway Bill)."
                    },
                    {
                        "is_required": true,
                        "module_index": 4,
                        "requirement": "รูปภาพกล่องพัสดุที่ได้รับคืนทุกด้าน/ Photo(s) showing all side of the received parcel."
                    }
                ],
                "sample_evidence": [
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_2b6fc7719dce44daa2982c6444028498_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_2b6fc7719dce44daa2982c6444028498.jpg"
                    },
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_15ff73d4f4a34d6fbb2944ceb49bdd19_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_15ff73d4f4a34d6fbb2944ceb49bdd19.jpg"
                    },
                    {
                        "thumbnail": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_6c884dd6f7924b7e9f8d54a2a9d100e6_tn.jpg",
                        "type": 1,
                        "url": "https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_6c884dd6f7924b7e9f8d54a2a9d100e6.jpg"
                    }
                ]
            }
        ]
    }
}
#

§13 Error example

Error example

#

§14 JSON

JSON


{
    "error": "dispute.request.param.error",
    "message": "The return_sn you requested was not queried, please check it",
    "request_id": "openapi-c5b122da8429d8f46062e6f5543ad941"
}
#

§15 Errors

Errors

ErrorDescriptionSolution
dispute.request.param.errorCan't raise dispute because the dispute reason is empty
dispute.request.param.errordispute.request.param.error
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_shopshopid is invalid
error_paramrequest not from gateway
dispute.request.param.errorKey: 'XXX' Error:Field validation for 'XX' failed on the 'required' tag
dispute.request.param.errorThe return_sn you requested was not queried, please check it
dispute.request.param.errorreturn_sn is a required parameter
#

§16 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspendedThe API is offline. Please call v2 API instead.
error_limitThe total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§17 Update log

Update log

DateChange
2026-04-27Updated TYPE of dispute_reason from int32 to STRING based on Guanlin's feedback
2024-12-31Add new dispute_reason_list response parameter
2023-12-29New API
#