(11) Cancellation status change

POST

The cancellation status change webhook is triggered when the cancel_status of an order changes:

• An order cancellation is initiated: CANCELLATION_REQUEST_PENDING
• An order cancellation is accepted by the SELLER or SYSTEM: CANCELLATION_REQUEST_SUCCESS
• An order cancellation is closed by the BUYER or SYSTEM: CANCELLATION_REQUEST_CANCELLED
• An order cancellation is successful and a refund is issued: CANCELLATION_REQUEST_COMPLETE

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

type

required

The ID of the webhook type.

integer

Allowed value: 11

tts_notification_id

The ID of the notification.

string

shop_id

The shop ID.

string

timestamp

The Unix timestamp when the webhook was triggered.

integer format: int64

data

object

order_id

The identification of a TikTok Shop order

string

cancellations_role

The user who initiated a cancellation, with possible values:

• BUYER
• SELLER
• SYSTEM

string

Allowed values: BUYER SELLER SYSTEM

cancel_status

Order cancellation status, with possible values:

• CANCELLATION_REQUEST_PENDING
• CANCELLATION_REQUEST_SUCCESS
• CANCELLATION_REQUEST_CANCELLED
• CANCELLATION_REQUEST_COMPLETE

string

Allowed values: CANCELLATION_REQUEST_PENDING CANCELLATION_REQUEST_SUCCESS CANCELLATION_REQUEST_CANCELLED CANCELLATION_REQUEST_COMPLETE

cancel_id

The identifier of a specific order cancellation

string

create_time

The time when the buyer initiated the cancellation request, represented as a Unix timestamp (seconds).

integer format: int64

Example

{
  "type": 11,
  "tts_notification_id": "7327112393057371910",
  "shop_id": "7494049642642441621",
  "timestamp": 1644412885,
  "data": {
    "order_id": "576486316948490001",
    "cancellations_role": "BUYER",
    "cancel_status": "CANCELLATION_REQUEST_PENDING",
    "cancel_id": "4035318504086604100",
    "create_time": 1627587600
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.