v2.returns.get_return_detail

GET /api/v2/returns/get_return_detail

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

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/returns/get_return_detail

Common Request 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

Request Parameters

Name	Type	Required	Sample	Description
return_sn	string	True	2206150VT13E3MQ	The serial number of return.

Response Parameters

Name	Type	Sample	Description
request_id	string	d52ca43b277a4f9292fb8be658bfd33d	The identifier for an API request for error tracking
error	string		error code
message	string		error description
response	object		Amount of the refund.
image	string[]	["https://cf.shopee.sg/file/166f23cbfb31bd882f51cfe7f90d3826"]	Image URLs of return.
buyer_videos	object[]
thumbnail_url	string	https://down-ws-sg.img.susercontent.com/sg-11110158-23040-t1taxpkdkgpvf7	The thumbnail url of video
video_url	string	https://play-ws.vod.shopee.com/api/v4/11110158/mms/sg-11110158-6jrnk-lf6a3juz7hw96f.ori.mp4	The url of video
reason	string	NOT_RECEIPT	Indicates 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.
text_reason	string	not received	Reason that buyer provide.
reassessed_request_reason	string	ITEM_MISSING	Indicates 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.
return_sn	string	2206140TA5PM808	The serial number of return.
refund_amount	float	13.97	Amount of the refund.
currency	string	SGD	Currency of the return.
create_time	timestamp	1655205084	The time of return create.
update_time	timestamp	1655219544	The time of modify return.
status	string	ACCEPTED	Enumerated type that defines the current status of the return. Applicable values: See Data Definition- ReturnStatus.
due_date	timestamp	1655377883	The last time seller deal with this return.
tracking_number	string	RNSHS00177569	The tracking number assigned by the shipping carrier for item shipment.
dispute_reason	int32	2	The reason of seller dispute return. While the return has been disputed, this field is useful. Applicable values: See Data Definition- ReturnDisputeReason.
dispute_text_reason	string	"reason"	The reason that seller provide. While the return has been disputed, this field is useful.
needs_logistics	boolean	false	Items to be sent back to seller. Can be either integrated/non-integrated.
amount_before_discount	float	13.99	Order price before discount.
user	object
username	string	gwlsg01	Buyer's nickname, will be masked as "****" if it is a non-integrated return in TW region.
email	string	********oo@shopee.com	Buyer's email, will be empty if it is a non-integrated return in TW region.
portrait	string	https://cf.shopee.sg/file/166f23cbfb31bd882f51cfe7f90d3826	Buyer's portrait, will be empty if it is a non-integrated return in TW region.
item	object[]
model_id	int64	2001586745	Shopee's unique identifier for a variation of an item.
name	string	[Self collection point] Orange macaron	Name of item in local language.
images	string[]	["https://cf.shopee.sg/file/4ecbb6fa567e42c1b1e02993ad53df12"]	Image URLs of item.
amount	int32	1	Amount of this item.
item_price	float	10.0	The price of item.
is_add_on_deal	boolean	false	To indicate if this item belongs to an addon deal.
is_main_item	boolean	false	To indicate if this item is main item or sub item. True means main item, false means sub item.
add_on_deal_id	int64	0	The unique identity of an addon deal.
item_id	int64	2700126223	The id of item.
item_sku	string	USB	The sku of item.
variation_sku	string	RED	the variation sku of item
refund_amount	float	12.34	item's refund amount. only for shops whitelisted for Partial Qty RR. If not available, refer to item_price
order_sn	string	220614T9XV8JTN	Shopee's unique identifier for an order.
return_ship_due_date	timestamp	1655438205	The due date for buyer to ship order.
return_seller_due_date	timestamp	1655438205	The due date for seller to deal with this return when buyer have shipped order.
activity	object[]
activity_id	int64	123456789	The id of activity.
activity_type	string	BUNDLE	The type of activity.
original_price	string	12.34	activity's origin price
discounted_price	string	12.34	activity's discount price
items	object[]
item_id	int64	12345678	The id of item.
variation_id	int64	12345678	Shopee's unique identifier for a variation of an item.
quantity_purchased	int64	2	item's quantity purchase
original_price	string	12.34	item's origin price
refund_amount	float	12.34	item's refund amount for bundle deal cases, only for shops whitelisted for Partial Qty RR.
seller_proof	object
seller_proof_status	string	PENDING	To 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.
seller_evidence_deadline	timestamp	1655438336	To indicate the deadline for submitting the evidence.
seller_compensation	object
seller_compensation_status	string	PENDING_REQUEST	To indicate whether the seller is eligible for raising a compensation request. See "Data Definition - SellerCompensationStatus"
seller_compensation_due_date	timestamp	1655438336	To indicate the deadline for requesting the compensation
compensation_amount	float	100.0	To indicate the compensation amount that the agent decided
negotiation	object
negotiation_status	string	PENDING_RESPOND	To indicate whether the seller can negotiate with the buyer. See "Data Definition - NegotiationStatus"
latest_solution	string	RETURN_REFUND	To indicate what is the offer solution. See "Data Definition - ReturnSolution"
latest_offer_amount	float	12.34	To indicate the refund amount in the latest offer solution
latest_offer_creator	string	username	To indicate which party made the latest offer
counter_limit	int32	0	To indicate the remaining counter limit
offer_due_date	timestamp	1655438336	To indicate offer_due_date
logistics_status	string	LOGISTICS_REQUEST_CREATED	To 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.
reverse_logistic_status	string	LOGISTICS_REQUEST_CREATED	To 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.
return_pickup_address	object		To indicate the buyer's pickup address
address	string	BLOCK 106, HENDERSON CRESCENT	To indicate receiver's address
name	string	name	To indicate receiver's name
phone	string	6512345678	To indicate receiver's phone [Only for TW non-integrated channel] Will return "****" when the "virtual_contact_number" is available
town	string	Batino	To indicate receiver's town
district	string	Calamba City	To indicate receiver's district
city	string	Laguna	To indicate receiver's city
state	string	South Luzon	To indicate receiver's state
region	string	SG	To indicate receiver's region
zipcode	string	150106	To indicate receiver's zip code
virtual_contact_number	string	0928000886	[Only for TW non-integrated channel] The virtual phone number to contact the recipient.
package_query_number	string	66668888	[Only for TW non-integrated channel] The query number used in virtual phone number calls to contact the recipient of this return.
return_address	object
whs_id	string	SGC	To 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.
return_refund_type	string	RRAOC	To indicate whether the return is RRBOC (Return/Refund request raised before Order Complete) or RRAOC (Return/Refund request raised after Order Complete).
return_solution	int32	0	To 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
is_seller_arrange	boolean	true	To indicate whether the return_sn is using the “Seller Arrange” return method. This would only be True for TW and BR.
is_shipping_proof_mandatory	boolean	true	To indicate whether uploading shipping proof is mandatory for seller to confirm "Arrange Pickup" when is_seller_arrange = true.
has_uploaded_shipping_proof	boolean	false	To indicate whether seller has already uploaded shipping proof for this return.
is_reverse_logistics_channel_integrated	boolean	false	To indicate whether the reverse logistic channel type selected is integrated or non-integrated.
reverse_logistic_channel_name	string	test_reverse_logistic_channel_name	To indicate reverse logistic carrier name.
return_refund_request_type	int32	0	To 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.
validation_type	string	seller_validation	To 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.
is_arrived_at_warehouse	int32	3	[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
follow_up_action_list	object[]		[Only for validation_type = warehouse_validation] Warehouse handling actions for each item in the parcel.
item_id	int64	2700126223	Unique identifier of the item.
model_id	int64	2000458802	Unique identifier of the model under the item.
qty	int32	2	Quantity of items or models under the same current status.
current_status	int32	2	Current 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
related_order_sn_list	string[]	[]	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.
resell_failed_next_step	string	""	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.