Skip to main content

v2.returns.upload_proof

POST /api/v2/returns/upload_proof

Support sellers to upload evidence, including text and pictures and videos converted into URLs.

Endpoint URL

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

Common Request Parameters

NameTypeSampleDescription
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

Request Parameters

NameTypeRequiredSampleDescription
return_snstringTrue211019111701669The serial number of return.
photoobject[]False
urlstringTruehttps://file-proxy.seller.test.shopee.com/api/v2/files/c2hvcGVlLWRyYzAx/6cd5662c25964655827057bb2bfa69e2.pngUploaded proof image link, it is recommended to pass in the return url of api called convert_image.
thumbnailstringTruehttps://file-proxy.seller.test.shopee.com/api/v2/files/c2hvcGVlLWRyYzAx/6cd5662c25964655827057bb2bfa69e2.pngThe proof image thumbnail.
descriptionstringFalsetesttext description in the dispute proof

Response Parameters

NameTypeSampleDescription
request_idstringopenapi-a158bf23ecfa3f34a17a19ed8b12dbc9The identifier for an API request for error tracking
errorstringIndicate error code if hit error. Empty if no error happened
messagestringsuccessIndicate error details if hit error. Empty if no error happened.
responseobjectDetail informations you are querying. For this API will return null.