stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.returns.upload_shipping_proof
Use this API to upload shipping proof (Only for TW and BR returns with is_seller_arrange = true). This is not to upload evidence for disputes.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Returns |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/returns/upload_shipping_proof |
| Production URL | https://partner.shopeemobile.com/api/v2/returns/upload_shipping_proof |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/returns/upload_shipping_proof |
| Permission | ERP System; Seller In House System; Customer Service; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| return_sn | string | Yes | The serial number of return. | |
| reverse_logistics_carrier_id | int64 | Yes | Unique ID of non-integrated reverse logistics channel used by seller. | |
| reverse_logistics_carrier_name | string | No | Non-integrated reverse logistics channel name used by seller. | |
| tracking_number | string | No | Tracking number used in seller arrange. Required when is_tracking_number_required = true in v2.returns.get_shipping_carrier. | |
| image_id_list | object[] | No | List of image_id of shipping proof image. Required when is_shipping_image_file_mandatory = true in v2.returns.get_shipping_carrier. Max: 3.; You can call the v2.media.upload_image to upload image and get the image_id, for this scenario, please pass the business = 2 and scene = 1. | |
| image_id_list.image_id | string | No | Unique image_id. | |
| remarks | string | No | Optional remarks |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | Indicate error code if hit error. Empty if no error happened. | ||
| message | string | Indicate error details if hit error. If success, return success | ||
| request_id | string | 200203171852695 | The identifier for an API request for error tracking | |
| response | object | Detail informations you are querying. For this API will return null. |
§5 Common parameters
Common parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. | |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. | |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. | |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature 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 Payload
Payload
{
"return_sn": "-",
"reverse_logistics_carrier_id": 0,
"reverse_logistics_carrier_name": "-",
"tracking_number": "-",
"image_id_list": [
{
"image_id": "-"
}
],
"remarks": "-"
}
§8 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/returns/upload_shipping_proof?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp")
.header("Content-Type","application/json")
.body("{
\"image_id_list\": [
{
\"image_id\": \"-\"
}
],
\"remarks\": \"-\",
\"return_sn\": \"-\",
\"reverse_logistics_carrier_id\": 0,
\"reverse_logistics_carrier_name\": \"-\",
\"tracking_number\": \"-\"
}")
.asString();
§9 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/returns/upload_shipping_proof?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=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 => 'POST',
CURLOPT_POSTFIELDS => '{
"image_id_list": [
{
"image_id": "-"
}
],
"remarks": "-",
"return_sn": "-",
"reverse_logistics_carrier_id": 0,
"reverse_logistics_carrier_name": "-",
"tracking_number": "-"
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§10 cURL
cURL
curl --location --request POST 'https://partner.shopeemobile.com/api/v2/returns/upload_shipping_proof?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
"image_id_list": [
{
"image_id": "-"
}
],
"remarks": "-",
"return_sn": "-",
"reverse_logistics_carrier_id": 0,
"reverse_logistics_carrier_name": "-",
"tracking_number": "-"
}'
§11 Python
Python
import requests
import json
url = "https://partner.shopeemobile.com/api/v2/returns/upload_shipping_proof?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp"
payload=json.dumps({
"image_id_list": [
{
"image_id": "-"
}
],
"remarks": "-",
"return_sn": "-",
"reverse_logistics_carrier_id": 0,
"reverse_logistics_carrier_name": "-",
"tracking_number": "-"
})
headers = {
'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§12 Response sample
Response sample
§13 JSON
JSON
{
"error": "",
"message": "",
"request_id": "200203171852695",
"response": {}
}
§14 Error example
Error example
§15 JSON
JSON
{
"error": "returns.missing_tracking_no",
"message": "Tracking Number is a required parameter",
"request_id": "e3e3e7f33de01a208d40117ca55aa301"
}
§16 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| returns.error_blank_tracking_no | Tracking Number field cannot be blank | |
| returns.exceed_shipping_proof | Shipping Proof have already been uploaded | |
| returns.error_filenumber | Number of image files exceeds three. Please only upload max three image files | |
| returns.error_tracking_no_length | Tracking number should be 5-30 characters | |
| returns.invalid_carrier_id | Reverse Logistics carrier ID is invalid | |
| returns.invalid_image_id | Provided image ID is invalid | |
| returns.invalid_tracking_no | Tracking Number is invalid | |
| returns.missing_carrier_name | Reverse Logistics carrier name is a required parameter | |
| returns.missing_image | Shipping Proof image is a required parameter | |
| returns.new_seller_arrange_flow_disabled | New seller arrange flow is not enabled | |
| returns.error_tracking_no_alphanumeric | Tracking number should not contain special characters; for eg. !; @; $; %; &; * | |
| returns.return_not_found | Return not found | |
| returns.missing_return_sn | Return SN is a required parameter | |
| returns.missing_carrier_id | Reverse Logistics carrier ID is a required parameter | |
| returns.missing_tracking_no | Tracking Number is a required parameter |
§17 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App 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_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The 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_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The 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_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your 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_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
§18 Update log
Update log
| Date | Change |
|---|---|
| 2025-09-19 | New API |
