Skip to main content

码预核销接口

接口用途

  • 当需要确认码是否可用在当前场景时，调用此接口，

接口说明

  • 建议单码场景使用。多码需确认是否满足需求。

action

  • CodeCheck

请求参数，CHANNEL===>WHALE

字段 类型 是否必填 字段意义 备注
requestId String 是 请求流水号 32个字符，用于标识唯一一笔交易
codes List 是 验码集合  
cashTotalAmount Number 是 订单金额 单位：分
isProductCheck String 是 是否校验订单产品规则 是Y，否N
brandId String 否 品牌id 多品牌使用的码，此字段必传
shopNo String(20) 否 门店号 线下场景必填
tid String(8) 否 终端号  
cityId String 否 城市id，对接时使用ebuy城市id 有规则时必须上传
goodsDetail Object<goodsDetail> 否 折抵产品明细 目前支持单码预核销检查使用

请求报文举例

{
    "requestId":"2018111911253510000010",
    "codes":["101111111111","1022222222222","1033333333333","104444444444"],
    "cashTotalAmount":"20000",
    "brandId":"121",
    "tid":"99000014",
    "shopNo":"123456",
    "cityId":"1012",
    "companyId":"11",
    "goodsDetail":[{
        "sku": "1112343",
        "qty": 1,
        "price": 3000,
        "type": "03",
        "spec": "03"
            }, {
        "sku": "1212342",
        "qty": 1,
        "price": 3500,
        "type": "03",
        "spec": "03"
        }]
}

返回参数，WHALE===>CHANNEL

字段 类型 是否必填 字段意义 备注
returnCode String 是 00为成功，其他均为失败  
returnMsg String 是 请求返回信息  
data/checkResult Object<data/checkResult> 是 劵码查询结果

返回报文举例

{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "data": {
        "checkResult":[{
            "code":"1021242013780905000",
            "saleChannelCode":"990001",
            "saleChannelName":"易百码",
            "status": "00",
            "discountAmount":3000
        },{
            "code":"1021242013780905000",
            "saleChannelCode":"990001",
            "saleChannelName":"易百码",
            "status": "06",
            "discountAmount":3000,
        }]
    }
}

券状态枚举

字段 字段意义 备注
00 可用
01 已使用
03 未激活 未激活的码需调用激活接口才能
04 已冻结
05 已作废
06 已过期  
07 未生效 当制码时选择次日生效，核销时会返回该状态
09 码不存在
35 劵数据异常 联系易百确认
39 核销失败
91 核销异常
No Comments
Back to top
Entity Select