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

v2.returns.get_return_detail

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_detail

Use this api to get detail information of a return by return sn.

#

§2 Overview

Overview

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

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
return_snstringYes2206150VT13E3MQThe serial number of return.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
request_idstringd52ca43b277a4f9292fb8be658bfd33dThe identifier for an API request for error tracking
errorstringerror code
messagestringerror description
responseobjectAmount of the refund.
response.imagestring[]["https://cf.shopee.sg/file/166f23cbfb31bd882f51cfe7f90d3826"]Image URLs of return.
response.buyer_videosobject[]
response.buyer_videos.thumbnail_urlstringhttps://down-ws-sg.img.susercontent.com/sg-11110158-23040-t1taxpkdkgpvf7The thumbnail url of video
response.buyer_videos.video_urlstringhttps://play-ws.vod.shopee.com/api/v4/11110158/mms/sg-11110158-6jrnk-lf6a3juz7hw96f.ori.mp4The url of video
response.reasonstringNOT_RECEIPTIndicates the original return reason submitted by the buyer when initiating the return request.; Applicable values: See Data Definition- ReturnReason and Reassessed Request Reason.; Note: There may be cases where Shopee Agent updates the return request with a "Reassessed Return Reason" after reviewing more details about the buyer's return request and potentially after requesting evidence from the seller. If the platform updates the return reason during this process, the reassessed outcome will be provided separately in the reassessed_request_reason field.
response.text_reasonstringnot receivedReason that buyer provide.
response.reassessed_request_reasonstringITEM_MISSINGIndicates the return reason reassessed by the platform as more suitable.; There may be cases where Shopee Agent updates the return request with a "Reassessed Return Reason" after reviewing more details about the buyer's return request and potentially after requesting evidence from the seller.; Applicable values: See Data Definition- ReturnReason and Reassessed Request Reason. If no reassessment has been made, the value will be NONE.
response.return_snstring2206140TA5PM808The serial number of return.
response.refund_amountfloat13.97Amount of the refund.
response.currencystringSGDCurrency of the return.
response.create_timetimestamp1655205084The time of return create.
response.update_timetimestamp1655219544The time of modify return.
response.statusstringACCEPTEDEnumerated type that defines the current status of the return. Applicable values: See Data Definition- ReturnStatus.
response.due_datetimestamp1655377883The last time seller deal with this return.
response.tracking_numberstringRNSHS00177569The tracking number assigned by the shipping carrier for item shipment.
response.dispute_reasonstring[]["dispute_reason_1", "dispute_reason_2"]The reason of seller dispute return. While the return has been disputed, this field is useful. Applicable values: See Data Definition- ReturnDisputeReason.
response.dispute_text_reasonstring[]["dispute_remarks"]The reason that seller provide. While the return has been disputed, this field is useful.
response.needs_logisticsbooleanfalseItems to be sent back to seller. Can be either integrated/non-integrated.
response.amount_before_discountfloat13.99Order price before discount.
response.userobject
response.user.usernamestringgwlsg01Buyer's nickname, will be masked as "****" if it is a non-integrated return in TW region.
response.user.emailstring********oo@shopee.comBuyer's email, will be empty if it is a non-integrated return in TW region.
response.user.portraitstringhttps://cf.shopee.sg/file/166f23cbfb31bd882f51cfe7f90d3826Buyer's portrait, will be empty if it is a non-integrated return in TW region.
response.itemobject[]
response.item.model_idint642001586745Shopee's unique identifier for a variation of an item.
response.item.namestring[Self collection point] Orange macaronName of item in local language.
response.item.imagesstring[]["https://cf.shopee.sg/file/4ecbb6fa567e42c1b1e02993ad53df12"]Image URLs of item.
response.item.amountint321Amount of this item.
response.item.item_pricefloat10.0The price of item.
response.item.is_add_on_dealbooleanfalseTo indicate if this item belongs to an addon deal.
response.item.is_main_itembooleanfalseTo indicate if this item is main item or sub item. True means main item, false means sub item.
response.item.add_on_deal_idint640The unique identity of an addon deal.
response.item.item_idint642700126223The id of item.
response.item.item_skustringUSBThe sku of item.
response.item.variation_skustringREDthe variation sku of item
response.item.refund_amountfloat12.34item's refund amount. only for shops whitelisted for Partial Qty RR.; If not available, refer to item_price
response.order_snstring220614T9XV8JTNShopee's unique identifier for an order.
response.return_ship_due_datetimestamp1655438205The due date for buyer to ship order.
response.return_seller_due_datetimestamp1655438205The due date for seller to deal with this return when buyer have shipped order.
response.activityobject[]
response.activity.activity_iduint64123456789The id of activity.
response.activity.activity_typestringBUNDLEThe type of activity.
response.activity.original_pricestring12.34activity's origin price
response.activity.discounted_pricestring12.34activity's discount price
response.activity.itemsobject[]
response.activity.items.item_idint6412345678The id of item.
response.activity.items.variation_idint6412345678Shopee's unique identifier for a variation of an item.
response.activity.items.quantity_purchasedint642item's quantity purchase
response.activity.items.original_pricestring12.34item's origin price
response.activity.refund_amountstring"12.34"item's refund amount for bundle deal cases, only for shops whitelisted for Partial Qty RR.
response.seller_proofobject
response.seller_proof.seller_proof_statusstringPENDINGTo indicate whether the seller needs to provide evidence when the return status is RETURN_JUDING, RETURN_SELLER_DISPUTE and RETURN_ACCEPTED. Applicable values: See Data Definition- SellerProofStatus.
response.seller_proof.seller_evidence_deadlinetimestamp1655438336To indicate the deadline for submitting the evidence.
response.seller_compensationobject
response.seller_compensation.seller_compensation_statusstringPENDING_REQUESTTo indicate whether the seller is eligible for raising a compensation request. See "Data Definition - SellerCompensationStatus"
response.seller_compensation.seller_compensation_due_datetimestamp1655438336To indicate the deadline for requesting the compensation
response.seller_compensation.compensation_amountfloat100.0To indicate the compensation amount that the agent decided
response.seller_compensation.compensation_amount_listobject
response.seller_compensation.compensation_amount_list.compensation_typestringLOGISTICS_RELATED_COMPENSATIONTo indicate the type of return-related compensation; Applicable values: See Data Definition - Compensation Type
response.seller_compensation.compensation_amount_list.compensation_amountfloat100.0
response.negotiationobject
response.negotiation.negotiation_statusstringPENDING_RESPONDTo indicate whether the seller can negotiate with the buyer. See "Data Definition - NegotiationStatus"
response.negotiation.latest_solutionstringRETURN_REFUNDTo indicate what is the offer solution. See "Data Definition - ReturnSolution"
response.negotiation.latest_offer_amountfloat12.34To indicate the refund amount in the latest offer solution
response.negotiation.latest_offer_creatorstringusernameTo indicate which party made the latest offer
response.negotiation.counter_limitint320To indicate the remaining counter limit
response.negotiation.offer_due_datetimestamp1655438336To indicate offer_due_date
response.logistics_statusstringLOGISTICS_REQUEST_CREATEDTo indicate the reverse logistics status. See "Data Definition - LogisticsStatus".; Note: - This is a legacy field that only reflects the reverse logistics status of Normal RR. To determine whether the RR is a Normal RR, check if return_refund_request_type = 0.; - If you need the reverse logistics status for Normal RR, In-transit RR, or Return-on-the-Spot, please use the newly released field reverse_logistic_status instead.
response.reverse_logistics_statusstringLOGISTICS_REQUEST_CREATEDTo 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.
response.return_pickup_addressobjectTo indicate the buyer's pickup address
response.return_pickup_address.addressstringBLOCK 106, HENDERSON CRESCENTTo indicate receiver's address
response.return_pickup_address.namestringnameTo indicate receiver's name
response.return_pickup_address.phonestring6512345678To indicate receiver's phone [Only for TW non-integrated channel] Will return "****" when the "virtual_contact_number" is available
response.return_pickup_address.townstringBatinoTo indicate receiver's town
response.return_pickup_address.districtstringCalamba CityTo indicate receiver's district
response.return_pickup_address.citystringLagunaTo indicate receiver's city
response.return_pickup_address.statestringSouth LuzonTo indicate receiver's state
response.return_pickup_address.regionstringSGTo indicate receiver's region
response.return_pickup_address.zipcodestring150106To indicate receiver's zip code
response.virtual_contact_numberstring0928000886[Only for TW non-integrated channel] The virtual phone number to contact the recipient.
response.package_query_numberstring66668888[Only for TW non-integrated channel] The query number used in virtual phone number calls to contact the recipient of this return.
response.return_addressobject
response.return_address.whs_idstringSGCTo indicate the warehouse id where item will be returned to.; Please call v2.shop.get_warehouse_detail to check the detailed warehouse information the item returned to with the field "location_id" of the v2.shop.get_warehouse_detail match to the field"whs_id"of the v2.return.get_return_detail.; For fulfillment by Shopee (FBS) & multi warehouse sellers, R/R orders will be returned back to the nearest warehouse of buyer address instead of going back to only 1 default return address like a normal seller.If it's a normal seller, then the field will be response empty.
response.return_refund_typestringRRAOCTo indicate whether the return is RRBOC (Return/Refund request raised before Order Complete) or RRAOC (Return/Refund request raised after Order Complete).
response.return_solutionint320To indicate the most updated solution of the Return/Refund request (NOTE: this is not the solution during negotiation). Applicable value: - 0: Return and Refund; - 1: Refund Only
response.is_seller_arrangebooleantrueTo indicate whether the return_sn is using the “Seller Arrange” return method. This would only be True for TW and BR.
response.is_shipping_proof_mandatorybooleantrueTo indicate whether uploading shipping proof is mandatory for seller to confirm "Arrange Pickup" when is_seller_arrange = true.
response.has_uploaded_shipping_proofbooleanfalseTo indicate whether seller has already uploaded shipping proof for this return.
response.is_reverse_logistics_channel_integratedbooleanfalseTo indicate whether the reverse logistic channel type selected is integrated or non-integrated.
response.reverse_logistics_channel_namestringtest_reverse_logistics_channel_nameTo indicate reverse logistic carrier name.
response.return_refund_request_typeint320To 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.
response.validation_typestringseller_validationTo indicate whether seller or warehouse will expect to receive the return parcel from buyer and validate the condition of the parcel: - seller_validation; - warehouse_validation; For more details, see Data Definition- ValidationType.
response.is_arrived_at_warehouseint323[Only for validation_type = warehouse_validation] Indicates the parcel’s check-in status at the warehouse. This field helps sellers quickly determine whether the parcel has arrived at the warehouse or has been rejected.; Applicable values: 1: Pending Inbound; 2: Rejected; 3: Inbound; 4: Cancelled
response.follow_up_action_listobject[][Only for validation_type = warehouse_validation] Warehouse handling actions for each item in the parcel.
response.follow_up_action_list.item_idint642700126223Unique identifier of the item.
response.follow_up_action_list.model_idint642000458802Unique identifier of the model under the item.
response.follow_up_action_list.qtyint322Quantity of items or models under the same current status.
response.follow_up_action_list.current_statusint322Current status for the item/model within the warehouse.; Applicable values: 1:Dispose; 2:Return to Seller; 7:Received and Putaway; 8:Return to Buyer; 9:Shortage; Note: Since Resell is currently applicable only to Failed Delivery parcels, the following values will not be returned for now, and will be returned once Resell becomes applicable to Return Refund parcels in the future: 3:Putaway for Resell; 4:Resell Outbound; 5:Resell Failed; 6:Resell Exit
response.follow_up_action_list.related_order_sn_liststring[][]List of order_sn generated from the Resell process. Returned only when current_status = 4 (Resell Outbound).; Note: Since Resell is currently applicable only to Failed Delivery parcels, this field will remain empty for now, and valid values will be returned once Resell becomes applicable to Return Refund parcels in the future.
response.follow_up_action_list.resell_failed_next_stepstring""Next step after a Resell failure. Returned only when current_status = 5 (Resell Failed).; Note: Since Resell is currently applicable only to Failed Delivery parcels, this field will remain empty for now, and valid values will be returned once Resell becomes applicable to Return Refund parcels in the future.
response.is_partial_quantity_returnbooleantrueTo indicate whether the return includes items with partial quantities.
response.is_refund_amount_adjustedbooleantrueTo indicate whether the actual refund amount is less than the maximum allowable refund.
#

