微信小程序开发文档微信小程序小程序使用·getOrder

2024-02-25 开发教程微信小程序开发文档匿名 4℃

logistics.getOrder

本接口应在服务器端调用，详细说明参见服务端API。本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载）
wx-server-sdk >= 0.4.0

获取运单数据

调用方式：

HTTPS 调用
云调用

HTTPS 调用

请求地址

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

请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证
order_id	string	是	订单 ID，需保证全局唯一
openid	string	否	用户openid，当add_source=2时无需填写（不发送物流服务通知）
delivery_id	string	是	快递公司ID，参见`getAllDelivery`, 必须和waybill_id对应
waybill_id	string	否	运单ID

返回值

Object

属性	类型	说明
print_html	string	运单 html 的 BASE64 结果
waybill_data	Array.<Object>	运单信息
delivery_id	string	快递公司ID
order_id	string	订单ID
waybill_id	string	运单号
order_status	number	运单状态, 0正常，1取消

waybill_data 的结构

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

请求数据示例

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

返回数据示例

{
  "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
}

云调用

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

接口方法

openapi.logistics.getOrder

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

请求参数

属性	类型	必填	说明
orderId	string	是	订单 ID，需保证全局唯一
openid	string	否	用户openid，当add_source=2时无需填写（不发送物流服务通知）
deliveryId	string	是	快递公司ID，参见`getAllDelivery`, 必须和waybill_id对应
waybillId	string	否	运单ID

返回值

Object

属性	类型	说明
printHtml	string	运单 html 的 BASE64 结果
waybillData	Array.<Object>	运单信息
deliveryId	string	快递公司ID
orderId	string	订单ID
waybillId	string	运单号
orderStatus	number	运单状态, 0正常，1取消

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.getOrder({
        openid: 'oABC123456',
        orderId: '01234567890123456789',
        deliveryId: 'SF',
        waybillId: '123456789'
      })
    return result
  } catch (err) {
    return err
  }
}

返回数据示例

{
  "printHtml": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
  "waybillData": [
    {
      "key": "SF_bagAddr",
      "value": "广州"
    },
    {
      "key": "SF_mark",
      "value": "101- 07-03 509"
    }
  ],
  "deliveryId": "SF",
  "waybillId": "123456",
  "orderId": "123456",
  "orderStatus": 0,
  "errMsg": "openapi.logistics.getOrder:ok"
}

上一节：微信小程序小程序使用·getAllDelivery

下一节：微信小程序小程序使用·getPath

"微信小程序开发文档"的目录

微信小程序开发文档 微信小程序 小程序使用·getOrder

logistics.getOrder

HTTPS 调用

请求地址

请求参数

返回值

Object

请求数据示例

返回数据示例

云调用

接口方法

请求参数

返回值

Object

请求数据示例

返回数据示例

微信小程序开发文档微信小程序小程序使用·getOrder