阅读(1739)
赞(14)
微信小程序 小程序使用·batchGetOrder
2020-07-29 11:43:37 更新
logistics.batchGetOrder
本接口应在服务器端调用，详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载）
wx-server-sdk >= 0.4.0
批量获取运单数据
调用方式：
- HTTPS 调用
- 云调用
HTTPS 调用
请求地址
POST https://api.weixin.qq.com/cgi-bin/express/business/order/batchget?access_token=ACCESS_TOKEN
请求参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | 接口调用凭证 | |
| order_list | Array.<Object> | 是 | 订单列表, 最多不能超过100个 |
order_list 的结构
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| order_id | string | 是 | 订单ID | |
| delivery_id | string | 是 | 快递公司ID，参见getAllDelivery
|
|
| waybill_id | string | 否 | 运单ID |
返回值
Object
| 属性 | 类型 | 说明 |
|---|---|---|
| order_list | Array.<Object> | 运单列表 |
| order_status | number | 运单状态, 0正常，1取消 |
order_list 的结构
| 属性 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| order_id | string | 订单ID |
| delivery_id | string | 快递公司ID，参见getAllDelivery
|
| waybill_id | string | 运单ID |
| print_html | string | 运单 html 的 BASE64 结果 |
| waybill_data | Array.<Object> | 运单信息 |
order_list.waybill_data 的结构
| 属性 | 类型 | 说明 |
|---|---|---|
| key | string | 运单信息 key |
| value | string | 运单信息 value |
请求数据示例
{
"order_list": [
{
"order_id": "01234567890123456789",
"delivery_id": "SF",
"waybill_id": "123456789"
},
{
"order_id": "01234567890123456789",
"delivery_id": "SF",
"waybill_id": "123456789"
}
]
}
返回数据示例
{
"order_list": [
{
"errcode": 0,
"errmsg": "ok",
"order_id": "01234567890123456789",
"delivery_id": "SF",
"waybill_id": "123456789",
"print_html": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
"waybill_data": [
{
"key": "SF_bagAddr",
"value": "广州"
},
{
"key": "SF_mark",
"value": "101- 07-03 509"
}
],
"order_status": 0
},
{
"errcode": 0,
"errmsg": "ok",
"order_id": "01234567890123456789_2",
"delivery_id": "SF",
"waybill_id": "123456789_2",
"print_html": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
"waybill_data": [
{
"key": "SF_bagAddr",
"value": "广州"
},
{
"key": "SF_mark",
"value": "101- 07-03 509"
}
],
"order_status": 0
}
]
}
云调用
云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。
接口方法
openapi.logistics.batchGetOrder
需在 config.json 中配置 logistics.batchGetOrder API 的权限，详情
请求参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| orderList | Array.<Object> | 是 | 订单列表, 最多不能超过100个 |
orderList 的结构
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| orderId | string | 是 | 订单ID | |
| deliveryId | string | 是 | 快递公司ID，参见getAllDelivery
|
|
| waybillId | string | 否 | 运单ID |
返回值
Object
| 属性 | 类型 | 说明 |
|---|---|---|
| orderList | Array.<Object> | 运单列表 |
| orderStatus | number | 运单状态, 0正常，1取消 |
orderList 的结构
| 属性 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| orderId | string | 订单ID |
| deliveryId | string | 快递公司ID，参见getAllDelivery
|
| waybillId | string | 运单ID |
| printHtml | string | 运单 html 的 BASE64 结果 |
| waybillData | Array.<Object> | 运单信息 |
orderList.waybillData 的结构
| 属性 | 类型 | 说明 |
|---|---|---|
| key | string | 运单信息 key |
| value | string | 运单信息 value |
请求数据示例
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.logistics.batchGetOrder({
orderList: [
{
orderId: '01234567890123456789',
deliveryId: 'SF',
waybillId: '123456789'
},
{
orderId: '01234567890123456789',
deliveryId: 'SF',
waybillId: '123456789'
}
]
})
return result
} catch (err) {
return err
}
}
返回数据示例
{
"orderList": [
{
"errcode": 0,
"errmsg": "ok",
"orderId": "01234567890123456789",
"deliveryId": "SF",
"waybillId": "123456789",
"printHtml": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
"waybillData": [
{
"key": "SF_bagAddr",
"value": "广州"
},
{
"key": "SF_mark",
"value": "101- 07-03 509"
}
],
"orderStatus": 0
},
{
"errcode": 0,
"errmsg": "ok",
"orderId": "01234567890123456789_2",
"deliveryId": "SF",
"waybillId": "123456789_2",
"printHtml": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
"waybillData": [
{
"key": "SF_bagAddr",
"value": "广州"
},
{
"key": "SF_mark",
"value": "101- 07-03 509"
}
],
"orderStatus": 0
}
],
"errMsg": "openapi.logistics.batchGetOrder:ok"
}