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

文档中心 > 全渠道

速店通技术对接文档

更新时间:2018/06/14 访问次数:7548

一、基础说明                          

   若品牌商使用第三方软件服务商或自研的系统进行门店发货业务,则需要对接速店通系统的取号、打印、发货接口。速店通的详细业务介绍,参看:速店通业务说明

   

    对接的基本流程:

    1)阅读技术对接文档,熟悉对接的整体链路;

    2)确定对接技术方案;

    3)接口开发,调试接口;

    4)联调,商家总部拿几个线上订单进行接口测试(前期可以用商家自己的淘宝小号下单进行测试);

    5)1-2个门店上线系统验收(包括系统验收,打印机验收,和业务链路熟悉);

    6)逐量部署到各个门店。

二、接口说明

1.创建门店

   对接速店通,前提条件是货物从门店发货,不论是淘系订单还是非淘系订单都需要商家先在全渠道中心发布门店信息,门店信息是速店通的基础条件。

   创建门店的方式有两种:

        1)通过全渠道中心页面操作介绍

        2)通过奇门接口来创建介绍注:奇门接口的调用方式和TOP接口略有不同

2. 面单号获取接口(必接接口)

请务必确认门店有货可发货再取号,取号后再频繁地取消取号,会导致取消取号受到限制,参见电子面单平台对于取消取号的限制要求:点这里查看

    1)商家需要先获取电子面单号,具体接口请参看全渠道门店物流速店通取号接口:taobao.omniorder.store.getconsignmailcode(接口有更新,信息见3))。该接口需传入门店ID、订单信息和收发件人基本信息。

    说明:

    2)关于入参的要求:

  • 包裹金额必须大于等于1
  • 门店名称不能全是空字符
  • 门店联系人不能全是空字符
  • 门店联系方式必须是数字开头,由数字或者空格或者上划线、下划线组成
  • 收货人姓名不能全是空字符
  • 交易id不能全是空字符
  • 订单金额必须大于等于1
  • 商品id不能全是空字符
  • 商品名称不能全是空字符
  • 商品数量大于等于1
  • 返回信息中需要打印在面单纸上的信息都在print_data字段内返回,该字段内容用于后面的面单打印。

    3)接口更新

    目前已有接口:taobao.omniorder.store.sdtconsign(通知菜鸟裹裹发货)

    目前返回信息:

    {

      "omniorder_store_sdtconsign_response":{   

      "err_code":"123",   // 0 代表正常,否则异常   

      "message":"xx错误"  

       }

     }

     新增data字段,包含运力信息(包裹 id、商家 id、物流订单号、小件员姓名、小件员电话、接单网点以及接单 cp 等信息)

{"omniorder_store_sdtconsign_response":{       

   "err_code":"123",      // 0 代表正常,否则异常   

  

       "message":"xx错误",       

        "data":{           

               "packageId":0, // 包裹id        

          "sellerId":0,//商家id             

            "lpCodeList":"1111",//物流订单号list,目前只有一个值                      

            "deliveryUserName":"",//接单小件员姓名             

            "deliveryUserPhone":"",// 接单小件员电话                

            "dotName":"",//接单网点             

          "companyName":""//接单cp       

        }         

}

}

3. 电子面单打印(选择接入)

   电子面单打印需要使用菜鸟云打印组件,如果之前有过对接菜鸟电子面单,这部分可以直接复用,如果没有对接过,那么可以参看菜鸟云打印的说明文档:菜鸟云打印参考文档

   若已对接其他自有打印工具,可按照速店通面单模板创建打印模板,自行打印面单。

   说明:

    1)菜鸟云打印组件是完整的菜鸟电子面单对接方案,对于速店通场景,许多接口不是必须的。下面整理正常流程需要对接的接口:

  • 菜鸟模板编辑器,商家自定义区的设计在这里完成,只有在这里进行过配置,才可以通过用户自定义区获取接口拿到,速店通用户不需要自定义整个模板,统一使用菜鸟标准模板即可,参看说明
  • 获取菜鸟标准电子面单模板,速店通目前都对接标准模板:cloudprint.stdtemplates.get
  • 获取电子面单用户自定义区,需要商家在模板编辑器中使用了模板之后才会获取到。cloudprint.customareas.get
  • 打印机配置,菜鸟打印组件是以独立进程和打印机交互,浏览器或者其他客户端需要通过websocket协议与菜鸟打印组件进行通信,详细的协议格式说明
  • 打印:从获取面单号接口中返回的print_data里提取需要打印的字段内容,以及客户自定义区里获取的映射字段,整合在一起拼装成需要打印的报文,报文的demo参考文档

4. 速店通发货接口(必接)

    门店备好货,获取到了面单号,就可以调用速店通发货接口(走速店通发货的淘系订单不再需要使用taobao.logistics.online/offline.send接口发货了),接口调用后,该笔订单(淘系)状态会变为已发货,且平台会通知快递小哥上门揽货,一般快递公司都是下午到门店揽件。接口:taobao.omniorder.store.sdtconsign

5. 取消接口(选择接入)

请务必确认门店有货可发货再取号,取号后再频繁地取消取号,会导致取消取号受到限制,参见电子面单平台对于取消取号的限制要求:点这里查看

    原有top接口:taobao.omniorder.store.sdtcancel(通知速店通取消发货)

    内部逻辑增加对菜鸟运力单取消的支持,商家可以直接使用该接口,入参出参不做变更。

   入参:package_id

   出参:

   {        "omniorder_store_sdtcancel_response":{                        "result":{            

                  "err_msg":"error",  // 0 代表正常,否则异常               

                       "err_code":"123"                        }     } }

 

6. 物流流转信息查询接口(一般已对接过,不用再对接)

    用户根据淘宝交易号查询物流流转信息,如2010-8-10 15:23:00到达杭州集散地。 此接口的返回信息都由物流公司提供。接口:taobao.logistics.trace.search

 

FAQ:

1. Q:taobao.omniorder.store.getconsignmailcode接口的入参格式?

    A:这里给出trades字段的入参demo,这里是一个主订单,两个子订单申请面单号,入参trades={"trades":[{"main_order_id":"293626****846879","sub_orders":[{"items":[{"item_id":"34928***35371","name":"短袖T恤","count":"1","amount":295}],"sub_order_id":"293626*****4846879"},{"items":[{"item_id":"34928***35371","name":"短袖T恤","count":"1","amount":295}],"sub_order_id":"293626*****4846879"}]}]}

FAQ

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