POST Search Coupons

Search Coupons Shop Required scope: seller.promotion.infoor seller.customer_service Use this API to get a list of coupons, narrowed down further based on search parameters. The coupons are created in Seller Center or Seller App. For further details of the specific coupon, use GET Coupon. Version 202406

POST/promotion/202406/coupons/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.
page_token	string	Page cursor. Omitting this parameter will return the first page of results.
page_size	int	The number of coupons returned in one page of results. The range is [1, 100], with a default value of 50.
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	Coupon's promotion status.Values:- NOT_START: Not available to TikTok users until the coupon's configured start time.- ONGOING: Available to TikTok users.- EXPIRED: Not available to TikTok users because it has expired.- DEACTIVATED: Deactivated by the seller and is not available to TikTok users.
title_keyword	string	Keywords in the coupon titles to search for. The range of the length is (0, 100]. Fuzzy matching not supported.
display_type	[]string	The display type of coupons.Values:- REGULAR: Regular coupons which are displayed to TikTok users across all display locations available in TTS, including PLPs, PDPs, TikTok Videos, LIVE Rooms, Creator Showcases, and may be shared via TTS Customer Support instant messages. Includes coupons which target select customer segments.- LIVE: Coupons which are only displayed to TikTok users in LIVE Rooms.- CREATOR_EXCLUSIVE: Coupons that can be claimed through the display channels of the specified creator, such as their LIVE Rooms, and their Creator Showcase.- CHAT: Exclusive coupons that may be sent to customers via TTS customer support chat messages, but are not displayed in other display locations.- PROMO_CODE: Promo codes do not have dedicated display locations on TikTok, but may be shared with customers in LIVEs, in TikTok videos, or other social media platforms. They can be claimed by customers entering a claim code at checkout or by customers that use a custom promo code landing page URL.

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 | | --- | --- | | 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