logistics.getOrder

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

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

获取运单数据

调用方式：

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
order_idstring是订单 ID，需保证全局唯一
openidstring否用户openid，当add_source=2时无需填写（不发送物流服务通知）
delivery_idstring是快递公司ID，参见getAllDelivery
waybill_idstring否运单ID

返回值

Object

属性类型说明
print_htmlstring运单 html 的 BASE64 结果
waybill_dataArray.<Object>运单信息
delivery_idstring快递公司ID
order_idstring订单ID
waybill_idstring运单号
order_statusnumber运单状态, 0正常，1取消

waybill_data 的结构

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

请求数据示例

  1. {
  2.   "order_id": "01234567890123456789",
  3.   "openid": "oABC123456",
  4.   "delivery_id": "SF",
  5.   "waybill_id": "123456789"
  6. }

返回数据示例

  1. {
  2.   "print_html": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
  3.   "waybill_data": [
  4.     {
  5.       "key": "SF_bagAddr",
  6.       "value": "广州"
  7.     },
  8.     {
  9.       "key": "SF_mark",
  10.       "value": "101- 07-03 509"
  11.     }
  12.   ],
  13.   "delivery_id": "SF",
  14.   "waybill_id": "123456",
  15.   "order_id": "123456",
  16.   "order_status": 0
  17. }

云调用

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

接口方法

  1. openapi.logistics.getOrder

需在 config.json 中配置 logistics.getOrder API 的权限，详情

请求参数

属性类型默认值必填说明
orderIdstring是订单 ID，需保证全局唯一
openidstring否用户openid，当add_source=2时无需填写（不发送物流服务通知）
deliveryIdstring是快递公司ID，参见getAllDelivery
waybillIdstring否运单ID

返回值

Object

属性类型说明
printHtmlstring运单 html 的 BASE64 结果
waybillDataArray.<Object>运单信息
deliveryIdstring快递公司ID
orderIdstring订单ID
waybillIdstring运单号
orderStatusnumber运单状态, 0正常，1取消

waybillData 的结构

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

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4.   try {
  5.     const result = await cloud.openapi.logistics.getOrder({
  6.         openid: 'oABC123456',
  7.         orderId: '01234567890123456789',
  8.         deliveryId: 'SF',
  9.         waybillId: '123456789'
  10.       })
  11.     console.log(result)
  12.     return result
  13.   } catch (err) {
  14.     console.log(err)
  15.     return err
  16.   }
  17. }

返回数据示例

  1. {
  2.   "printHtml": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
  3.   "waybillData": [
  4.     {
  5.       "key": "SF_bagAddr",
  6.       "value": "广州"
  7.     },
  8.     {
  9.       "key": "SF_mark",
  10.       "value": "101- 07-03 509"
  11.     }
  12.   ],
  13.   "deliveryId": "SF",
  14.   "waybillId": "123456",
  15.   "orderId": "123456",
  16.   "orderStatus": 0,
  17.   "errMsg": "openapi.logistics.getOrder:ok"
  18. }