GET Get Affiliate Partner Campaign List
Get Affiliate Partner Campaign List Asset Required scope: partner.tap_campaign.read This API offers the ability to list campaigns created by the Affiliate Partner. Version 202405
GET/affiliate_partner/202405/campaigns
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The partner access_token value from Get Access Token, when user_type = 3. Follow this guide to get partner access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | 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 Required | string | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
| page_size Required | int | The number of results to be returned per page. Default: 10. Valid range: [1-100]. |
| page_token | string | 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. Maximum page size is 100 items. |
| status | string | The campaign status. The status is an enumerated type with values:- READY- UPCOMING- ONGOING- CLOSED- UNSPECIFIED |
| type | string | The campaign type. This is an enumerated type with values: - MY_CAMPAIGNS- GS_SELLING_CAMPAIGNS - SELLER_CAMPAIGNS- EXCLUSIVE_TIKTOK_SHOP Default value is MY_CAMPAIGNS. |
| query_type_filter | string | An extended filter to be used when the campaign type property type is set to SELLER_CAMPAIGNS or EXCLUSIVE_TIKTOK_SHOP. If the type property is set to SELLER_CAMPAIGNS, the valid values for this property are: - MARKETPLACE: the response includes campaigns that the partner did not join.- JOINED : the response includes campaigns the partner has joined only.If the type property is set to EXCLUSIVE_TIKTOK_SHOP, the valid values for this property are:- AVAILABLE: the response includes campaigns the partner is permitted to join.- JOINED: the response includes campaigns the partner has joined only.Other types can either not pass a value or pass in Default. |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | 16032001 | nvalid parameter Creator and Seller, please ensure Region mismatch. | | 16032007 | Permission denied | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext