简介

开发者接入物流查询插件，需接入订单中心产品并通过 alipay.merchant.order.sync（订单数据同步接口）同步物流信息，同步成功后即可免费使用物流查询插件更清晰地展示物流信息变化，提升用户的消费体验。

**注意：**物流查询插件需接入 订单中心 产品并同步物流信息才可正常使用。

应用示例

接入指南

第一步：订购物流查询插件

首先需要在能力中心订购物流查询插件，点击 立即订购 后，选择插件需要绑定的应用，点击 授权并绑定 后，即表示订购成功，可以在小程序内使用插件。

注意：上图的应用列表中，开发者需选择接入了订单中心的小程序的 APPID。

第二步：小程序内引入插件

在小程序的订单详情页引入物流插件，插件引入方案可查看插件使用。

小程序 app.json 中引入插件，示例代码如下：

provider：物流查询插件的 AppID ，固定为 2021001155688526 。

version：插件版本，目前只支持设置 * 即拉取当前上架最新版本。

"plugins": {
    "myPlugin": {
      "version": "*", 
      "provider": "2021001155688526"
 }
}

第三步：组件内入参

express-find-helper 组件

接收 props ，必传参数说明如下：

waybillNo：物流运单号；

logisticsCode：物流公司编码，点此查看编码，若查询不到对应的物流公司编号，则说明该物流公司还未和支付宝合作，组件内无法展示物流信息；

deviceType：组件类型，需入参值为 C ，注意参数值是大写；

tradeNo ：支付宝交易号。

**注意：**请确保对应订单已使用 alipay.merchant.order.sync（订单数据同步接口）回传物流信息，否则插件无法展示物流进度，回传方式见 接入指南 > 异步同步 > 物流信息同步 模块。

引入物流查询插件小程序页面的 .json 文件，示例代码如下：

{
  "usingComponents": {
    "express-find-helper": "plugin://myPlugin/express-find-helper" 
 }
}

引入物流查询插件小程序页面的 .axml 文件，示例代码如下：

**说明：**示例值可查看下文 插件自定义事件 .js 文件 onLoad 函数中定义的 data。

<express-find-helper  
   waybillNo="{waybillNo}"  
   logisticsCode="{logisticsCode}"  
   tradeNo="{tradeNo}"  
   diviceType="{diviceType}"/>

插件自定义事件

开发者可在 init 及 error 状态后自定义插件事件用于处理不同情况下业务流程：

init：初始化完成事件，此时可以做后续业务操作。

error：加载失败等业务异常事件。

Page({
  data: {
    // ...  },
  onLoad() {
     this.setData({
      tradeNo:'your teadeNo',
      logisticsCode:'your logisticsCode',
      waybillNo:'your waybillNo',
      diviceType:'C',
    });
    });
   // 防止页面跳转 <-> 回退导致重复绑定插件相关事件    
    const app = getApp();
    if (!app.hasBoundPluginEvents) {
      this.usePluginApi();
    }
  },
  usePluginApi() {
    const plugin = requirePlugin('myPlugin');
    const myExpress = plugin.getExpressInstance();
    myExpress.on('init', (url) => {
      console.log(url);
      myExpress.goLogsiticsDetail();
    });
    myExpress.on('error', (errormsg) => {
      my.showToast({
        content: errormsg || '系统繁忙，请稍后再试',
      });
    });
    const app = getApp();
    app.hasBoundPluginEvents = true;
  },
});

物流查询插件

简介#

应用示例#

接入指南#

第一步：订购物流查询插件#

第二步：小程序内引入插件#

第三步：组件内入参#