stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /event/202309/webhooks
#§2 Method: [PUT]
#§3 Function Description
Updates the shop's webhook URL for a specific event topic.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| address | string | Y | https://partner.tiktokshop.com | The webhook URL used to receive the event data. |
| Max length: 255 characters | ||||
| event_type | string | Y | ORDER_STATUS_CHANGE | The topic of the webhook event. |
| Possible values: |
ORDER_STATUS_CHANGE: Triggers on each order status update, from new order placement through all subsequent status changes. See Order Status change.RECIPIENT_ADDRESS_UPDATE: Triggers when the recipient's address is updated. See Receipient address update.PACKAGE_UPDATE: Triggers when a package is updated (e.g., combined, split, or address changed). See Package update.PRODUCT_STATUS_CHANGE: Triggers when product audit results are updated. See Product status change.SELLER_DEAUTHORIZATION: Triggers when a seller is deauthorized to inform developers and avoid misunderstandings about platform authorization issues. See Seller deauthorization.UPCOMING_AUTHORIZATION_EXPIRATION: Triggers 30 days before authorization expiration, with daily notifications at 0:00 until re-authorization is completed. See Upcoming authorization expiration.CANCELLATION_STATUS_CHANGE: Triggers when an order's cancellation status changes. See Cancellation status change.RETURN_STATUS_CHANGE: Triggers when an order's return status changes. See Return status change.NEW_CONVERSATION: Triggers when a customer service agent joins or leaves a conversation. See New conversation.NEW_MESSAGE: Triggers when a new message is sent in a customer service conversation. See New Message.PRODUCT_INFORMATION_CHANGE: Triggers when changes to a product's title, description, main images, or attributes go live. See Product information change.PRODUCT_CREATION: Triggers when a new product is created. See Product creation.PRODUCT_CATEGORY_CHANGE: Triggers when the category of a product is changed. See Product category change.NEW_MESSAGE_LISTENER: Triggers when a creator sends a message to the seller. See New message listener.INVOICE_STATUS_CHANGE: Triggers when the status of an invoice upload changes after using the POST Upload Invoice endpoint. See Invoice Status Change.PRODUCT_AUDIT_STATUS_CHANGE: Triggers when the product audit status changes. See Product audit status change.REVERSE_STATUS_UPDATE: Triggers when buyer raises cancellation, refund only, or return & refund requests that need the seller to accept or reject. See Reverse Status Update. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/event/202309/webhooks?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"address":"https://partner.tiktokshop.com","event_type":"ORDER_STATUS_CHANGE"}
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information |
§9 Response Sample
{"code":0,"data":{},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|