stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_partner/202405/campaigns
#§2 Method: [POST]
#§3 Function Description
This API offers the ability to create a campaign for targeted sellers/public sellers, including campaign period, campaign registration period and commission requirements. Note: The campaign will not be displayed to sellers after creation
§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 |
| category_asset_cipher | query | string | N | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
§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. |
| category_asset_cipher | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | The partner identifier used in API requests. Retrieve this value by using the [Get Authorized Category Assets API] (https://partner.tiktokshop.com/docv2/page/666012dd609d4402cc3be995). |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| name | string | Y | my first campaign | The campaign name. The campaign name must be less than 50 characters. |
| description | string | Y | campaign for test | The campaign description. The campaign description must be less than 1000 characters. |
| campaign_start_time | int | Y | 1712941200 | The scheduled start time in Unix epoch time format for the campaign. Note that this field can be updated when the campaign status is set to READY or UPCOMING only. |
| campaign_end_time | int | Y | 1715878799 | The scheduled end time in Unix epoch time format for the campaign. Note that the end time must be less than 360 days from the start date. This field is no longer editable when the campaign status is set to CLOSED. |
| registration_start_time | int | Y | 1712941200 | The scheduled start time in Unix epoch format for seller product registration. Note that this field can be updated when the campaign status is set to READY or UPCOMING only. |
| registration_end_time | int | Y | 1713891599 | The scheduled end time in Unix epoch time format for seller product registration. This field is no longer editable when the campaign status is set to CLOSED. |
| commission_rate | int | Y | 1000 | The total commission rate in hundredths of a percent (0.01%) units proposed by the affiliate partner for display to sellers. Commission rate must be greater than 100 and less than 8000. |
| contact_info | object | Y | The partner's contact information. | |
| string | N | +14255550100 | The partner's phone number registered in WhatsApp. Required if the target market is MY, SG, GB, or ID, optional if the target market is US; otherwise, not applicable. | |
| string | Y | 123456@gmail.com | The partner's email address. | |
| ^phone | string | N | +14255550100 | The partner's phone number. |
| ^zalo | string | N | +14255550100 | The partner's phone number registered in Zalo. Required if the target market is VN; otherwise, not applicable. |
| ^viber | string | N | +14255550100 | The partner's phone number registered in Viber. Required if the target market is PH; otherwise, not applicable. |
| ^line | string | N | +14255550100 | The partner's phone number registered in LINE. Required if the target market is TH; otherwise, not applicable. |
| target_shop_codes | []string | N | ["THCBELNL4Y"] | A list of TikTok Shop seller shop codes to allow to register for the campaign. The seller shop code in available in TikTok Shop Seller Central by clicking on the Seller Profile icon in the top right of the user interface. The list must be less than 100 items in length. |
| target_seller_types | []string | N | ["CROSS_BORDER"] | A list of eligible seller types to allow to register for the campaign. Use this field to broadly target types of sellers instead of specific sellers in the target_shop_codes field. This is an enumerated type with possible values: |
- LOCAL
- CROSS_BORDER |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_partner/202405/campaigns?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&category_asset_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"name":"my first campaign","description":"campaign for test","campaign_start_time":1712941200,"campaign_end_time":1715878799,"registration_start_time":1712941200,"registration_end_time":1713891599,"commission_rate":1000,"contact_info":{"whatsapp":"+14255550100","email":"123456@gmail.com","phone":"+14255550100","zalo":"+14255550100","viber":"+14255550100","line":"+14255550100"},"target_shop_codes":["THCBELNL4Y"],"target_seller_types":["CROSS_BORDER"]}
§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 | |
| ^campaign_id | string | 7356411663443183367 | The campaign identifier. |
§9 Response Sample
{"code":0,"data":{"campaign_id":"7356411663443183367"},"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 |
|---|---|
| 16032001 | nvalid parameter Creator and Seller, please ensure Region mismatch. |
| 16032002 | Invalid campaign period |
| 16032003 | Invalid registration period |
| 16032004 | Invalid campaign seller scope |
| 16032013 | Payment account not yet activated |