v2.returns.get_return_dispute_reason
GET /api/v2/returns/get_return_dispute_reason
To get the dispute return reason.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/returns/get_return_dispute_reason
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. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | openapi-e3e3e7f32a7c6d903377b902ac7e7a00:01000237d706e07e:0000004e4d5c1f2f | 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 | Detail informations you are querying. | |
| dispute_reason_list | object[] | The dispute_reason and associated evidence list. | |
| dispute_reason | int32 | 50 | The dispute_reason for one specific case. See Data Definition - DisputeReason. |
| dispute_requirement | string | Regarding to your refund request, Shopee would like to request more information as follows : | Indicate the importance of uploading required proof. |
| sample_evidence | object[] | The URL of sample evidence to upload. | |
| type | int32 | 1 | The type of sample evidence. Applicable value: - 1: Image |
| url | string | https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801\_e9c9e5473d3345d08671a8cc3bc1a6de.jpg | The link of sample evidence. |
| thumbnail | string | https://fileproxy.scsusercontent.com/api/v2/files/c2hvcGVlLWRyYzAx/bf10d801\_e9c9e5473d3345d08671a8cc3bc1a6de\_tn.jpg | The link of the thumbnail of sample evidence. |
| evidence_module_list | object[] | The associated evidence module list for current dispute reason. | |
| module_index | int32 | 1 | The index of current evidence module. |
| requirement | string | Photo(s) or Video of unboxing the returned parcel with the consignment note (Airway Bill). | The specific requirement of current evidence module. |
| is_required | boolean | true | Indicate if current evidence module is mandatory or not. |