帮助中心
进入EZR

1302-在线核销优惠券

2020-12-23

接口编号 1302

接口说明

1.第三方调用接口验证使用单张或者多张券

2.支持批量券核销使用，全部成功或者失败

3.ConsumeBrand如果核销品牌不为空，表示是品牌共享券之间的核销

4.成功返回每张券的核销结果，失败返回失败券号

请求说明

  • HTTP请求方式：POST

  • 返回数据格式：JSON

  • 请求路径：api/ccoup/coupuse

请求参数



字段类型为空长度描述
ShopCodestring否1~16核销门店
SalesNostring是1~26 核销的小票号
SalesMoneydecimal是(12,2)核销金额（核销订单的金额）
ConsumeUserstring是
核销人编码
CouponNosstring[]否
券码列表
ConsumeBrandstring是1~16核销品牌代码：若是多品牌券，核销品牌代码和发放品牌代码不是同一个时，传递该值；若为空，代表核销品牌代码和发放品牌代码一致


请求参数示例代码（json对象）

{
   "ShopCode": "SH000102",
   "SalesNo": "0010",
   "SalesMoney": 990.00,
   "CouponNos": ["0000123001", "0000123002"]
}


系统级返回结果示例（json）

{
   "Status": true,
   "StatusCode": 200,
   "Msg": "成功",
   "Timestamp": "20150622093101",
   "Sign": "6ECC9BF07C69E80F6D8552FF7B2E7A8FCA2CC80E",
   "Result": 见业务返回结果示例,
}

业务返回结果示例（json对象）：

说明：当一次核销多张券时，会保证多张券同时核销成功，若其中存在某一张不可用，将会返回错误提示信息。

   POS在一次核销录入多张券时，可以先调用查询券接口来验证录入的每张券状态是否可以用，待录入结束后调用券核销接口批量核销。以避免录入的失败概率。

> 核销失败：（例如0000123001已被使用，但0000123002可用，将返回2000的错误代码，详见“statusCode规范”）

{
   "Status": false,
   "StatusCode": 2000,
   "Msg": "券0000123001已经被使用",
   "Timestamp": "20150622093101",
   "Sign": "6ECC9BF07C69E80F6D8552FF7B2E7A8FCA2CC80E", 
}

> 核销成功：

{
   "Status": true,
   "StatusCode": 200,
   "Msg": "成功",
   "Timestamp": "20150622093101",
   "Sign": "6ECC9BF07C69E80F6D8552FF7B2E7A8FCA2CC80E", 
   "Result": [{
           "CouponNo": "0000123001",
           "Code": 200,
           "Message": "验证成功并消费"},{
           "CouponNo": "0000123002",
           "Code": 200,
           "Message": "验证成功并消费"},
           ],
}



7572