Create Coupon

API Description

1、创建优惠券
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/user/coupon/create

Online API Call

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameter Description

Request Body Parameter Description

UserCouponRule

Unconditional

FullReduce

Example

https://api.polyv.net/live/v4/user/coupon/create?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

Request body JSON parameters:

{
    "availableAmount": 999,
    "dayOfUse": 30,
    "description": "买一送一",
    "name": "优惠券2号",
    "receiveEndTime": 1756102918736,
    "receiveStartTime": 1748326918736,
    "rule": {
        "condition": "UNCONDITIONAL",
        "limitPerPerson": -1,
        "unconditional": {
            "enable": true,
            "unit": "MONEY",
            "value": 1.0
        }
    },
    "type": "MAX_OUT",
    "useEndTime": 1756102918737,
    "useStartTime": 1748326918737,
    "useTimeType": "RANGE"
}

Response Parameter Description

Data Parameter Description

Error Parameter Description

Java Request Example

For quick integration of 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. The 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 integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 新增优惠券
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void createCouponTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "https://api.polyv.net/live/v4/user/coupon/create";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("name", "优惠券2号");
    jsonMap.put("useTimeType", "RANGE");
    jsonMap.put("dayOfUse", 30");    
    jsonMap.put("receiveStartTime", 1756102918736L);
    jsonMap.put("receiveStartTime", 1748326918736L);
    jsonMap.put("useStartTime", 1748326918737L);    
    jsonMap.put("useEndTime", 1756102918737L);                
    Map<String, Object> rule = new HashMap<>();                
    rule.put("condition", "UNCONDITIONAL");        
    rule.put("limitPerPerson", -1);   
    Map<String, Object> unconditional = new HashMap<>(); 
    unconditional.put("enable", true);   
    unconditional.put("unit", "MONEY"); 
    unconditional.put("value", 1.0);                 
    rule.put("unconditional", unconditional);                  
    jsonMap.put("rule", rule);  
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试新建优惠券结果：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "data":"caqfi6rqutunvofor5jrqbinswh14p2g", // 优惠券ID
    "success": true,
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}