v2.returns.get_return_list

GET /api/v2/returns/get_return_list

Use this api to get detail information of many return by shop id.

Endpoint URL

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

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
page_no	int64	True	1	Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call.
page_size	int64	True	10	if many items are available to retrieve, you may need to call GetReturnList multiple times to retrieve all the data. Each result set is returned as a page of entries. Default is 40. Use the Pagination filters to control the maximum number of entries (<= 100) to retrieve per page (i.e., per call), the offset number to start next call. This integer value is usUed to specify the maximum number of entries to return in a single ""page"" of data.
create_time_from	timestamp	False	1655392442	The create_time_from and create_time_to fields specify a date range for retrieving orders (based on the order create time). The create_time_from field is the starting date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days.
create_time_to	timestamp	False	1655392542	The create_time_from and create_time_to fields specify a date range for retrieving orders (based on the order create time). The create_time_from field is the starting date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days.
update_time_from	timestamp	False	1655392442	The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the last return updated time). The update_time_from field is the starting date range. The maximum date range that may be specified with the update_time_from and update_time_to fields is 15 days. update_time_from should be >= create_time_from
update_time_to	timestamp	False	1655392542	The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the last return updated time). The update_time_from field is the starting date range. The maximum date range that may be specified with the update_time_from and update_time_to fields is 15 days. update_time_from should be >= create_time_from
status	string	False	REQUESTED	This is for filtering return request by return status. See "Data Definition - ReturnStatus"
negotiation_status	string	False	TERMINATED	This is for filtering return request by counter status. See "Data Definition - NegotiationStatus"
seller_proof_status	string	False	PENDING	This is for filtering return request by proof status. See "Data Definition - SellerProofStatus"
seller_compensation_status	string	False	NOT_REQUIRED	This is for filtering return request by compensation status. See "Data Definition - SellerCompensationStatus"

Response Parameters

Name	Type	Sample	Description
request_id	string	33e099960cdf420393ca5d5c35016f6d	The identifier for an API request for error tracking
error	string		error code
message	string		error description
response	object		Amount of the refund.
more	boolean	true	Whether has next page
return	object[]
image	string[]	["https://cf.shopee.sg/file/166f23cbfb31bd882f51cfe7f90d3826"]	Image URLs of return.
reason	string	PHYSICAL_DMG	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	return reason	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	200203171852695	The serial number of return.
refund_amount	float	1409.0	Amount of the refund.
currency	string	SGD	Currency of the return.
create_time	timestamp	1580721513	The time of return create.
update_time	timestamp	1580729377	The time of modify return.
status	string	CANCELLED	Enumerated type that defines the current status of the return. Applicable values: See Data Definition- ReturnStatus.
due_date	timestamp	1580721513	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	string[]	["UNKNOWN"]	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	true	Items to be sent back to seller. Can be either integrated/non-integrated.
amount_before_discount	float	1409.0	Order price before discount.
user	object
username	string	abcdefg	Buyer's nickname, will be masked as "****" if it is a non-integrated return in TW region.
email	string	***********r1@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	0	Shopee's unique identifier for a variation of an item.
name	string	agsabdmnambd	Name of item in local language.
images	string[]	["https://cf.shopee.sg/file/166f23cbfb31bd882f51cfe7f90d3826"]	Image URLs of item.
amount	int64	1	Amount of this item.
item_price	float	1409.9	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	2147533133	The id of item.
item_sku	string	USB	The sku of item.
variation_sku	string	RED	The variation sku of item
order_sn	string	200203C6W0AR27	Shopee's unique identifier for an order.
return_ship_due_date	timestamp	1655438336	The due date for buyer to ship order.
return_seller_due_date	timestamp	1655438336	The due date for seller to deal with this return when buyer have shipped order.
negotiation_status	string	PENDING_RESPOND	Counter status. See "Data Definition - NegotiationStatus"
seller_proof_status	string	PENDING	Proof status. See "Data Definition - SellerProofStatus"
seller_compensation_status	string	PENDING_REQUEST	Compensation status. See "Data Definition - SellerCompensationStatus"
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	false	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	false	To indicate whether uploading shipping proof is mandatory for seller to confirm "Arrange Pickup" when is_seller_arrange = true.
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.