93 lines
3.4 KiB
Markdown
93 lines
3.4 KiB
Markdown
open.virtual.eticket.checkavailable
|
|
需用户授权
|
|
POST
|
|
查询电子凭证校验结果
|
|
更新时间: 2023-11-01 20:02:42
|
|
检查电子凭证是否有效
|
|
系统环境
|
|
环境 域名
|
|
线上环境（推荐） https://openapi.kwaixiaodian.com
|
|
线上环境（备用） https://open.kwaixiaodian.com
|
|
系统参数
|
|
参数名 类型 必须 详情描述
|
|
appkey String 是 平台分配的appId
|
|
timestamp Number 是 发起请求的Unix时间戳，单位为毫秒
|
|
access_token String 是 访问token，所有需用户授权API使用code模式获取，不需要用户授权API使用client_credentials获取，详情参考《授权说明》文档
|
|
version Number 是 请求的API版本号，目前版本为1
|
|
param JSON 是 业务参数，详见下方的请求入参
|
|
method String 是 请求的API英文名，详见各API定义
|
|
sign String 是 API入参的签名结果参数
|
|
signMethod String 是 签名算法，支持HMAC_SHA256和MD5，推荐使用HMAC_SHA256
|
|
请求参数
|
|
参数名 类型 必须 示例值 详情描述
|
|
buyerId Long 否 211 买家编号
|
|
eticketType String 是 22 电子凭证类型
|
|
etickets List<AvailableEticket> 是 [] 电子凭证列表
|
|
orderId Long 否 1 订单编号
|
|
sellerId Long 是 211 卖家编号
|
|
返回参数
|
|
参数名 类型 示例值 详情描述
|
|
code String 1 主返回码
|
|
msg String success 主返回信息
|
|
sub_code String 1 子返回码
|
|
sub_msg String 1 子返回信息
|
|
etickets List<AvailableEticketDetail> [] 电子凭证校验结果
|
|
result Integer 1 是否成功
|
|
error_msg String 1 错误信息
|
|
错误码
|
|
错误码 错误类型 错误描述 解决方法
|
|
3009 业务错误 电子凭证核销时，可用数量和平台不一致，其中一部分券不可用 电子凭证核销时，可用数量和平台不一致，其中一部分券不可用
|
|
请求示例
|
|
JAVA
|
|
CURL
|
|
package com.kuaishou.merchant.open.api.sdk.demo;
|
|
import com.kuaishou.merchant.open.api.common.utils.GsonUtils;
|
|
import com.kuaishou.merchant.open.api.request.industry.OpenVirtualEticketCheckavailableRequest;
|
|
import com.kuaishou.merchant.open.api.response.industry.OpenVirtualEticketCheckavailableResponse;
|
|
import com.kuaishou.merchant.open.api.client.AccessTokenKsMerchantClient;
|
|
|
|
public class AccessTokenKsMerchantClientDemo {
|
|
|
|
public static void main(String[] args) {
|
|
String url = "https://gw-merchant-staging.test.gifshow.com";
|
|
String appKey = "your appKey";
|
|
String signSecret = "your app signSecret";
|
|
String accessToken = "your accessToken";
|
|
|
|
AccessTokenKsMerchantClient client = new AccessTokenKsMerchantClient(url,appKey,signSecret);
|
|
|
|
OpenVirtualEticketCheckavailableRequest request = new OpenVirtualEticketCheckavailableRequest();
|
|
request.setAccessToken(accessToken);
|
|
request.setApiMethodVersion(1L);
|
|
|
|
request.setSellerId(211);
|
|
request.setBuyerId(211);
|
|
request.setOrderId(112);
|
|
request.setBizTypeCode("22");
|
|
List<AvailableETicketReq> list1 = new ArrayList<>();
|
|
AvailableETicketReq obj1 = new AvailableETicketReq();
|
|
obj1.setId("111");
|
|
obj1.setCode("112");
|
|
obj1.setNum(2);
|
|
list1.add(obj1);
|
|
request.setETicketList(list1);
|
|
|
|
OpenVirtualEticketCheckavailableResponse response = client.execute(request);
|
|
|
|
System.out.println(GsonUtils.toJSON(response));
|
|
}
|
|
}
|
|
|
|
响应示例
|
|
JSON
|
|
{
|
|
"result": 1,
|
|
"error_msg": "success",
|
|
"data": {
|
|
"sellerId": 1,
|
|
"buyerId": 1,
|
|
"orderId": 1,
|
|
"eticketType": "2"
|
|
}
|
|
}
|