POST Search Activities
Search Activities Shop Required scope: seller.promotion.info Get a list of product discount or flash deal promotion activities. For coupon activities, use Search Coupons
. Version 202309
POST/promotion/202309/activities/search
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller 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. |
| shop_cipher Required | string | 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 |
Body
| Properties | Type | Description |
|---|---|---|
| status | string | Activity status.Possible values:- DRAFT: Promotion activities with this status are not available to TikTok users.- NOT_START: Promotion activities with this status are not available to TikTok users until the set activity start time.- ONGOING: Promotion activities with this status are available to TikTok users.- EXPIRED: Promotion activities with this status are not available to TikTok users because it has expired.- DEACTIVATED: The activity has been deactivated by the seller and is not available to TikTok users.- NOT_EFFECTIVE: The activity is terminated by the platform and is not available to TikTok users. |
| activity_title | string | Activity title key words. No fuzzy matching. |
| page_size | int | Page size. The range is [0, 100]. 50 by default. |
| page_token | string | Specify the value for the page. Use "" for the first page. |
| activity_type | string | The type of activities. If activity_type isn't passed, return activities of all types. Possible values:The type of activities.Possible values:- FIXED_PRICE- DIRECT_DISCOUNT- FLASHSALE- SHIPPING_DISCOUNT- BUY_MORE_SAVE_MORE |
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 | | --- | --- | | 17029001 | Invalid parameters | | 17029055 | Request Timeout | | 17029059 | page_token + page_size must be less than 10000. | | 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