注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > 聚石塔

订单全链路监控产品接入

更新时间:2023/08/04 访问次数:39191

一、接入流程


image.png


1. 申请权限包


订单全链路监控是基于订单整个生命周期上各关键节点的处理效率的量化指标监控,主要面向订单处理类的应用开放,开放的应用标签包括:商家后台系统、服务商后台系统、在线订购应用、订单付费、分销应用、仓储管理系统、国际商家后台系统、国际服务商后台系统、千牛插件、ERP软件、订单管理、进销存软件、品牌商全渠道、全渠道ERP。

开发者可直接登陆开放平台控制台,选择你要接入订单全链路监控的应用,进入应用管理,在应用详情中申请"(新)订单履行链路监控"权限包。


image.png

 

2. 开通服务


开发者登陆零售云工作平台,为"应用开发&稳定性"->"订单履行链路监控",为指定商家添加开通订单全链路监控服务或采用api接口开通商家全链路监控;


2.1 在控制台开通


image.png


2.2 使用api开通


提交申请开通全链路监控服务审批后,平台会自动分配接口权限到您提交申请的appkey,下载最新sdk即可使用。


接口名称 接口描述
taobao.qimen.trade.user.add 添加全链路监控用户
taobao.qimen.trade.user.delete 删除全链路监控用户
taobao.qimen.trade.users.get 查询全链路监控用户

 

3. 数据回流


ISV或商家开通订单全链路监控服务后,ISV或商家负责将业务系统中订单转单、订单客审处理状态实时回传到订单全链路监控中心,平台会自动增加淘宝段的订单状态,最终形成订单整个生命周期数据。若商家业务系统通知wms发货未对接奇门,需要先完成奇门ERP&WMS系统对接。为了提升商家订单状态回流效率,平台支持两种不同的订单状态回流方式,根据商家业务现状,可二选一;


api回流


接口名称 接口描述
taobao.qimen.event.produce

单条订单状态数据回流

taobao.qimen.events.produce 批量订单状态回流


基于以上两个API进行单条业务数据回流、或批量回流。


api数据回流代码样例

① 单个消息回流

调用taobao.qimen.event.produce将商家订单业务处理状态实时进行回传,示例代码为已转单状态数据回传:


Public class Test{
         Public static void main(String [] args){
             TaobaoClient client=new DefaultTaobaoClient(url, appkey, secret);
             QimenEventProduceRequest req=newQimenEventProduceRequest();
                 req.setStatus("QIMEN_ERP_TRANSFER");
             req.setTid(12231221231232L);
             QimenEventProduceResponse response = client.execute(req,sessionkey);
             System.out.println(rsp.getBody());
        }
}


② 批量消息回传

调用taobao.qimen.events.produce将商家店铺多个订单相同业务处理状态批量进行回传,示例代码:


Public class Test{
   Public static void main(String [] args){
      TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
      QimenEventsProduceRequest req = new QimenEventsProduceRequest();
      List<QimenEvent> eventList = new ArrayList<QimenEvent>();
      QimenEvent qimenEvent = new QimenEvent();
          eventList.add(qimenEvent);
          Event event = new Event();
               event.setTid(12231221231232L);
               event.setStatus("QIMEN_ERP_TRANSFER");
          qimenEvent.setEvent(event);
          req.setMessages(eventList);
      QimenEventsProduceResponse rsp = client.execute(req);
      }
}


4. 全链路监控


完成全链路订单状态回流后,开发者可以将商家订单全链路实时监控大屏和历史监控大屏嵌入到业务系统中进行展示,也可以引导商家登陆到官方控制台进行查看,商家端监控大屏入口地址如下:

商家订单全链路实时监控作战大屏:(https://qimen.taobao.com/trade/screen/index.htm#/?_k=j8wbha)

商家订单全链路监控大屏:(https://qimen.taobao.com/fullChannel/index.htm#/completeRate/true?_k=fxvxti)

全渠道控制台:(http://oto.taobao.com/index.htm#/iframe/orderLink?_k=adibsl)

生意参谋订单监控大屏:(https://qimen.taobao.com/trade/screen/trade.htm#/now)


二、全链路监控回流状态结构


订单回流状态 订单状态描述 是否必须 备注
QIMEN_ERP_TRANSFER ERP转单 ERP将推送库订单转到业务库后回流该订单状态
QIMEN_ERP_CHECK ERP审单 ERP完成订单审单后回流该订单状态
QIMEN_CP_NOTIFY ERP通知配货 商家订单若走奇门创建出库单,无须回流该状态,若未对接奇门需要回传该状态
QIMEN_CP_OUT 仓库通知ERP出库 商家订单若走奇门创建出库单,无须回流该状态,若未对接奇门需要回传该状态


三、常见问题


1)API回流与APM回流,如何选择?

APM回流:需要在服务器上安装AliAPM提供日志agent,用于抓取日志。目前只限于聚石塔环境。 这种方法将回流逻辑和业务分开,不影响原业务代码,只需要打点指定的字段即可。并且APM回流,不占机器的网络带宽。

API回流,不局限于环境,可以在任何系统中使用。


2)通知配货与出库节点如何回流?

通知配货与出库节点属于仓库处理环节,当前不支持服务商回流方式。服务商需要对接奇门仓储才能展示该数据。


3)数据展示时间和业务时间不一致,如何解决?

订单履行链路,使用的时间为回流时间,并不是业务发生时间。因此,为了准确展示数据,请实时回流业务处理信息。


4)生意参谋全链路监控大屏的数据从何而来?如何完善未监控到的订单链路数据?

生意参谋全锭路监控大屏的数据来源两部份,一部份是平台官方数据(买家付款订单状态,数据推送订单状态,天猫发货订单状态),另一部份数据来自于第三方应用订单状态回流(订单下载、订单客审、通知配货、仓库出货),若第三方应用订单状态回流数据不完整,建议商家联系第三方应用服务商补全订单全链路监控状态。


5)已对接了老的订单状态回流接口,是否需要重新使用新的接口进行对接?

平台已对新老订单状态回流接口做了兼容,若已经使用了老的订单状态回流,只需要按参考本文档第二点为商家开通权限即可,通过接口或控制台添加商家即可查看监控大屏数据。

FAQ

关于此文档暂时还没有FAQ
返回
顶部