v2.returns.cancel_dispute
POST /api/v2/returns/cancel_dispute
Sellers can only cancel compensation disputes, not normal disputes. This means that sellers can only cancel disputes when the return_status is ACCEPTED and the compensation_status is COMPENSATION_REQUESTED.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/returns/cancel_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 | 2412100F5217W3H | Shopee's unique serial number identifier for a Return Refund request. Note: Sellers can only cancel compensation disputes, not normal disputes. This means that sellers can only cancel disputes when the return_status is ACCEPTED and the compensation_status is COMPENSATION_REQUESTED. |
| string | True | test@example.com | The operator's email address. For operation record keeping purposes (same as v2.returns.dispute API). |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| 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. | |
| request_id | string | 33e099960cdf420393ca5d5c35016f6d | The identifier for an API request for error tracking. |
| response | object | ||
| return_sn | string | 2412100F5217W3H | Shopee's unique serial number identifier for a Return Refund request. |
| message | string | SUCCESS | To indicate whether the cancel dispute operation is successful or failed. |