Search the merchant’s open collaborations. The response includes product details, current commission information, the number of creators who added each product to their showcase, and the number of creators who posted LIVE or video content.
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.
Pagination token that determines where the search starts. Leave this parameter empty for the first request. For subsequent requests, pass the next_page_token returned by the previous response and reuse the same request-body filters, sort_field, sort_order, and page_size.
The value of “page_size” must be greater than 0 and less than or equal to 100.
Default value of “sort_order” is DESC. Enum:
- ASC：means to sort data in ascending order
- DESC：means to sort data in descending order
Some sorting fields are as follows:
- product_original_price: sort by products’ original price. By default, the open collaborations are sorted in descending order by creation time.
Request Body
Section titled “Request Body”object
Specifies the type of value in keyword. To filter open collaborations by product name or product ID, provide keyword_type and keyword together.
Possible values:
PRODUCT_ID: Search for open collaboration information for the specified product ID.PRODUCT_NAME: Fuzzy-search open collaboration information by related product names.
Search based on the product name or product ID. Pass in the appropriate value based on the keyword_type above.
Filter products by a first-level category ID.
The value of top_level_category_id must be greater than 0.
Example
{ "keyword_type": "PRODUCT_ID", "keyword": "7625459350921", "top_level_category_id": "60001"}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Pagination token for the next page. Pass this value as page_token in the next request. An empty value indicates that there are no more results.
Total count of products that satisfy all the input search conditions.
Open collaborations matching the search criteria on the current page.
object
The open collaboration id
Status of open collaboration. Field values:
- NORMAL：NORMAL means the current open collaboration status is normal and in effect.
- TERMINATING: TERMINATING means that the merchant has removed open collaboration and the open collaboration will expire soon. The expiration time can be found at the end_time of current_commission. The open collaborations which were removed and expired will not be returned in the response.
The commission information is currently in effect for this open collaboration.
object
The commission rate for this product is set by merchants for creators’ public promotion. The range of this value is [100, 8000]. This value is expressed in 1/10000 increments. For example: 3000 means the actual commission rate is 30.00%, and 3555 means 35.55%
The Unix timestamp, in seconds, when the commission rate becomes effective.
The Unix timestamp, in seconds, when the commission rate stops being effective.
This field indicates the number of creators who added the product to the showcase from open collaboration.
This field indicates the number of creators who posted the LIve or Video from open collaboration.
The open collaboration bound product information.
object
Product’s unique id.
Product’s name.
The product image url.
Product’s status. Field values:
- LIVE: When the product is normal for sale, return to the LIVE status
- OUT_OF_STOCK: When the product is out of stock for the consumer, the OUT_OF_STOCK state is returned
- SELLER_DEACTIVATE: When the product is deactivated by the merchant, the SELLER_DEACTIVATE status is returned
- PLATFORM_DEACTIVATE: When the product is deactivated by the platform or is not available for sale, the PLATFORM_DEACTIVATE status is returned
- GNE_REJECT: When the product is governed or the open collaboration is dismissed, the GNE_REJECT state is returned
- DELETE: When the product is deleted, the DELETE status is returned
- OTHER: When the product is in an unsaleable state, such as draft, frozen, review, etc, the OTHER status is returned
The inventory of this product.
The product’s original price
object
The currency in the sale region.
The minimum original price of all skus of this product.
The maximum original price of all skus of this product.
Example
{ "code": 0, "data": { "next_page_token": "b2Zmc2V0PTEw", "total_count": 10000, "open_collaborations": [ { "id": "94297006405", "status": "NORMAL", "current_commission": { "rate": 3000, "start_time": 1725334422, "end_time": 1727625600 }, "showcase_creator_count": 15, "content_creator_count": 10, "product": { "id": "1729432087292775344", "title": "Blue t-shirt", "main_image_url": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499", "status": "LIVE", "inventory": 1274, "original_price": { "currency": "USD", "minimum_amount": "12.21", "maximum_amount": "100.00" } } } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}