ISV 订单查询
公共参数
请求地址
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
公共请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
method | String | 是 | 128 | 接口名称 | alipay.trade.order.settle |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
version | String | 是 | 3 | 版本号,默认1.0 | 1.0 |
biz_app_id | String | 否 | 32 | 商户app_id | 2014072300007148 |
invoke_app_id | String | 否 | 32 | 调用方app_id | 2014072300007148 |
utc_timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
请求参数
Header
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
Query
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
order_id | String | 必选 | 100 | 订单ID | 20201127221723456009800123 |
data_type | String | 必选 | 15 | 订单信息:ORDER 订单+SKU:SKU 订单+物流:LOGISTIC 订单+SKU+物流:ALL | ORDER |
fields | String[] | 可选 | 255 | 返回值参数列表 | ["logistic_id","logistic_channel"] |
公共响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,参见具体的API接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,参见具体的API接口文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
id | String | 必填 | 100 | 订单信息:订单ID | 20201127221723456009800123 |
status | String | 必填 | 64 | 订单信息:订单状态 | 未下单/准备中/待收货/已完成 |
order_create_time | String | 必填 | 15 | 订单信息:订单创建时间 | 2020-11-27 11:23:45 |
amount | Price | 必填 | 100 | 订单信息:付款金额 | 四川成都 |
channel | String | 选填 | 64 | 订单信息:订单来源渠道 淘宝/拼多多/京东 | 淘宝 |
link_url | String | 选填 | 255 | 订单信息:订单链接地址 | http://www.taobao.com |
is_send_timeout | String | 必填 | 5 | 订单信息:订单是否发货超时 | Y |
after_sale_status | String | 选填 | 64 | 订单信息:订单售后状态 | 已退货 |
after_sale_refuse | String | 选填 | 511 | 订单信息:拒绝售后的备注信息 | 商品服务无问题 |
item_title | String | 必填 | 255 | 商品信息:订单首个商品名称 | 汽车雨刷器 |
item_category | String | 选填 | 100 | 商品分类:多个商品则取第一个商品分类 | 汽车配件 |
item_provider | String | 选填 | 64 | 商品信息: 商品供应商 | 吉利 |
item_icon | String | 选填 | 255 | 商品信息:商品图片 多个商品取第一个商品的图片 | http://taobao.com/134.jpg |
is_presale_item | String | 选填 | 5 | 商品信息:商品是否为预售商品 多个商品则取第一个商品 | true |
logistic_status | String | 选填 | 16 | 物流状态:多个物流则取第一个物流的状态 | 运输中 |
logistic_stop_up_time | Number | 选填 | 5 | 物流信息:停止更新时间,单位:小时 多个物流则取第一个物流的停更时间 | 28 |
sku_count | Number | 必填 | 10 | 商品(SKU)数量 | 10 |
skus | SkuDetail | 选填 | 商品(SKU)详情列表 | ||
logistic_count | Number | 必填 | 10 | 物流数量 | 1 |
logistics | LogisticDetail | 选填 | 物流详情列表 |
响应示例
{
"response": {
"code": "10000",
"msg": "Success",
"id": "20201127221723456009800123",
"status": "未下单/准备中/待收货/已完成",
"order_create_time": "2020-11-27 11:23:45",
"amount": 1,
"channel": "淘宝",
"link_url": "http://www.taobao.com",
"is_send_timeout": "Y",
"after_sale_status": "已退货",
"after_sale_refuse": "商品服务无问题",
"item_title": "汽车雨刷器",
"item_category": "汽车配件",
"item_provider": "吉利",
"item_icon": "http://taobao.com/134.jpg",
"is_presale_item": "true",
"logistic_status": "运输中",
"logistic_stop_up_time": 28,
"sku_count": 10,
"skus": [
{
"sku_id": "sku001002003004005",
"spu_id": "spu001002003004005006007",
"category": "汽车配件",
"icon": "http://taobao.com/123",
"brand": "佳洁士",
"provider": "自营供应商",
"is_presale": true
}
],
"logistic_count": 1,
"logistics": [
{
"logistic_id": "2945564001002003",
"channel": "菜鸟物流",
"status": "待发货",
"ship_area": "广东佛山",
"ship_period": 48,
"stop_update_time": 15
}
]
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
异常示例
{
"response": {
"code": "40004",
"msg": "Business Failed",
"sub_code": "BIZ_ERROR",
"sub_msg": "业务异常数据查询异常"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
业务错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
BIZ_ERROR | 业务异常数据查询异常 | 请检查订单ID和业务类型是否正确 |
修改于 2023-11-27 06:10:04