Query the creator commission rate, number of promotional video contents and number of live‑stream promotions for specified creator, specified invitation and specified product.
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.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Creator open id
Invitation Group Id
Product ID or product title to match, as selected by query_type. Provide both fields to filter the returned products.
Specifies how query filters products. Possible values:
PRODUCT_ID: Match the product ID exactly.PRODUCT_NAME: Match product titles by case-sensitive substring.
Creator Invitation Id
Product Fitler
object
Product added type list, support status: -ALL: all status -ADDED: creator added product NOT_ADDED: creator not added product
Example
{ "creator_user_open_id": "abc", "invitation_group_id": "1234", "query": "abc", "query_type": "PRODUCT_ID", "invitation_id": "1234", "product_filter": { "added_types": [ "ALL" ] }}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Promotion details for products in the target collaboration invitation group.
object
Product detail infomation
object
Product basic infomation
object
Product ID
Product titile
Product Image
object
Product Image URL
Product Price
object
Product min price
object
Price amout
Price currency
Product max price
object
Product amount
Product currency
Product promotion price
object
Product promotion min price
object
Price amout
Price currency
Product promotion max price
object
Product amount
Product currency
Product target collaboration commission. e.g. 2200 mean 22% commission rate
Product open collaboration commission. e.g. 2200 mean 22% commission rate
Product target ads collaboration commission
Product old target collaboration commission
Product old target ads collaboration commission
Unix timestamp in milliseconds when the target collaboration commission becomes effective.
Unix timestamp in milliseconds when the target collaboration Ads commission becomes effective.
Product status
1: Active
2; Sold out
3: product deactivated by seller;
4: product deactivated by platform
5: product reject
6: product deleted
Product added or not
Creator post video count in collaboration
Creator LIVE count in collaboration
Whether the target collaboration commission for this creator-product pair is currently effective. false means an active campaign collaboration takes precedence.
Example
{ "code": 0, "data": { "data": { "product_details": [ { "product_base_info": { "product_id": "1234", "title": "product title", "image": { "url": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/2ca53c34ad8443e6b39f4e0153d3aed4~tplv-o3syd03w52-origin-image.image?from=1320446476" }, "price": { "min_price": { "amount": "1", "currency": "GBP" }, "max_price": { "amount": "1", "currency": "GBP" } }, "promotion_price": { "min_price": { "amount": "1", "currency": "GBP" }, "max_price": { "amount": "1", "currency": "GBP" } }, "target_commission": 2200, "open_commission": 2200, "target_ads_commission": 2200, "old_target_commission": 2200, "old_target_ads_commission": 2200, "commission_effective_time": 1786592565735, "ads_commission_effective_time": 1786592565735, "product_status": "1" }, "product_add_status": false, "video_count": 1, "live_count": 1, "is_commission_effective": false } ] } }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}