stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202601/redeem_info/callback
#§2 Method: [POST]
#§3 Function Description
Send the redeem info related to the order to the TTS to complete the fulfillment.
§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 |
|---|---|---|---|---|
| order_id | string | Y | 576461413038785752 | TikTok Shop order ID. |
| order_info_list | []object | Y | Order lines that need to send redeem info related to the order id. | |
| ^order_line_id | string | Y | 577086512123755123 | The unique identifier of the order line item. |
| ^redeem_info | object | Y | The redemption information generated by your system for this order line item. | |
| ^^redeem_type | string | Y | CODE | What redeem type that you callback. |
| 'CODE' - type code | ||||
| 'URL' - type url | ||||
| 'CODE_PIN' - type pin and code | ||||
| ^^redeem_data | string | N | abc12344 | Set the redeem data to this field with the maximum number of characters 1200. The example of each type is shown below, |
| CODE: abc12344 | ||||
| URL: https://{your_domain}/abc | ||||
| CODE_PIN(json format): | ||||
| {"type": "CODE_PIN","code": "12345","pin": "abc"} | ||||
| ^^redeem_instruction_info | string | N | {"instruction_url": "{your_instruction_website}"} | Additional redemption instruction in JSON format. Use instruction_url to specify a third-party website where the buyer completes redemption. This URL is included as a clickable link in the fulfillment email. |
| Example: {"instruction_url": "https://example.com/redeem"} | ||||
| ^source_unique_id | string | N | 134448484339393 | Optional, a unique id related to the order line in the caller system |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202601/redeem_info/callback?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"order_id":"576461413038785752","order_info_list":[{"order_line_id":"577086512123755123","redeem_info":{"redeem_type":"CODE","redeem_data":"abc12344","redeem_instruction_info":"{\"instruction_url\": \"{your_instruction_website}\"}"},"source_unique_id":"134448484339393"}]}
§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 | |
| ^order_statuses | []object | Callback result.For partial failure usage, if some of order line id in the request fail, it will be recorded with a none zero status_code. | |
| ^^order_line_id | string | 577086512123755123 | Line order id, same as the input line order id. |
| ^^status_code | int | 0 | Callback status of this line order id. A none zero code represent a failure callback. |
§9 Response Sample
{"code":0,"data":{"order_statuses":[{"order_line_id":"577086512123755123","status_code":0}]},"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 |
|---|---|
| 10006402 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 164004001 | permission denied, please check if you have the permission to operate the orders. |
| 164004006 | req is invalid, please check your request params |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 164004008 | no orders available for fulfillment |
| 185001003 | no orders need to call back |
| 185002001 | req is invalid, please check your request params |
| 185005001 | permission denied, please check if you have the permission to operate the orders. |
| 185005002 | current order status not support call back |