查询智慧零售订单
接口说明
| 接口url | https://api.mch.weixin.qq.com/v3/payscore/smartretail-orders |
|---|---|
请求方式 |
GET |
前置条件
商户下单已受理后。
请求参数
| 变量名 | 所处位置 | 数据类型 | 必填 | 描述 |
|---|---|---|---|---|
| service_id | path | String(32) | 是 | 该服务ID有本接口对应产品的权限 需要与创建订单时保持一致. |
| out_order_no | path | string(32) | 否 | 商户系统内部服务订单号（不是交易单号），要求32个字符内，只能是数字、大小写字母_-|* 且在同一个商户号下唯一。详见商户订单号 需要和创建智慧零售订单的商户服务订单号一致。 |
| query_id | path | String(64) | 否 | 微信侧回跳到商户前端时用于查单的单据查询id.详见章节”小程序跳转接口.回跳商户接口”。 商户单号与回跳查询id必填其中一个.不允许都填写或都不填写 |
| appid | path | string(32) | 是 | 微信公众平台分配的与传入的商户号建立了支付绑定关系的appid，可在公众平台查看绑定关系 需要在本系统先进行配置. 需要与创建订单时保持一致." |
请求包体样例：
curl “https://api.mch.weixin.qq.com/payscore/smartretail-orders?service_id=500001&out_order_no=8416518464133&appid=wxd678efh567hg6787”
或
curl “https://api.mch.weixin.qq.com/payscore/smartretail-orders?service_id=500001&query_id=brnbonve1465wq3q2&appid=wxd678efh567hg6787”
或
curl “https://api.mch.weixin.qq.com/payscore/smartretail-orders?service_id=500001&query_id=brnbonve1465wq3q2&appid=wxd678efh567hg6787”
返回结果
| 状态码 | 含义 | 描述 |
|---|---|---|
| 200 | OK | 处理成功 |
| 其它 | 异常应答 | 处理失败，详见 接口规则 |
状态码为 200 时 返回以下信息
| 变量名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| appid | string(32) | 是 | wxd678efh567hg6787 | 调用接口提交的公众账号ID |
| mchid | string(32) | 是 | 1230000109 | 调用接口提交的商户号 |
| out_order_no | string(32) | 是 | 1234323JKHDFE1243252 | 调用接口提交的商户服务订单号 |
| service_id | string(32) | 是 | 500001 | 调用该接口提交的服务ID |
| state | string(32) | 是 | CREATED | 表示当前单据状态. CREATED:商户下单已受理 USER_ACCEPTED:用户成功使用服务 FINISHED:商户完结订单 USER_PAID:用户订单支付成功 REVOKED:商户撤销订单 EXPIRED:订单已失效. “商户下单已受理”状态超过1小时未变动，则订单失效 |
| finish_type | int | 否 | 2 | 标识用户订单使用情况： 1 未使用服务，取消订单； 2 完成服务使用，结束订单 |
| service_start_time | string(16) | 是 | 20091225091010 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日0点0分0秒 |
| service_end_time | string(16) | 否 | 20091225091210 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日23点59分59秒 |
| real_service_start_time | string(16) | 否 | 20091225091010 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日0点0分0秒 |
| real_service_end_time | string(16) | 否 | 20091225091210 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日23点59分59秒 |
| pay_succ_time | string(16) | 否 | 20091225091210 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日0点0分0秒 |
| service_start_location | string(20) | 是 | 嗨客时尚主题展餐厅 | 开始使用服务的地点. 不超过20个字符，超出报错处理 |
| service_end_location | string(20) | 否 | 嗨客时尚主题展餐厅 | 预计服务结束的地点，用户下单时未确认服务结束地点时，可不填写. 不超过20个字符，超出报错处理 |
| real_service_end_location | string(20) | 否 | 嗨客时尚主题展餐厅 | 服务结束的地点 不超过20个字符，超出报错处理 |
| service_introduction | string(20) | 是 | 嗨客餐厅用餐 | 服务信息，用于介绍本订单所提供的服务 不超过20个字符，超出报错处理 |
| fees | array | 是 | none | 后付费，最多包含100条付费项目 参见Fee表格说明 |
| discounts | array | 否 | none | 商户优惠，最多包含5条商户优惠 参见Discount表格说明 |
| risk_amount | int | 是 | 100000 | 大于0的数字，单位为分 当填写了【优惠金额】字段时，订单风险金额需满足：付费项目金额之和-优惠项目金额之和<订单风险金额 订单风险金额不能超出每个服务ID的风险金额上限 |
| total_amount | int | 否 | 40000 | 大于等于0的数字，单位为分 需满足：总金额=付费项目金额之和-商户优惠项目金额之和<=订单风险金额 未使用服务，取消订单时，该字段必须填0. |
| attach | string(200) | 否 | attach | 商户数据包,可存放本订单所需信息. 需要先urlencode后传入. 总长度不大于200字符,超出报错处理. |
| finish_ticket | string(512) | 否 | finish_ticket | 用于完结订单时传入,确保订单完结时数据完整. 只有单据状态为USER_ACCEPTED才返回完结凭证 |
| finish_transaction_id | string(200) | 否 | 131654644 | 结单交易单号，等于普通支付接口中的transaction_id，可以使用该订单号在APP支付->API列表->查询订单、申请退款。只有单据状态为USER_PAID，且收款成功渠道为支付分渠道，收款金额大于0，才会返回结单交易单号。 |
| pay_type | string | 否 | MchChannelPayType | 支付方式，枚举值： MchChannelPayType-商户渠道类型 |
FEE
| 变量名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| fee_name | string(20) | 是 | 阿萨姆瓶装奶茶 | 不超过20个字符，超出报错处理 |
| fee_count | int | 否 | 2 | 数量，付费项目数量，大于等于1且小于等于100，不填默认为1 |
| fee_amount | int | 否 | 800 | 此付费项目总金额，大于等于0，单位为分，等于0时代表不需要扣费 |
| fee_desc | string(30) | 否 | 每分钟1元 | 描述计费规则，不超过30个字符，超出报错处理 |
Discount
| 变量名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| discount_name | string(20) | 是 | 满20减1元 | 不超过20个字符，超出报错处理 |
| discount_amount | int | 否 | 1 | 大于等于0的数字，单位为分 |
| discount_desc | string(30) | 否 | 不与其他优惠叠加 | 不超过30个字符，超出报错处理 |
请求包体样例：
{
"appid": "wxd678efh567hg6787",
"mchid": "1230000109",
"out_order_no": "1234323JKHDFE1243252",
"service_id": "500001",
"state": "CREATED",
"finish_type": 2,
"service_start_time": "20091225091010",
"service_end_time": "20091225091210",
"real_service_start_time": "20091225091010",
"real_service_end_time": "20091225091210",
"service_start_location": "嗨客时尚主题展餐厅",
"service_end_location": "嗨客时尚主题展餐厅",
"real_service_end_location": "嗨客时尚主题展餐厅",
"service_introduction":"嗨客餐厅用餐",
"fees": [{
"fee_name": "服务费",
"fee_amount": 40000,
"fee_desc": "每分钟1元"
}],
"discounts": [{
"discount_name": "满20减1元",
"discount_amount": 1,
"discount_desc": "不与其他优惠叠加"
}],
"risk_amount": 100000,
"total_amount": 40000,
"attach": "attach",
"finish_ticket": "finish_ticket",
"finish_transaction_id": "131654644"
"pay_type": "MchChannelPayType"
}
错误码
参见错误码列表