Modify Channel Product Shelf Status

Updated: 2022-09-02 18:08:07

Interface Description

1、修改频道商品库商品上下架状态
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/product/shelf

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	String	Channel ID
productId	true	Integer	Product ID
shelf	true	Integer	Product shelf status 1: Listed 2: Unlisted

Example

http://api.polyv.net/live/v3/channel/product/shelf

Form parameters:

productId=27471&appId=frlr1zazn3&sign=5D39E63FC79E676980293E0D3A54B031&channelId=1965681&timestamp=1621843574601&shelf=2

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	String	Returns SUCCESS on successful request, empty on failure

Java Request Example

For quick integration of the base code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log=LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 修改商品库上下架状态
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testShelfChannelProduct() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/product/shelf";
    String channelId = "1965681";
    String productId = "27471";
    String shelf = "2";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("productId", productId);
    requestMap.put("shelf", shelf);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改商品库上下架状态：{}", response);
    //do somethings
    
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "SUCCESS"
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}