接口地址
生产环境:
https://cus.allinpay.com/cusapi/sybserviceapi/querystockdetail
测试环境:
https://syb-test.allinpay.com/vsppcusapi/sybserviceapi/querystockdetail
使用场景:
通过此接口可查询批次信息,包括批次的配置信息以及批次概况数据。
请求参数:
参数 |
参数名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
orgid |
代理商号 |
|
否 |
15 |
代理商必填 |
cusid |
商户号 |
|
否 |
15 |
必填 |
appid |
代理商应用ID |
|
否 |
8 |
平台分配的代理商APPID |
version |
版本号 |
接口版本号 |
可 |
2 |
默认填11 |
randomstr |
随机字符串 |
商户自行生成的 随机字符串 |
否 |
32 |
|
sign |
签名 |
详见安全规范 |
否 |
32 |
|
signtype |
签名类型 |
|
否 |
4 |
RSA/SM2 |
stockid |
批次号微信为 每个代金券批次分配的唯一id |
|
否 |
20 |
|
响应参数:
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
retcode |
返回码 |
SUCCESS/FAIL |
否 |
8 |
此字段是通信标识,非交易结果 |
retmsg |
返回码说明 |
|
是 |
100 |
|
以下信息只有当retcode为SUCCESS时有返回 |
|||||
cusid |
商户号 |
|
否 |
15 |
|
appid |
代理商应用ID |
|
否 |
15 |
|
randomstr |
随机字符串 |
随机生成的 字符串 |
否 |
32 |
|
sign |
签名 |
|
否 |
32 |
详见安全规范 |
availablebegintime |
可用开始时间 |
|
否 |
|
可用开始时间,遵循rfc3339标准格式 格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE YYYY-MM-DD表示年月日, T出现在字符串中,表示time元素的开头 HH:mm:ss.sss表示时分秒毫秒 TIMEZONE表示时区 (+08:00表示东八区时间,领先UTC 8小时,即北京时间) 例如:2015-05-20T13:29:35.120+08:00 表示北京时间2015年5月20日 13点29分35秒。 |
availableendtime |
可用结束时间 |
|
否 |
|
参考availablebegintime说明 |
createtime |
创建时间 |
|
否 |
|
创建时间 |
description |
使用说明 |
|
否 |
|
使用说明 |
distributedcoupons |
已发券数量 |
|
否 |
|
已发券数量 |
nocash |
是否无资金流 |
true/false |
|
|
是否无资金流 ture:是 |
singleitem |
是否单品优惠 |
|
否 |
|
枚举值: |
status |
批次状态 |
|
否 |
|
批次状态 |
stockcreatormchid |
创建批次的 商户号 |
|
否 |
|
批次创建方商户号。 |
stockid |
批次号 |
|
否 |
|
批次号 |
stockname |
批次名称 |
|
否 |
|
批次名称 |
stocktype |
批次类型 |
|
|
|
批次类型, 枚举值: |
stockuserule |
Object |
|
|
|
普通发券批次特定信息。 |
stockuserule 批次特定信息
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
max_coupons |
发放总上限 |
|
|
|
发放总上限 |
max_amount |
总预算 |
|
|
|
总预算 |
max_amount_by_day |
单天发放上限金额 |
|
|
|
单天发放上限金额 |
max_coupons_per_user |
单个用户可领个数 |
|
|
|
|
coupon_type |
券类型 |
|
|
|
券类型 |
goods_tag |
订单优惠标记 |
|
|
|
订单优惠标记 |
trade_type |
支付方式 |
|
|
|
支付方式 |
combine_use |
是否可叠加其他优惠 |
|
|
|
|
fixed_normal_coupon |
Object |
|
|
|
固定面额批次特定信息 |
fixed_normal_coupon固定面额发券批次特定信息
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
coupon_amount |
面额 |
|
|
|
面额 |
transaction_minimum |
门槛 |
|
|
|
门槛 |