Skip to main content

码预核销接口

接口用途

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

接口说明

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

action

  • CodeCheck

请求参数，CHANNEL===>WHALE

字段类型是否必填字段意义备注
requestIdString是请求流水号32个字符，用于标识唯一一笔交易
codesList是验码集合 
cashTotalAmountNumber是订单金额单位：分
isProductCheckString是是否校验订单产品规则是Y，否N
brandIdString否品牌id多品牌使用的码，此字段必传
shopNoString(20)否门店号线下场景必填
tidString(8)否终端号 
cityIdString否城市id，对接时使用ebuy城市id有规则时必须上传
goodsDetailObject<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

字段类型是否必填字段意义备注
returnCodeString是00为成功，其他均为失败 
returnMsgString是请求返回信息 
data/checkResultObject<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核销异常
Back to top