Product
Updated: 2025-09-05 09:41:51
This module is primarily used for product display, management, and interaction functions. It supports product list retrieval, detail viewing, push management, explanation features, etc., and is suitable for live streaming e-commerce scenarios.
1. API Method Overview
| API Method | Description |
|---|---|
| getProductTagList | Get product tag list |
| getProductList | Get product list |
| getLaunchProductList | Get product list (initiator side) |
| getProductData | Get product data |
| sendProductClickEvent | Send product click event |
| closeProductPush | Close the currently pushing product |
| getProductExplainEnabled | Get product explanation toggle status |
| generateProductExplainPageUrl | Generate product explanation page URL |
| getOutLinkProductRedirectEnabled | Check if the current channel enables direct redirect to external link when clicking the cover/title area of a product with "external link purchase" |
| getProductPayOrderEnabled | Check if product payment order is enabled |
| getProductHotSaleConfig | Get product hot sale configuration |
| getCurrentPushingProduct | Get the currently pushing product data |
| startExplain | Start product explanation |
| restartExplain | Restart product explanation |
| endExplain | End product explanation |
| deleteExplain | Delete product explanation |
| getCurrentProductExplain | Get the ID of the currently explaining product |
| openProductPrice | Reveal product price |
| hideProductPrice | Hide product price |
| getProductSetting | Get product settings |
| pushProduct | Push product |
| cancelPushProduct | Cancel product push |
| batchDeleteProduct | Batch delete products |
| batchOnShelfProduct | Batch list products |
| batchOffShelfProduct | Batch unlist products |
| getSupportToDirectBuy | Check if the current user supports direct product purchase |
2. Event Overview
| Event | Description |
|---|---|
| ProductEvents.OnSaleProduct | Product listed |
| ProductEvents.OffSaleProduct | Product unlisted |
| ProductEvents.AddProduct | Product added |
| ProductEvents.DeleteProduct | Product deleted |
| ProductEvents.ChangeProduct | Product modified |
| ProductEvents.MoveProduct | Product moved up or down |
| ProductEvents.ChangeProductRank | Product ranking changed |
| ProductEvents.ProductSoldOut | Product sold out |
| ProductEvents.PushProduct | Product pushed |
| ProductEvents.CancelPushProduct | Product push cancelled |
| ProductEvents.ProductListEnabled | Product library list toggle |
| ProductEvents.RefreshProductList | Refresh current product list |
| ProductEvents.ProductClick | Product click event |
| ProductEvents.ProductClickTimes | Product click count statistics event |
