logistics.batchGetOrder

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

批量获取运单数据

调用方式:

HTTPS 调用

请求地址

  1. POST https://api.weixin.qq.com/cgi-bin/express/business/order/batchget?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
order_listArray.<Object>订单列表, 最多不能超过100个

order_list 的结构

属性类型默认值必填说明
order_idstring订单ID
delivery_idstring快递公司ID,参见getAllDelivery
waybill_idstring运单ID

返回值

Object

属性类型说明
order_listArray.<Object>运单列表
order_statusnumber运单状态, 0正常,1取消

order_list 的结构

属性类型说明
errcodenumber错误码
errmsgstring错误信息
order_idstring订单ID
delivery_idstring快递公司ID,参见getAllDelivery
waybill_idstring运单ID
print_htmlstring运单 html 的 BASE64 结果
waybill_dataArray.<Object>运单信息

order_list.waybill_data 的结构

属性类型说明
keystring运单信息 key
valuestring运单信息 value

请求数据示例

  1. {
  2. "order_list": [
  3. {
  4. "order_id": "01234567890123456789",
  5. "delivery_id": "SF",
  6. "waybill_id": "123456789"
  7. },
  8. {
  9. "order_id": "01234567890123456789",
  10. "delivery_id": "SF",
  11. "waybill_id": "123456789"
  12. }
  13. ]
  14. }

返回数据示例

  1. {
  2. "order_list": [
  3. {
  4. "errcode": 0,
  5. "errmsg": "ok",
  6. "order_id": "01234567890123456789",
  7. "delivery_id": "SF",
  8. "waybill_id": "123456789",
  9. "print_html": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
  10. "waybill_data": [
  11. {
  12. "key": "SF_bagAddr",
  13. "value": "广州"
  14. },
  15. {
  16. "key": "SF_mark",
  17. "value": "101- 07-03 509"
  18. }
  19. ],
  20. "order_status": 0
  21. },
  22. {
  23. "errcode": 0,
  24. "errmsg": "ok",
  25. "order_id": "01234567890123456789_2",
  26. "delivery_id": "SF",
  27. "waybill_id": "123456789_2",
  28. "print_html": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
  29. "waybill_data": [
  30. {
  31. "key": "SF_bagAddr",
  32. "value": "广州"
  33. },
  34. {
  35. "key": "SF_mark",
  36. "value": "101- 07-03 509"
  37. }
  38. ],
  39. "order_status": 0
  40. }
  41. ]
  42. }

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.logistics.batchGetOrder

需在 config.json 中配置 logistics.batchGetOrder API 的权限,详情

请求参数

属性类型默认值必填说明
orderListArray.<Object>订单列表, 最多不能超过100个

orderList 的结构

属性类型默认值必填说明
orderIdstring订单ID
deliveryIdstring快递公司ID,参见getAllDelivery
waybillIdstring运单ID

返回值

Object

属性类型说明
orderListArray.<Object>运单列表
orderStatusnumber运单状态, 0正常,1取消

orderList 的结构

属性类型说明
errcodenumber错误码
errmsgstring错误信息
orderIdstring订单ID
deliveryIdstring快递公司ID,参见getAllDelivery
waybillIdstring运单ID
printHtmlstring运单 html 的 BASE64 结果
waybillDataArray.<Object>运单信息

orderList.waybillData 的结构

属性类型说明
keystring运单信息 key
valuestring运单信息 value

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init({
  3. env: cloud.DYNAMIC_CURRENT_ENV,
  4. })
  5. exports.main = async (event, context) => {
  6. try {
  7. const result = await cloud.openapi.logistics.batchGetOrder({
  8. orderList: [
  9. {
  10. orderId: '01234567890123456789',
  11. deliveryId: 'SF',
  12. waybillId: '123456789'
  13. },
  14. {
  15. orderId: '01234567890123456789',
  16. deliveryId: 'SF',
  17. waybillId: '123456789'
  18. }
  19. ]
  20. })
  21. return result
  22. } catch (err) {
  23. return err
  24. }
  25. }

返回数据示例

  1. {
  2. "orderList": [
  3. {
  4. "errcode": 0,
  5. "errmsg": "ok",
  6. "orderId": "01234567890123456789",
  7. "deliveryId": "SF",
  8. "waybillId": "123456789",
  9. "printHtml": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
  10. "waybillData": [
  11. {
  12. "key": "SF_bagAddr",
  13. "value": "广州"
  14. },
  15. {
  16. "key": "SF_mark",
  17. "value": "101- 07-03 509"
  18. }
  19. ],
  20. "orderStatus": 0
  21. },
  22. {
  23. "errcode": 0,
  24. "errmsg": "ok",
  25. "orderId": "01234567890123456789_2",
  26. "deliveryId": "SF",
  27. "waybillId": "123456789_2",
  28. "printHtml": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
  29. "waybillData": [
  30. {
  31. "key": "SF_bagAddr",
  32. "value": "广州"
  33. },
  34. {
  35. "key": "SF_mark",
  36. "value": "101- 07-03 509"
  37. }
  38. ],
  39. "orderStatus": 0
  40. }
  41. ],
  42. "errMsg": "openapi.logistics.batchGetOrder:ok"
  43. }