Batch Delete Channel Products

Updated: 2024-09-11 11:45:04

API Description

1、批量删除频道商品
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/product/batch-delete

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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

Request Body Parameter Description

Parameter	Required	Type	Description
productIds	true	Array	Array of channel product IDs, up to 100 product IDs per request

Example

http://api.polyv.net/live/v3/channel/product/batch-delete

Form Parameters:

appId=frlr1zazn3&sign=5D39E63FC79E676980293E0D3A54B031&channelId=1965681&timestamp=1621843574601

Request Body Parameters:

{
    "productIds":[12,123,444]
}

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, assists in describing error reasons when code is 400 or 500
data	String	Returns SUCCESS on successful request, empty on failure

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

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

private static final Logger log=LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 批量删除商品
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testBatchDeleteChannelProduct() 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/batch-delete";

        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        requestMap.put("channelId", "123333");
        url = HttpUtil.appendUrl(url, requestMap);
        
        String json = "{\"productIds\":[1,2,3,4]}";
        String response = HttpUtil.postJsonBody(url, json, null);
        log.info("测试批量删除商品，返回值：{}", response);
    
}

Response Example

For system 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": ""
}

{
  "code": 400,
  "status": "error",
  "message": "param should not be empty: productIds",
  "data": ""
}

{
  "code": 400,
  "status": "error",
  "message": "批量操作的商品数量超过上限",
  "data": ""
}

{
  "code": 400,
  "status": "error",
  "message": "channel product sort type error",
  "data": ""
}