Skip to main content

(67) Refund Success

Use this webhook to identify successful refund completion and the exact refunded line-item references.

1. Trigger scenario

Once a refund of an RMA is successfully completed.

2. Data business parameters

PropertiesTypeExampleDescription
shop_idString7494049642642441621TikTok Shop identifier associated with the event.
timestampInt1732526400The time when this webhook was triggered, represented by Unix timestamp.
tts_notification_idString7327112393057371910Unique notification identifier for deduplication and tracing.
typeInt67Numeric webhook event type.
dataObject
└ aftersales_request_idString576486316948490001Parent aftersales request identifier.
└ line_items[]objectLine-item level identifiers included in the successful refund.
└└ main_order_idString576486316948490003Main forward order identifier.
└└ return_line_item_idString4035312491762651201Return line-item identifier.
└└ sku_idString1732309230575784932SKU identifier.
└└ sku_return_request_idString4035312491762585666SKU-level return request identifier.
└└ sub_return_line_item_idString4035312491762651202Optional child line-item identifier, only applicable for Virtual Bundle returns.
└ refund_currencyStringUSDCurrency of the refunded amount.
└ refund_statusStringREFUND_SUCCESSRefund result. Current example shows REFUND_SUCCESS.
└ refund_timestampInt1776102211Refund completion time in Unix seconds.
└ refund_totalString1.25Total refunded amount.
└ rma_idString576486316948490002Associated RMA identifier.

Event example

JSONWord Wrap

{
"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"
}
}