koubei.trade.order.consult(口碑订单预咨询)

ISV下单前,可以通过此接口咨询用户优惠信息

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.trade.order.consult
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
request_id String 必选 64 唯一请求id,开放者请确保每次请求的唯一性 0ad1e47b1500473065347103327127
user_id String 必选 16 支付宝用户Id 2088212151390950
total_amount Price 必选 9 订单总金额,单位元,精确到小数点后两位,取值范围[0.01,999999999]
如果同时传入了【不可打折金额】,【订单总金额】两者,则必须满足【不可打折金额】<=【订单总金额】
88.88
undiscountable_amount Price 可选 9 不参与优惠计算的金额,单位为元,精确到小数点后两位,取值范围[0,999999999]
如果同时传入了【不可打折金额】、【订单总金额】,则必须满足【不可打折金额】<=【订单总金额】
10.00
shop_id String 必选 28 支付宝门店编号 2015051100077000000000000300
goods_info GoodsInfo[] 可选 商品明细列表。注意:单品总金额不能大于订单金额
goods_id String 必填 32 商户自定义商品外部编号 apple-01
goods_name String 必填 256 商户自定义商品名称 苹果手机
goods_category String 可选 24 商品类目 201701000
quantity String 必填 9 商品数量,支持小数,但是小数位不能超过两位 2
price Price 必填 9 商品单价,单位元,精确到小数点后两位,取值范围[0.01,100000000] 10.00

响应参数

参数 类型 是否必填 最大长度 描述 示例值
buyer_pay_amount Price 必填 9 用户实付金额 10.00
request_id String 选填 64 请求中的request_id 874JKK4H5J43H3K35J4543K5J3K45J34KJ
m_card_detail MCardDetail 选填 储值卡信息
name String 必填 256 储值卡名称 商家储值卡
available_amount Price 必填 9 储值卡可用余额 100000.00
pay_amount Price 必填 9 储值卡支付金额 1000.00
discount_detail DiscountDetail 选填 优惠信息
id String 必填 64 优惠ID或活动ID 2017CVCJD788E889EC
discount_desc String[] 可选 256 优惠描述,比如至多优惠XX元,满XX减XX 最高优惠10元;储值卡专属
discount_type String 必填 32 优惠类型,商家优惠(M_DISCOUNT),平台优惠(RT_DISCOUNT) RT_DISCOUNT
is_hit String 必填 8 优惠是否命中, true代表命中了优惠;false代表未命中优惠 true
is_purchased String 必填 8 是否是购买券, true代表是购买的券,false调表不是购买的券 true
name String 必填 256 优惠名称 5折优惠
discount_amount Price 可选 9 优惠金额 100.00

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiTradeOrderConsultRequest request = new KoubeiTradeOrderConsultRequest();
request.setBizContent("{" +
"\"request_id\":\"0ad1e47b1500473065347103327127\"," +
"\"user_id\":\"2088212151390950\"," +
"\"total_amount\":88.88," +
"\"undiscountable_amount\":10.00," +
"\"shop_id\":\"2015051100077000000000000300\"," +
"      \"goods_info\":[{" +
"        \"goods_id\":\"apple-01\"," +
"\"goods_name\":\"苹果手机\"," +
"\"goods_category\":\"201701000\"," +
"\"quantity\":\"2\"," +
"\"price\":10.00" +
"        }]" +
"  }");
KoubeiTradeOrderConsultResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_trade_order_consult_response": {
        "code": "10000",
        "msg": "Success",
        "buyer_pay_amount": 10,
        "request_id": "874JKK4H5J43H3K35J4543K5J3K45J34KJ",
        "m_card_detail": {
            "name": "商家储值卡",
            "available_amount": 100000,
            "pay_amount": 1000
        },
        "discount_detail": [
            {
                "id": "2017CVCJD788E889EC",
                "discount_desc": [
                    "最高优惠10元;储值卡专属"
                ],
                "discount_type": "RT_DISCOUNT",
                "is_hit": "true",
                "is_purchased": "true",
                "name": "5折优惠",
                "discount_amount": 100
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "koubei_trade_order_consult_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 系统繁忙,请稍后重试
INVALID_PARAMETER 参数有误 入参有误,请参考文档检查入参是否传错
SHOP_NOT_EXIST 店铺不存在 请检查传入的shop_id是否正确
ILLEGAL_SHOP_STATUS 店铺状态非法 店铺必须是OPEN状态,请检查店铺状态。
USER_NOT_EXIST 用户不存在 请检查传入的user_id是否正确
HAS_NO_PRIVILEGE 没有订单预咨询权限 传入的门店必须是商户授权的门店或ISV自己的门店,请检查传入门店是否真正确
ACCESS_IS_FORBIDDEN 服务禁止访问 业务灰度情况下,门店不在灰度名单,将返回此错误码
onlineServer