通用场景
商户同步小程序订单到订单中心,在c端场景需要透传订单相关的实时信息时,商户可通过接口返回订单实时信息,如司机距离、配送员位置等信息。
公共请求参数
业务请求参数
body参数
merchant_order_no|外部订单号特殊可选string(128)
【描述】外部订单号:商户自己系统内的订单id,需与商户同步支付宝订单中心入参的商户订单id相同。单比查询必须传入该字段
【示例值】7695428890423
merchant_order_nos|商家外部订单号特殊可选string(2000)
【描述】逗号分隔的外部订单号:商户自己系统内的订单id,需与商户同步支付宝订单中心入参的商户订单id相同。一般会控制在20个之内,如果需要支持批量查询能力该字段必传
【示例值】769,542,889,042,376,000,000,000,000,000,000,000,000
常见请求示例
默认示例
curl -x post 'spi_implementation_url?sign=${sign}&method=spi.alipay.merchant.order.realtimeinfo.query&charset=utf-8&version=1.0&utc_timestamp=${now}&sign_type=rsa2' \
--header 'content-type: application/x-www-form-urlencoded;charset=utf-8' \
--data-urlencode 'merchant_order_no=7695428890423' \
--data-urlencode 'merchant_order_nos=769,542,889,042,376,000,000,000,000,000,000,000,000'
说明:spi_implementation_url是开发者在开放平台实现spi接口时填写的后端服务地址,详情请查看接入接口
业务响应参数
response
code必选string
【描述】错误码,只有两种:
成功-10000
失败-40004
返回其他值会被认为非法响应,区分大小写。
成功-10000
失败-40004
返回其他值会被认为非法响应,区分大小写。
【示例值】40004
msg必选string
【描述】错误描述,只有两种:
成功-success
失败-business failed
返回其他值会被认为非法响应,区分大小写。
成功-success
失败-business failed
返回其他值会被认为非法响应,区分大小写。
【示例值】business failed
success|是否成功必选string(10)
【描述】是否成功查询到数据,值为true/false
【示例值】true
result|结果特殊可选string(30000)
【描述】json格式的结果,返回约定的所有信息,当success为true时必填。如果是批量查询实现,返回格式为{"key1":json1,"key2":json2},如{"7695428890423":{"driver_board_duration":"360"},"7695428890424":{"driver_board_duration":"628"}}
【示例值】{"merchant_order_status":"merchant_orderd","driver_board_distance":"2600","driver_board_duration":"360"}
error_code|错误码特殊可选string(128)
【描述】商户自定义的错误码,当success为false时必填,便于排查问题,可参考文档示例的错误码来定义
【示例值】biz_error
error_desc|错误描述特殊可选string(128)
【描述】商户自定义错误码对应的描述,当success为false时必填,便于排查问题
【示例值】当前订单不在进行中状态
sub_code可选string
【描述】业务错误码,在业务失败的情况下返回,与 spi 接口文档里的“业务错误码”保持一致,值不能为 null 或 “”,在业务成功的情况下不能返回。
【示例值】invalid_params
sub_msg可选string
【描述】业务错误描述,在业务失败的情况下返回。
【示例值】无效参数
sign必选string
【描述】签名,详见商家签名规则
【示例值】dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=
响应示例
正常示例
异常示例
{
"response": {
"code": "10000",
"msg": "success",
"success": "true",
"result": "{\"merchant_order_status\":\"merchant_orderd\",\"driver_board_distance\":\"2600\",\"driver_board_duration\":\"360\"}",
"error_code": "biz_error",
"error_desc": "当前订单不在进行中状态"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
biz_error | 业务异常 | 商户业务错误,联系isv解决 |
invalid_parameter | 参数有误 | 参数不合法,自行排查或联系isv解决 |
system_error | 系统繁忙 | 商户系统异常,联系isv解决 |
接口工具
spi使用文档
获取sdk