Skip to main content

查询码信息查询

接口用途

  • 当需要查询某个指定码时，取码方调用此接口

接口说明

  • 码表中以掩码为分表位，每查询某个码时必须有明确的码号。

action

  • CodeQueryBySearchCode

请求参数，CHANNEL===>WHALE

字段类型是否必填字段意义备注
requestIdString是请求流水号32个字符，用于标识唯一一笔交易
codesList是验码集合 
brandIdString否核销门店所属品牌组合劵必须上送，易百提供
cityIdString否门店所在城市id易百提供的城市id
storeInfoObject<storeInfo>否门店串码查询时上送

请求报文举例

{
    "requestId": "20181019112535100000000000000002",
    "codes": ["1021242013780905000"],
    "brandId":"2429",
    "cityId":5493
}

返回参数，WHALE===>CHANNEL

字段类型是否必填字段意义备注
returnCodeString是请求返回码 
returnMsgString是请求返回信息 
dataObject<codeQueryResponseData>否码信息

返回报文举例

{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "171698602301",
    "data":{
        "codeDetail":[{
            "code":"1021242013780905000",
            "saleChannelOrderId":"20181120155110",
            "sendChannelName":"易百自制渠道",
            "saleChannelCode":"990001",
            "useTimes":1,
            "verifyTimes":1
            "remainTimes":0,
            "createDate": "20180905",
            "createTime": "20180905160911",
            "validStart":"20181123000000",
            "validEnd":"20181124235959",
            "verifyDate":"20181123",
            "verifyTime":"20181124121243",
            "status": "01",
            "statusDesc": "已使用",
            "cityCheck":"Y",
            "ticketId":"9000000001",
            "faceValue":3000,
            "ticketName":"星巴克30元代金券",
            "shopNo":"1111",
            "shopName":"星巴克测试门店"
            "faceValue":1000,
        },{
            "code":"1021242013780905001",
            "saleChannelOrderId":"20181120155110",
            "sendChannelName":"易百自制渠道",
            "remainTimes":1,
            "createDate": "20180905",
            "createTime": "20180905160911",
            "validStart":"20181123000000",
            "validEnd":"20181124235959",
            "verifyDate":"20181123",
            "verifyTime":"20181124121243",
            "status": "01",
            "statusDesc": "已使用",
            "cityCheck":"Y",
            "ticketId":"9000000001",
            "faceValue":3000,
            "ticketName":"星巴克30元代金券",
            "shopNo":"1111",
            "shopName":"星巴克测试门店"
            "faceValue":1000,
        }]
    }
}

券状态枚举

字段字段意义备注
00可使用
01已使用
02可使用(一码多次使用时，码还有可用次数)
03未激活未激活的码需调用激活接口才能
04已冻结
05已作废
06已过期 
07未生效当制码时选择次日生效，核销时会返回该状态
09券不存在 
35码配置异常
Back to top