Get Affiliate Partner Campaign Detail

This API offers the ability to get affiliate campaign details.

---

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Query

https://open-api.tiktokglobalshop.com/affiliate_partner/202405/campaigns/7373988288167036678?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&category_asset_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY

• READY
• UPCOMING
• ONGOING
• CLOSED | ^region |string |US |The region to which the campaign is associated. | ^registration_start_time |int |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 |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. | ^campaign_start_time |int |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 |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. | ^commission_rate |int |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 | |The campaign creator's contact information. | ^^whatsapp |string |+14255550100 |WhatsApp account number | ^^email |string |123456@gmail.com |Email | ^^phone |string |+14255550100 |Phone number | ^^zalo |string |+14255550100 |Zalo account number | ^^viber |string |+14255550100 |Viber account number | ^^line |string |+14255550100 |Line account number | ^target_shops |[]object | |A list of TikTok Shop seller shop codes and names with permission to register for the campaign. | ^^code |string |THCBELNL4Y |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. | ^^name |string |my_shop |The TikTok Shop name. | ^target_seller_types |[]string |["LOCAL"] |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 |

{"code":0,"data":{"id":"7356876895365105455","name":"test_campaign","description":"Campaign for api test.","status":"READY","region":"US","registration_start_time":1712941200,"registration_end_time":1713891599,"campaign_start_time":1712941200,"campaign_end_time":1715878799,"commission_rate":1000,"contact_info":{"whatsapp":"+14255550100","email":"123456@gmail.com","phone":"+14255550100","zalo":"+14255550100","viber":"+14255550100","line":"+14255550100"},"target_shops":[{"code":"THCBELNL4Y","name":"my_shop"}],"target_seller_types":["LOCAL"]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code