§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_detail?access_token=access_token&partner_id=partner_id&return_sn=2206150VT13E3MQ&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_detail?access_token=access_token&partner_id=partner_id&return_sn=2206150VT13E3MQ&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_detail?access_token=access_token&partner_id=partner_id&return_sn=2206150VT13E3MQ&shop_id=shop_id&sign=sign&timestamp=timestamp' 
#

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/returns/get_return_detail?access_token=access_token&partner_id=partner_id&return_sn=2206150VT13E3MQ&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

{
	"request_id": "d52ca43b277a4f9292fb8be658bfd33d",
	"error": "-",
	"message": "-",
	"response": {
		"image": [
			"https://cf.shopee.sg/file/166f23cbfb31bd882f51cfe7f90d3826"
		],
		"buyer_videos": [
			{
				"thumbnail_url": "https://down-ws-sg.img.susercontent.com/sg-11110158-23040-t1taxpkdkgpvf7",
				"video_url": "https://play-ws.vod.shopee.com/api/v4/11110158/mms/sg-11110158-6jrnk-lf6a3juz7hw96f.ori.mp4"
			}
		],
		"reason": "NOT_RECEIPT",
		"text_reason": "not received",
		"return_sn": "2206140TA5PM808",
		"refund_amount": 13.97,
		"currency": "SGD",
		"create_time": 1655205084,
		"update_time": 1655219544,
		"status": "ACCEPTED",
		"due_date": 1655377883,
		"tracking_number": "RNSHS00177569",
		"dispute_reason": 2,
		"dispute_text_reason": "\"reason\"",
		"needs_logistics": false,
		"amount_before_discount": 13.99,
		"user": {
			"username": "gwlsg01",
			"email": "********oo@shopee.com",
			"portrait": "https://cf.shopee.sg/file/166f23cbfb31bd882f51cfe7f90d3826"
		},
		"item": [
			{
				"model_id": 2001586745,
				"name": "[Self collection point] Orange macaron",
				"images": [
					"https://cf.shopee.sg/file/4ecbb6fa567e42c1b1e02993ad53df12"
				],
				"amount": 1,
				"item_price": 10,
				"is_add_on_deal": false,
				"is_main_item": false,
				"add_on_deal_id": 0,
				"item_id": 2700126223,
				"item_sku": "USB",
				"variation_sku": "RED",
				"refund_amount": 12.34
			}
		],
		"order_sn": "220614T9XV8JTN",
		"return_ship_due_date": 1655438205,
		"return_seller_due_date": 1655438205,
		"activity": [
			{
				"activity_id": 123456789,
				"activity_type": "BUNDLE",
				"original_price": "12.34",
				"discounted_price": "12.34",
				"items": [
					{
						"item_id": 12345678,
						"variation_id": 12345678,
						"quantity_purchased": 2,
						"original_price": "12.34"
					}
				],
				"refund_amount": 12.34
			}
		],
		"seller_proof": {
			"seller_proof_status": "PENDING",
			"seller_evidence_deadline": 1655438336
		},
		"seller_compensation": {
			"seller_compensation_status": "PENDING_REQUEST",
			"seller_compensation_due_date": 1655438336,
			"compensation_amount": 100
		},
		"negotiation": {
			"negotiation_status": "PENDING_RESPOND",
			"latest_solution": "RETURN_REFUND",
			"latest_offer_amount": 12.34,
			"latest_offer_creator": "username",
			"counter_limit": 0,
			"offer_due_date": 1655438336
		},
		"logistics_status": "LOGISTICS_REQUEST_CREATED",
		"reverse_logistic_status": "LOGISTICS_REQUEST_CREATED",
		"return_pickup_address": {
			"address": "BLOCK 106, HENDERSON CRESCENT",
			"name": "name",
			"phone": "6512345678",
			"town": "Batino",
			"district": "Calamba City",
			"city": "Laguna",
			"state": "South Luzon",
			"region": "SG",
			"zipcode": "150106"
		},
		"virtual_contact_number": "0928000886",
		"package_query_number": "66668888",
		"return_address": {
			"whs_id": "SGC"
		},
		"return_refund_type": "RRAOC",
		"return_solution": 0,
		"is_seller_arrange": true,
		"is_shipping_proof_mandatory": true,
		"has_uploaded_shipping_proof": false,
		"is_reverse_logistics_channel_integrated": false,
		"reverse_logistic_channel_name": "test_reverse_logistic_channel_name",
		"return_refund_request_type": 0,
		"validation_type": "seller_validation",
		"is_arrived_at_warehouse": 3,
		"follow_up_action_list": [
			{
				"item_id": 2700126223,
				"model_id": 2000458802,
				"qty": 2,
				"current_status": 2,
				"related_order_sn_list": [],
				"resell_failed_next_step": ""
			}
		]
	}
}
#

