v2.returns.offer｜快工助手

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

来自 Shopee 官方资料快照 · 2026-09-06 12:15:11

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.returns.offer

v2.returns.offer

§2 Overview

Overview

Field	Value
Module	Returns
API type	Shop
HTTP method	POST
Path	/api/v2/returns/offer
Production URL	https://partner.shopeemobile.com/api/v2/returns/offer
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/returns/offer
Rate limit	[0, 0, 0]
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	211101140608253	The serial number of return.
proposed_solution	string	Yes	RETURN_REFUND	The new solution to be offered. See "Data Definition - ReturnSolution"
proposed_adjusted_refund_amount	float	No	100.0	The new refund amount to be offered

§4 Response parameters

Response parameters

Name	Type	Sample	Description
request_id	string	772aff4cd09f4f649e32efa36d4546fd	The identifier for an API request for error tracking
error	string		The error code
message	string		The error description
response	object
response.return_sn	string	211101140608253	The serial number of return.

§5 Common parameters

Common parameters

Name	Type	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": "211101140608253",
	"proposed_solution": "RETURN_REFUND",
	"proposed_adjusted_refund_amount": 100
}

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/returns/offer?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"proposed_adjusted_refund_amount\": 100,
   \"proposed_solution\": \"RETURN_REFUND\",
   \"return_sn\": \"211101140608253\"
}")
.asString();

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/returns/offer?access_token=access_token&partner_id=partner_id&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 => 'POST',
  CURLOPT_POSTFIELDS => '{
    "proposed_adjusted_refund_amount": 100,
    "proposed_solution": "RETURN_REFUND",
    "return_sn": "211101140608253"
}',
  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/offer?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "proposed_adjusted_refund_amount": 100,
   "proposed_solution": "RETURN_REFUND",
   "return_sn": "211101140608253"
}'

§11 Python

Python

import requests
import json

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

payload=json.dumps({
  "proposed_adjusted_refund_amount": 100,
  "proposed_solution": "RETURN_REFUND",
  "return_sn": "211101140608253"
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.request("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§12 Response sample

Response sample

§13 JSON

JSON

{
	"request_id": "772aff4cd09f4f649e32efa36d4546fd",
	"error": " ",
	"message": " ",
	"response": {
		"return_sn": "211101140608253"
	}
}

§14 Error example

Error example

§15 JSON

JSON

{
    "error": "error_data",
    "message": "The return you queried doesn't exist",
    "request_id": "6f1c4c742d17f8069d1a0bfde06e206f"
}

§16 Errors

Errors

Error	Description	Solution
err_data	Cannot accept your own offer.
error_param	All images download fail
error_ongoing_dispute	cannot offer refund to buyer when return has ongoing dispute
error_data	Something wrong. Please try later. [20]
error_network	Inner http call failed
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_data	Query offer info failed. Please try later.
error_data	Query proof info failed. Please try later.
error_data	Query return info failed. Please try later.
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_data	The return case is missing initial evidence from the buyer and will be auto-cancelled if the buyer does not provide evidence by the due date.
error_negotiation_status	The negotiation status cannot support this action
error_param	request not from gateway
error_data	Type of return does not allow seller to offer refund
error_data	Invalid return status: {status}
error_data	Shopee is reviewing the case and will get back to you.
error_param	This proposed solution is not one of the available solutions for this return.
error_param	The proposed adjusted refund amount can not be lower than min refund amount
error_param	Please fill a value for proposed adjusted refund amount
error_param	The proposed adjusted refund amount can not exceed max refund amount
error_param	The proposed adjusted refund amount must be positive
error_param	The proposed adjusted refund amount only accepts {digit} digit(s) after decimal point
error_param	The proposed solution cannot have adjusted refund amount
error_return_status	The return status cannot support this action
error_data	Shopee is reviewing the case and will get back to you.

§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
2022-02-23	New API

这条内容对你有帮助吗？