Get Weekly Creator Outreach Quota

资料正文

§1 Path: /affiliate_seller/202607/creator_outreach/quota

§2 Method: [GET]

§3 Function Description

Query the weekly outreach invitation quota for a shop. It returns the current GMV tier, maximum reachable creator follower count corresponding to the tier, consumed quota, remaining quota and other related information.

§4 Common Parameters

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

Properties	Location	Type	Require	Sample	Properties description
shop_cipher	query	string	Y	GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3	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
content-type	header	string	Y	application/json	Allowed type: application/json

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

§6 Request Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_seller/202607/creator_outreach/quota?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY

§7 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
^data	object		Response data
^^shop_id	string	1234	Shop id
^^quota_type	string	BONUS	Quota type, e.g.
bouns quota;
period quota
^^gmv_tier	string	1	Shop gmv tier
^^quota_sum	string	1000	Shop quota sum
^^quota_use	string	500	Shop quota used
^^unlimited	bool	false	Is unlimited shop
^^reached_max_follower_cnt	string	1000	Max creator follower count this shop can reach
^^new_connect_count	string	100	New connect creator count during this quota period
^^pair_connect_count	string	100	Connect paired creator count during this quota period
^^start_time	string	1754296736852	Quota period start time
^^end_time	string	1754296736852	Quota period end time
^^gmv_level_rule	[]object		Quota GMV level rules
^^^reached_max_follower_cnt	string	1000	Creator max follower count that this shop can reached
^^^gmv_tier	string	1	GMV tier id
^^^left_gmv	object		Rule gmv left bound
^^^^amount	string	1000	GMV amount
^^^^currency	string	JPY	GMV currency
^^^right_gmv	object		Rule gmv right bound
^^^^amount	string	2000	GMV amount
^^^^currency	string	JPY	GMV currency

§8 Response Sample

{"code":0,"data":{"data":{"shop_id":"1234","quota_type":"BONUS","gmv_tier":"1","quota_sum":"1000","quota_use":"500","unlimited":false,"reached_max_follower_cnt":"1000","new_connect_count":"100","pair_connect_count":"100","start_time":"1754296736852","end_time":"1754296736852","gmv_level_rule":[{"reached_max_follower_cnt":"1000","gmv_tier":"1","left_gmv":{"amount":"1000","currency":"JPY"},"right_gmv":{"amount":"2000","currency":"JPY"}}]}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

§9 Error Code

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

Code	Message