v2.returns.dispute

POST /api/v2/returns/dispute

Dispute return. Support to raise dispute when return_status in REQUESTED / PROCESSING/ACCEPTED

Endpoint URL

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

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	24112301K66SQXM	The serial number of return.
email	string	True	test@example.com	The email address.
dispute_reason_id	int32	True	50	The dispute reason id. Please call v2.returns.get_return_dispute_reason to get it.
image_list	object[]	False		Determines whether image submission is mandatory for the dispute request - mandatory input field for all dispute reasons except "Did not receive the return product".
module_index	int32	True	1	The module_index of current evidence module returned by get_return_dispute_reason API.
requirement	string	True	Photo(s) or Video of unboxing the returned parcel with the consignment note (Airway Bill).	The requirement content of current evidence module returned by get_return_dispute_reason API.
image_url	string[]	True	["https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_e9c9e5473d3345d08671a8cc3bc1a6de.jpg","https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801_1733e9f051994b56ae748d4ebd40d0ee.jpg"]	The image URLs of current evidence module. It is recommended to pass in the URL returned by convert_image API.
dispute_text_reason	string	False	Received return item(s), buyer's claim incorrect	The content of dispute reason.

Response Parameters

Name	Type	Sample	Description
request_id	string	openapi-e3e3e7f3291217bb0b0d5a1ffe501701:0100027ec9bf2af2:00000016da662a54	The identifier for an API request for error tracking.
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
response	object
return_sn	string	200203171852695	The serial number of return.
msg	string	dispute return success