stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /order/202605/orders/blind_box_result/callback
#§2 Method: [POST]
#§3 Function Description
After the merchant completes blind box opening in a live room, use this callback to send blind box and batch box opening results for an order back to the platform. Buyers can then view the unboxing results in the order details.
§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 |
|---|---|---|---|---|
| main_order_id | string | N | 576461413038785752 | The unique identifier for a TikTok Shop order. |
| blind_box_results | []object | N | Unboxing results for line items under orders. | |
| ^order_line_id | string | N | 577086512123755123 | Line item id in TikTok Shop. |
| ^blind_result_product_id | string | N | 1732042550463074704 | Unboxing results corresponding to TikTok Shop product id. |
| ^blind_result_sku_id | string | N | 1732042694638604688 | Unboxing results corresponding to TikTok Shop sku id. |
| ^blind_open_time | int | N | 1762782183118 | Unboxing timestamp. Only UNIX format is accepted. |
| blind_batch_box_results | []object | N | Unboxing batch results for line items under orders. | |
| ^order_line_id | string | N | 577086512123755123 | Line item id in TikTok Shop. |
| ^blind_box_order_line_list | []object | N | Unboxing results for line items under orders. on batch box version | |
| ^^blind_result_product_id | string | N | 1732042550463074704 | Unboxing results corresponding to TikTok Shop product id. |
| ^^blind_result_sku_id | string | N | 1732042694638604688 | Unboxing results corresponding to TikTok Shop sku id. |
| ^^blind_open_time | int | N | 1762782183118 | Unboxing timestamp. Only UNIX format is accepted. |
| ^^product_type | string | N | NORMAL | Unboxing product type. |
| Possible values: |
NORMAL(0): A normal unboxed product.GIFT(1): A gift unboxed product. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/order/202605/orders/blind_box_result/callback?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"main_order_id":"576461413038785752","blind_box_results":[{"order_line_id":"577086512123755123","blind_result_product_id":"1732042550463074704","blind_result_sku_id":"1732042694638604688","blind_open_time":1762782183118}],"blind_batch_box_results":[{"order_line_id":"577086512123755123","blind_box_order_line_list":[{"blind_result_product_id":"1732042550463074704","blind_result_sku_id":"1732042694638604688","blind_open_time":1762782183118,"product_type":"NORMAL"}]}]}
§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 |
|---|---|
| 10007002 | Current order is not a merchant blind box order. |
| 10007006 | Invalid params, please check that all required parameters are not illegal. |
| 10007008 | The order information has not been obtained. |
| 10007109 | Order update failed, please contract platform. |
| 10007143 | The product information has not been obtained. Please confirm whether the product information is synchronized to Tiktok Shop. |
| 10007999 | System Exception, please contract platform. |