Approve Cancellation

POST

/return_refund/202309/cancellations/{cancel_id}/approve

Use this API to approve a buyer-initiated cancellation request identified by cancel_id. Call this API only when the cancellation request is still waiting for seller action.

Authorizations

• accessToken

Parameters

Path Parameters

cancel_id

required

string

The cancellation request ID to approve. Use the cancel_id returned by Search Cancellations. Do not pass the order ID here.

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

idempotency_key

string

<= 255 characters

The idempotency key is a unique value generated by the client which the server uses to recognize a request.

If you retry the same cancellation approval request, use the same key. If this parameter is omitted, the server generates an idempotency key for the request.

You may choose your own method of creating unique keys. We suggest using UUIDs, or another random string with enough entropy, to avoid collisions.

Idempotency keys can be up to 255 characters long.

Request Body

Media typeapplication/json

object

Example

{}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

Example

{
  "code": 0,
  "data": {},
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}