§13 Error example

Error example

#

§14 JSON

JSON

{
	"request_id": "369807d9111b2b3a70d4e838e827b048",
	"error": "error_auth",
	"message": "Invalid access_token."
}
#

§15 Errors

Errors

ErrorDescriptionSolution
error_bannedCore server error.
error_permCore server error.
error_paramCore server error.
error_paramCore server error.
error_paramCore server error.
error_limitCore server error.
error_deletedCore server error.
error_disabledCore server error.
error_paramCore server error.
error_exceptionCore server error.
error_existCore server error.
error_expireCore server error.
error_fraudCore server error.
error_limitCore server error.
error_permCore server error.
error_invitationCore server error.
error_paramCore server error.
error_paramCore server error.
error_lockedCore server error.
error_permCore server error.
error_need_voice_otpCore server error.
error_paramCore server error.
error_need_otpCore server error.
error_message_censoredCore server error.
error_networkCore server error.
error_not_existsCore server error.
error_not_loginCore server error.
error_out_stockmCore server error.
error_param_formatCore server error.
error_password_changeCore server error.
error_permCore server error.
error_paramCore server error.
error_paramCore server error.
error_paramCore server error.
error_paramCore server error.
error_limitCore server error.
error_unknownCore server error.
error_accountCore server error.
error_versionCore server error.
error_perminvalid dispute_reason.
error_paramno partner_id
error_datalack of param
error_permthere is invalid params.
error_dataSomething wrong. Please try later. [20]
error_networkInner http call failed
error_networkInner error, please try later. [4].
error_innerInner error, please try later. [0].
error_dataInner error, please try later. [5].
error_dataparse data failed
error_datadata not exist
error_dataThe return detail is not available.
error_paramparameter invalid
error_paramInner error, please try later. [1].
error_dataQuery offer info failed. Please try later.
error_dataQuery order info failed. Please try later.
error_dataQuery proof info failed. Please try later.
error_dataQuery return info failed. Please try later.
error_dataQuery shop info failed. Please try later.
error_dataGet user info failed. Please try later.
error_dataQuery contact info failed. Please try later.
error_perminvalid email : {email}.
error_paramReturn SN or ID is 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
error_dataThe return you queried doesn't exist.
error_permissionYou don't have permission to view this return data.
error_permissionPlease link shop and partner on seller center.
#

§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-07-31promotion_id type change to uint64
2025-12-19Add reassessed_request_reason response field
2025-11-28Add is_arrived_at_warehouse and follow_up_action_list response fields
2025-11-11Added reverse_logistic_status response field
2025-09-29Add return_refund_request_type and validation_type response fields
#