获取运单数据

获取运单数据

调试工具

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

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

接口说明

接口英文名

getOrder

功能描述

该接口用于获取运单数据。

调用方式

HTTPS 调用

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

云调用

• 出入参和HTTPS调用相同，调用方式可查看云调用说明文档
• 接口方法为: openapi.logistics.getOrder

第三方调用

• 调用方式以及出入参和HTTPS相同，仅是调用的token不同
• 该接口所属的权限集id为：45、71
• 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用access_token或者authorizer_access_token
order_id	string	是	订单 ID，需保证全局唯一
openid	string	否	该参数仅在getOrder接口生效，batchGetOrder接口不生效。用户openid，当add_source=2时无需填写（不发送物流服务通知）
delivery_id	string	是	快递公司ID，参见getAllDelivery, 必须和waybill_id对应
waybill_id	string	否	运单ID
print_type	number	否	该参数仅在getOrder接口生效，batchGetOrder接口不生效。获取打印面单类型【1：一联单，0：二联单】，默认获取二联单
custom_remark	string	否

返回参数

	属性	类型	说明
	errcode	number	错误码
	errmsg	string	错误信息
	print_html	string	运单 html 的 BASE64 结果
	waybill_data	array	运单信息
	属性类型说明keystring运单信息 keyvaluestring运单信息 value
	order_id	string	订单ID
	delivery_id	string	快递公司ID
	waybill_id	string	运单号
	order_status	number	运单状态, 0正常，1取消

调用示例

示例说明: HTTPS调用

请求数据示例

{
  "order_id": "01234567890123456789",
  "openid": "oABC123456",
  "delivery_id": "SF",
  "waybill_id": "123456789",
  "print_type":1
} 

返回数据示例

{
  "print_html": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
  "waybill_data": [
    {
      "key": "SF_bagAddr",
      "value": "广州"
    },
    {
      "key": "SF_mark",
      "value": "101- 07-03 509"
    }
  ],
  "delivery_id": "SF",
  "waybill_id": "123456",
  "order_id": "123456",
  "order_status": 0
} 

示例说明: 云函数调用

请求数据示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.logistics.getOrder({
        "openid": 'oABC123456',
        "orderId": '01234567890123456789',
        "deliveryId": 'SF',
        "waybillId": '123456789',
        "printType": 1
      })
    return result
  } catch (err) {
    return err
  }
} 

返回数据示例

{
  "print_html": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
  "waybill_data": [
    {
      "key": "SF_bagAddr",
      "value": "广州"
    },
    {
      "key": "SF_mark",
      "value": "101- 07-03 509"
    }
  ],
  "delivery_id": "SF",
  "waybill_id": "123456",
  "order_id": "123456",
  "order_status": 0
} 

错误码

错误码	错误码取值	解决方案
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口