stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_partner/202501/campaigns/{campaign_id}/products/performance
#§2 Method: [GET]
#§3 Function Description
This API offers the ability to get the product of the campaign fulfillment status for creators who added partner campaign products to their showcase. For details of a specified product involved in an affiliated campaign, use Get Affiliate Campaign Creator Fulfillment Status Info gateway.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| campaign_id | string | Y | 1234567890 | the unique id of a campaign |
§6 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. |
| page_size | int | N | 10 | The number of results to be returned per page. Valid range: 1-50. |
| page_token | string | N | b2Zmc2V0PTAK | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_partner/202501/campaigns/1234567890/products/performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&page_size=10&page_token=b2Zmc2V0PTAK
§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 | |
| ^total_count | int | 10 | The total count of products included in the specified campaign. |
| ^campaign_product_statistics | []object | A list of objects representing campaign product statistics. | |
| ^^data_update_time | string | 1736204400000 | The time at which the product data was last updated, in Unix epoch format. |
| ^^creator_sales_num | int | 1 | The number of products sold in the campaign. |
| ^^collaborated_creators_num | int | 0 | The total number of creators associated with the campaign. |
| ^^promoted_creator_num | int | 0 | The number of the creators involved in the campaign. |
| ^^sample_requested_creator_num | int | 0 | The total number of samples requested by all creators associated with the campaign. |
| ^^campaign_product_detail | object | An object representing the details for the product associated with the campaign. | |
| ^^^product_id | string | 12344 | The product identifier. |
| ^^^product_status | string | PRODUCT_UNSPECIFIED | The product status. This is an enumerated type with values: |
- PRODUCT_UNSPECIFIED
- PRODUCT_PENDING
- PRODUCT_APPROVED
- PRODUCT_REJECTED
- PRODUCT_PENDING_CLOSED
- PRODUCT_CLOSED | ^^^product_name |string |summer underwear soft dress summer underwear-001 |The product name. | ^^^product_stock_count |string |100 |The total number of products in stock. | ^^^total_commission_percent |string |6000 |The commission rate of the partner plan. It is the sum of the
creator_commission_rateandpartner_commission_rate. The value is in hundredths of a percent. For example, a value of 1000 means 10.00%. | ^^^creator_commission_percent |string |1000 |The commission rate for the creator in the partner plan. The value is in hundredths of a percent. For example, a value of 1000 means 10.00%. | ^^^partner_commission_percent |string |5000 |The commission rate for the partner in the partner plan. The value is in hundredths of a percent. For example, a value of 1000 means 10.00%. | ^^^plan_commission_percent |string |1400 |The commission rate for open collaboration. The value is in hundredths of a percent. For example, a value of 1000 means 10.00%. | ^^^product_price |object | |The product price. | ^^^^min_price |string |1.00 |The minimum offered price of the product. | ^^^^max_price |string |3.00 |The maximum offered price of the product. | ^^^^currency |string |USD |The currency code for the maximum and minimum offered price for the product. | ^^^product_thumbnail |object | |An object representing the product thumbnail. | ^^^^uri |string |tos-useast5-i-omjb5zjo8w-tx/178e97ee3b254f9ab237ea7516828266 |The base URI of the product. | ^^^^url_list |[]string |["https://p19-oec-ttp.tiktokcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/178e97ee3b254f9ab237ea7516828266~tplv-omjb5zjo8w-resize-jpeg:300:300.jpeg?from=520841845", "https://p16-oec-ttp.tiktokcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/178e97ee3b254f9ab237ea7516828266~tplv-omjb5zjo8w-resize-jpeg:300:300.jpeg?from=520841845"] |A list of URLs for each image associated with the product. | ^^^indicator_data |object | |Key performance indicators for the product. | ^^^^paid_order_num |string |3 |The total number of paid orders.paid_order_num=actual_order_num+ {number of paid but returned orders} | ^^^^actual_order_num |string |0 |The actual number of paid orders. | ^^^^estimated_amount |string |0 |The total payment amount corresponding topaid_order_num. | ^^^^actual_amount |string |0 |GMV, the total payment amount corresponding toactual_order_num. | ^^^^estimated_partner_commission |string |0 |The partner commission amount corresponding to paid_order_num. | ^^^^actual_partner_commission |string |0 |The partner commission amount corresponding to actual_order_num. | ^^^^creator_sales_num |string |0 |The number of creators credited with at least one product sale. | ^^^^collaborated_creators_num |string |0 |The total number of creators collaborating on the campaign. | ^^^^promoted_creator_num |string |0 |The number of creators involved in the partner plan. | ^^^^sample_requested_creator_num |string |0 |The total number of creators that applied for a sample. | ^next_page_token |string |0 |next page query token |
§9 Response Sample
{"code":0,"data":{"total_count":10,"campaign_product_statistics":[{"data_update_time":"1736204400000","creator_sales_num":1,"collaborated_creators_num":0,"promoted_creator_num":0,"sample_requested_creator_num":0,"campaign_product_detail":{"product_id":"12344","product_status":"PRODUCT_UNSPECIFIED","product_name":"summer underwear soft dress summer underwear-001","product_stock_count":"100","total_commission_percent":"6000","creator_commission_percent":"1000","partner_commission_percent":"5000","plan_commission_percent":"1400","product_price":{"min_price":"1.00","max_price":"3.00","currency":"USD"},"product_thumbnail":{"uri":"tos-useast5-i-omjb5zjo8w-tx/178e97ee3b254f9ab237ea7516828266","url_list":["https://p19-oec-ttp.tiktokcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/178e97ee3b254f9ab237ea7516828266~tplv-omjb5zjo8w-resize-jpeg:300:300.jpeg?from=520841845","https://p16-oec-ttp.tiktokcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/178e97ee3b254f9ab237ea7516828266~tplv-omjb5zjo8w-resize-jpeg:300:300.jpeg?from=520841845"]},"indicator_data":{"paid_order_num":"3","actual_order_num":"0","estimated_amount":"0","actual_amount":"0","estimated_partner_commission":"0","actual_partner_commission":"0","creator_sales_num":"0","collaborated_creators_num":"0","promoted_creator_num":"0","sample_requested_creator_num":"0"}}}],"next_page_token":"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 |
|---|
