This API is used by Seller to search for all existing target collaborations. Sellers can search based on filters such as Invitation name, Invitation ID, Product name, Product ID and Creator name.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
The value of “page_size” must be 20, 50 or 100.
Pagination token that specifies where to continue the search. Omit this parameter or leave it empty in the first request. For subsequent pages, pass the next_page_token returned by the previous response and reuse the same request-body filters and page_size.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Filter target collaborations by the acceptance status of invited creators. Allowed values:
- ACCEPT: The creators have added the products to their showcases.
- ALL: Do not filter by whether the creators have added the products to their showcases. Default: ALL.
Filtering by target collaborations’ free sample setting. You can query based on:
- “WITH_FREE_SAMPLE”
- “ALL” By default, the target collaborations will be searched by “ALL” setting.
Search criteria for target collaborations. When this object is provided, provide both keyword_type and keyword.
object
Type of value provided in keyword. Possible values:
- PRODUCT_ID: Search for a specific product ID.
- PRODUCT_NAME: Fuzzy-search by product name.
- TARGET_COLLABORATION_ID: Search for a specific target collaboration ID.
- TARGET_COLLABORATION_NAME: Fuzzy-search by target collaboration name.
The value to search for, interpreted according to keyword_type.
The creator’s TikTok User Open ID. Provide this field to filter target collaborations for the specified creator. More details
Filtering by target collaborations’ status. You can query based on:
- ONGOING: If you use ONGOING to search, the remaining validity period of the returned target collaborations will be greater than 7 days.
- EXPIRING: If you use EXPIRING to search, the remaining validity period of the returned target collaborations will be less than 7 days.
- VALID: If you use VALID to search, all returned target collaborations will be valid.
- CANCELING: If you use CANCELING to search, all returned target collaborations will be in the process of canceling.
- COMPLETED: If you use COMPLETED to search, all returned target collaborations will be in the state of completed, including expired and canceled.
Example
{ "creator_accept_status": "ACCEPT", "free_sample_setting": "WITH_FREE_SAMPLE", "search_param": { "keyword_type": "TARGET_COLLABORATION_NAME", "keyword": "test" }, "creator_user_open_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg", "collaboration_status": "ONGOING"}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Total number of target collaborations that match the request across all pages.
Cursor for the next page request.
The basic information of target collaboration which creators can view in Targeted Invitation on TikTok EC Center.
object
Target collaboration ID.
Target collaboration name.
Message seller has sent to creators about seller’s introduction and why excited to collaborate.
Unix timestamp, in seconds, when the target collaboration starts.
Unix timestamp, in seconds, when the target collaboration ends.
Unix timestamp, in seconds, when the target collaboration was created.
Unix timestamp, in seconds, when the target collaboration was last updated.
The count of creators invited in the target collaboration.
The number of creators in the target collaboration who added at least one of its products to their showcase.
The number of creators who posted content featuring products from target collaboration.
The count of products added in the target collaboration.
The free sample rules set by the seller in the target collaboration.
object
If true, free samples are provided to creators invited to the target collaboration group.
If true, creators invited to the target collaboration are exempt from seller review and will automatically be approved for a free sample. Note that if has_free_sample=false, this field will not take effect.
The type of target collaboration. Field values:
- STANDARD: The target collaboration is created by sellers manually selecting products and creators.
- TOP_CREATOR_PROGRAM: The target collaboration created by seller joining TikTok Shop Top Creator Program, requiring only product submission.
Example
{ "code": 0, "data": { "total_count": 100, "next_page_token": "b2Zmc2V0PTIw", "target_collaborations": [ { "id": "789078671231123124", "name": "target_collaboration", "message": "test", "start_time": 1715654330, "end_time": 1715654330, "create_time": 1715654330, "update_time": 1715654330, "creator_inivited_count": 10, "showcase_creator_count": 2, "content_creator_count": 1, "product_count": 30, "free_sample_rule": { "has_free_sample": true, "is_sample_approval_exempt": true }, "type": "STANDARD" } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}