(67) Refund Success

POST

Once a refund of an RMA is successfully completed.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

shop_id

TikTok Shop identifier associated with the event.

string

timestamp

The time when this webhook was triggered, represented by Unix timestamp.

integer format: int64

tts_notification_id

Unique notification identifier for deduplication and tracing.

string

type

required

The ID of the webhook type.

integer

Allowed value: 67

data

object

aftersales_request_id

Parent aftersales request identifier.

string

line_items

Line-item level identifiers included in the successful refund.

Array<object>

object

main_order_id

Main forward order identifier.

string

return_line_item_id

Return line-item identifier.

string

sku_id

SKU identifier.

string

sku_return_request_id

SKU-level return request identifier.

string

sub_return_line_item_id

Optional child line-item identifier, only applicable for Virtual Bundle returns.

string

refund_currency

Currency of the refunded amount.

string

refund_status

Refund result. Current example shows REFUND_SUCCESS.

string

refund_timestamp

Refund completion time in Unix seconds.

integer format: int64

refund_total

Total refunded amount.

string

rma_id

Associated RMA identifier.

string

Example

{
  "type": 67,
  "tts_notification_id": "7628321701399676688",
  "shop_id": "123456",
  "timestamp": 1776107052,
  "data": {
    "aftersales_request_id": "111111111",
    "line_items": [
      {
        "main_order_id": "789456123",
        "return_line_item_id": "999999",
        "sku_id": "147852",
        "sku_return_request_id": "321654987",
        "sub_return_line_item_id": "888888"
      },
      {
        "main_order_id": "789456123",
        "return_line_item_id": "999999",
        "sku_id": "147853",
        "sku_return_request_id": "321654987",
        "sub_return_line_item_id": "777777"
      },
      {
        "main_order_id": "789456123",
        "return_line_item_id": "666666",
        "sku_id": "147853",
        "sku_return_request_id": "321654987"
      }
    ],
    "refund_currency": "USD",
    "refund_status": "REFUND_SUCCESS",
    "refund_timestamp": 1776102211,
    "refund_total": "1.25",
    "rma_id": "222222222"
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.