一、背景说明：

服务登记目前提供了：物流异常、商品退差价、发票申请登记、商品问题登记、售后维修登记、改地址登记、订单需求备注等标准业务场景表单，这些表单能帮助商家解决经营链路上的信息协同和触达处理。

随着使用的深入，服务登记应用需要与外部系统进行数据流转，打通数据内外循环。基于此提供针对表单数据记录的增删改查操作的API接口，具备对接能力的商家可通过调用API接口完成表单数据获取和处理等相关操作。

二、权限申请：

1）面向商家自研应用

商家后台系统类自研应用

权限获取方式：请符合需求的应用，通过登录开放平台控制台-》开发-》我的应用版块，找到对应应用点击应用管理进行申请。

在权限申请页面找到:智能应用-服务登记（新）权限点提交申请即可。 如果没有权限包申请入口，可以提交工单反馈，说明场景，走工单申请权限包。

2）面向服务商对接

目前面向已有淘宝开放平台应用的服务商开放 ，使用 <智能应用-服务登记（新）> API对接方式，也提供了奇门对接方案。

服务商对接技术方案 https://open.taobao.com/doc.htm?docId=121511&docType=1&spm=0.0.0.0.mhe1kB

注意：服务商获取商家的服务登记表数据，需要调用taobao.smartapp.template.service.switch接口帮助商家开通服务商数据同步。同步会在商家的服务登记的<流程管理>中会生成一条服务商的三方同步流，默认开启状态；后续商家可以自行开启或关闭流程，以及配置需要同步的工作表。

咨询服务：

通过添加钉钉群：【智能应用】服务登记答疑群（群号：30250002876），我们将在接收到咨询信息后评估和提供支持帮助。

三、对接方案概述：

对接API说明：

奇门接口

整体API调用说明：

数据组件说明：

四、接口详细说明：

查询工作表列表

taobao.smartapp.table.list.get

{
	"user_id": 36114 // 用户id
    
}

{
  "business_success": true,
  "request_id": "jl9wx29wcaty",
  "result": [
    {
      "create_time": "2023-07-19 14:44:45",
      "table_id": "auto_Z2vO5nt8",
      "table_name": "组件测试"
    },
    {
      "create_time": "2023-07-16 19:40:13",
      "table_id": "auto_SqozURF7",
      "table_name": "图片测试"
    },
    {
      "create_time": "2023-07-07 13:52:36",
      "table_id": "auto_eiPfuP30",
      "table_name": "组件测试1"
    },
    {
      "create_time": "2023-03-21 17:43:05",
      "table_id": "auto_gjiJH2TI",
      "table_name": "order预填测试"
    },
    {
      "create_time": "2023-03-21 17:40:18",
      "table_id": "auto_GszYiX30",
      "table_name": "未命名"
    },
    {
      "create_time": "2023-03-21 17:36:52",
      "table_id": "auto_tDShSzSf",
      "table_name": "订单预填测试"
    },
    {
      "create_time": "2023-03-21 17:27:08",
      "table_id": "auto_2LRIPMmr",
      "table_name": "测试自定义表单"
    },
    {
      "create_time": "2023-03-21 15:36:41",
      "table_id": "change_address",
      "table_name": "改地址登记"
    },
    {
      "create_time": "2023-03-21 15:36:41",
      "table_id": "product_customization",
      "table_name": "商品定制登记"
    },
    {
      "create_time": "2023-03-21 15:36:41",
      "table_id": "after_sales_repairing",
      "table_name": "售后维修登记"
    },
    {
      "create_time": "2023-03-21 15:36:41",
      "table_id": "refund_diff_price",
      "table_name": "商品退差价"
    },
    {
      "create_time": "2023-03-21 15:36:41",
      "table_id": "delay_send_good",
      "table_name": "延迟发货登记"
    },
    {
      "create_time": "2023-03-21 15:36:41",
      "table_id": "show_order",
      "table_name": "晒单登记"
    },
    {
      "create_time": "2023-03-21 15:36:41",
      "table_id": "submit_log",
      "table_name": "提交记录"
    },
    {
      "create_time": "2023-03-21 15:36:41",
      "table_id": "invoice_request",
      "table_name": "发票申请登记"
    },
    {
      "create_time": "2023-03-21 15:36:40",
      "table_id": "logistics_exception",
      "table_name": "物流异常"
    },
    {
      "create_time": "2023-03-21 15:36:40",
      "table_id": "product_trial",
      "table_name": "新品试用"
    },
    {
      "create_time": "2023-03-21 15:36:40",
      "table_id": "quality_of_goods",
      "table_name": "商品问题登记"
    },
    {
      "create_time": "2023-03-21 15:36:40",
      "table_id": "service_progress",
      "table_name": "服务进度"
    },
    {
      "create_time": "2023-03-21 15:36:40",
      "table_id": "refund_of_deposit",
      "table_name": "退定金登记"
    },
    {
      "create_time": "2023-03-21 15:36:40",
      "table_id": "item_exception",
      "table_name": "商品少发/错发"
    }
  ]
}

查询表单元数据

taobao.smartapp.table.meta.get

{
	"user_id": 36114 // 用户id
	"table_id": "item_exception" //待查询表名
}

{
  "business_success": true,
  "request_id": "jl9wxiftf9n2",
  "result": [
    {
      "component_type": "input",
      "custom_config": "{\"isRequired\":\"true\",\"maxLength\":3,\"textArea\":true}",
      "description": "文本",
      "field_name": "input_BroG77"
    },
    {
      "component_type": "input",
      "custom_config": "{\"isRequired\":\"false\",\"textArea\":false}",
      "description": "文本",
      "field_name": "input_l0SnW7"
    },
    {
      "component_type": "numberInput",
      "custom_config": "{\"isRequired\":\"false\",\"decimalPlaces\":3}",
      "description": "数值",
      "field_name": "numberInput_6_BFyA"
    },
    {
      "component_type": "select",
      "custom_config": "{\"isRequired\":\"false\",\"simpleEnumList\":[{\"color\":\"default\",\"checked\":false,\"id\":\"1\",\"text\":\"选项1\"},{\"color\":\"orange\",\"checked\":false,\"id\":\"2\",\"text\":\"选项2\"},{\"color\":\"blue\",\"checked\":false,\"id\":\"3\",\"text\":\"选项3\"},{\"color\":\"green\",\"checked\":false,\"id\":\"4\",\"text\":\"选项4\"}]}",
      "description": "单选",
      "field_name": "select_1DpFEK"
    },
    {
      "component_type": "datePick",
      "custom_config": "{\"isRequired\":\"false\",\"dateFormat\":\"YYYY-MM\"}",
      "description": "日期时间年月",
      "field_name": "datePick_a94msq"
    },
    {
      "component_type": "score",
      "custom_config": "{\"isRequired\":\"false\",\"iconType\":\"heart-filling\",\"count\":5}",
      "description": "评分",
      "field_name": "score_tVqQFp"
    },
    {
      "component_type": "image",
      "custom_config": "{\"isRequired\":\"false\",\"multi\":true}",
      "description": "图片",
      "field_name": "image_QikEBL"
    },
    {
      "children": [
        "{\"fieldName\":\"mainOrderId\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-主订单号\"}",
        "{\"fieldName\":\"subOrderId\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-子订单号\"}",
        "{\"fieldName\":\"img\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-商品图片\"}",
        "{\"fieldName\":\"status\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-订单状态\"}",
        "{\"fieldName\":\"createTime\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-创建时间\"}",
        "{\"fieldName\":\"payTime\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-付款时间\"}",
        "{\"fieldName\":\"title\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-商品标题\"}",
        "{\"fieldName\":\"quantity\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-购买数量\"}",
        "{\"fieldName\":\"skuInfo\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-SKU信息\"}",
        "{\"fieldName\":\"postPrice\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-运费\"}",
        "{\"fieldName\":\"unitPrice\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-单价\"}",
        "{\"fieldName\":\"actualPrice\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-实际付款金额\"}",
        "{\"fieldName\":\"auctionId\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-商品ID\"}",
        "{\"fieldName\":\"itemCode\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-外部商品编码\"}",
        "{\"fieldName\":\"logisticsDO\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"订单选取-物流信息\"}",
        "{\"fieldName\":\"sellerNick\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"商家账号\"}"
      ],
      "component_type": "orderSelect",
      "custom_config": "{\"isRequired\":\"false\",\"orderCreateType\":\"365\",\"orderStatus\":\"WAIT_SELLER_SEND_GOODS,WAIT_BUYER_CONFIRM_GOODS,WAIT_SELLER_CONFIRM_REFUND,WAIT_BUYER_PAY,TRADE_FINISHED,TRADE_CLOSED,ALL\"}",
      "description": "订单信息",
      "field_name": "orderSelect_GAjeA-"
    },
    {
      "children": [
        "{\"fieldName\":\"openId\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"淘宝账号-openUid\\n(与nick二选一)\"}",
        "{\"fieldName\":\"nick\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"淘宝账号-展示昵称\"}"
      ],
      "component_type": "taobaoAccount",
      "custom_config": "{\"isRequired\":\"false\"}",
      "description": "淘宝账号",
      "field_name": "taobaoAccount_ninefU"
    },
    {
      "component_type": "datePick",
      "custom_config": "{\"isRequired\":\"false\",\"dateFormat\":\"YYYY-MM-DD HH:mm:ss\"}",
      "description": "日期时间",
      "field_name": "datePick_ZCLDm6"
    },
    {
      "component_type": "image",
      "custom_config": "{\"isRequired\":\"false\"}",
      "description": "单图",
      "field_name": "image_A1isSY"
    },
    {
      "children": [
        "{\"fieldName\":\"fullName\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"收货地址-收货人\"}",
        "{\"fieldName\":\"mobile\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"收货地址-手机号码\"}",
        "{\"fieldName\":\"province\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"收货地址-省\"}",
        "{\"fieldName\":\"city\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"收货地址-市\"}",
        "{\"fieldName\":\"area\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"收货地址-区\"}",
        "{\"fieldName\":\"town\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"收货地址-镇\"}",
        "{\"fieldName\":\"addressDetail\",\"customConfig\":\"{\\\"isRequired\\\":\\\"false\\\"}\",\"description\":\"收货地址-详细地址\"}"
      ],
      "component_type": "receivingInfo",
      "custom_config": "{\"isRequired\":\"false\",\"customerBasicInfo\":true,\"addressLevel\":\"详细地址\"}",
      "description": "收货信息",
      "field_name": "receivingInfo_Qj4oKP"
    },
    {
      "component_type": "select",
      "custom_config": "{\"isRequired\":\"false\",\"simpleEnumList\":[{\"color\":\"default\",\"checked\":false,\"id\":1,\"text\":\"待审核\"},{\"color\":\"orange\",\"checked\":false,\"id\":2,\"text\":\"审核中\"},{\"color\":\"blue\",\"checked\":false,\"id\":3,\"text\":\"审核通过\"},{\"color\":\"default\",\"checked\":false,\"id\":7,\"text\":\"已驳回\"}]}",
      "description": "审核状态",
      "field_name": "status"
    }
  ]
}

查询工单数据

taobao.smartapp.table.get

查询创建日期的起始时间，若“创建 起始时间与结束时间”与“修改 起始时间与结束时间”两组数据均传入，仅筛选创建时间，默认按照查询条件倒叙排序

查询修改日期的起始时间，仅当“创建 起始时间与结束时间”均未传入时，筛选修改时间，并按修改时间倒叙排序

PS数据全量初始化和增量查询说明：

为了避免数据获取存在漏单或者指定时间不精确导致的数据记录获取不完整，提供如下解决方案：

①：对于已经建表并且表内已经有具体数据记录的应用，首次获取全量数据或者初始化数据，可通过指定创建时间（指定：start_created和end_created）且无需指定修改时间的方式来获取。这样可获取一段时间以来的全量初始数据。

②：在完成第①步后，可以根据订阅taobao_smartapp_DataSync消息，监控获取到发生变更或者新增的记录数据，当监控到有变更消息时可以通过查询工单数据接口获取指定发生变更或者新增的记录数据，实现准实时同步。

PS:消息taobao_smartapp_DataSync的启用可通过开放平台应用控制台-》开发-》应用-》消息服务-》订阅消息板块来完成消息接口订阅

③：在完成第①步的指定时间范围全量数据记录初始化、第②步的变更数据消息更新同步后，在后期围绕数据的管理主要是获取新增和发生变更的数据记录，为了绝对精确避免数据遗漏针对增量数据，可以通过设置固定频率的修改时间分片查询来获取，这样可以明确和精准衔接查询到指定修改时间周期内产生的新增数据记录和变更记录。

{
    "table_id": "test_table", // 待查询表名
    "start_created": "2022-06-26 08:30:30", // 查询创建日期的起始时间，优先筛选创建时间，若创建时间条件为空再筛选修改时间，默认按照查询条件倒叙排序
    "end_created": "2022-06-27 08:30:30", // 查询创建日期的终止时间
    "start_modified": "2022-06-26 08:30:30", // 查询修改日期的起始时间
    "end_modified": "2022-06-27 08:30:30", // 查询修改日期的终止时间    
    
    "page_index": 0, // 分页参数，默认为页面索引为0
    "page_size": 200 // 分页参数，默认为页面容量为200
}

{
  "request_id": "772qbnirnjz4",
  "result": {
    "json_record": [
      "{\"record\":{\"input_BroG77\":\"123\",\"orderSelect_GAjeA-\":{\"unitPrice\":\"0.01\",\"img\":\"https://img.alicdn.com/imgextra/i3/2207337577157/O1CN01taECFQ22jxE9wcD6z_!!2-item_pic.png\",\"quantity\":1,\"actualPrice\":\"0.01\",\"postPrice\":\"0.0\",\"title\":\"码尚定制Matchu的测试商品2,请不要拍\",\"auctionId\":\"623987461846\",\"logisticsDO\":{\"area\":\"余杭区\",\"province\":\"浙江省\",\"city\":\"杭州市\"},\"subOrderId\":\"1813427545035881950\",\"createTime\":\"2023-02-07 20:23:30\",\"mainOrderId\":\"1813427545035881950\",\"status\":\"交易关闭\"},\"status\":\"待审核\"},\"last_modified_date\":1689835519000,\"id\":\"TjNVMUMxOW9qdEpBSnpiVGZwVUJhUT09\",\"created_date\":1689835519000}",
      "{\"record\":{\"input_BroG77\":\"123\",\"taobaoAccount_ninefU\":{\"nick\":\"交**\",\"openId\":\"AAGrLelzAF5F4XsqJW7A3RSP\"},\"status\":\"待审核\"},\"last_modified_date\":1689830763000,\"id\":\"N0YxR1pZZWd5cnQ5MzNMRmNha3ZBZz09\",\"created_date\":1689830763000}",
      "{\"record\":{\"input_BroG77\":\"数值\",\"orderSelect_GAjeA-\":{\"unitPrice\":\"0.01\",\"img\":\"https://img.alicdn.com/imgextra/i3/2207337577157/O1CN01taECFQ22jxE9wcD6z_!!2-item_pic.png\",\"quantity\":1,\"actualPrice\":\"0.01\",\"postPrice\":\"0.0\",\"title\":\"Byredo专属定制 礼献挚爱的测试商品1,请不要拍\",\"auctionId\":\"623742836009\",\"logisticsDO\":{\"area\":\"余杭区\",\"province\":\"浙江省\",\"city\":\"杭州市\"},\"subOrderId\":\"3322408681420741412\",\"createTime\":\"2023-04-26 14:28:58\",\"mainOrderId\":\"3322408681420741412\",\"status\":\"交易关闭\"},\"status\":\"待审核\"},\"last_modified_date\":1689823927000,\"id\":\"SER6eVdkRWEzQTUxdEphbXlwWkptZz09\",\"created_date\":1689823927000}",
      "{\"record\":{\"input_BroG77\":\"123\",\"status\":\"待审核\"},\"last_modified_date\":1689821319000,\"id\":\"Tm10Vklnbmcra3pJTmNRL0F0SlBxZz09\",\"created_date\":1689821319000}",
      "{\"record\":{\"input_BroG77\":\"1\",\"status\":\"待审核\"},\"last_modified_date\":1689819714000,\"id\":\"aHdVMitQU0xxVDM3dFgwMTlBcXgydz09\",\"created_date\":1689819714000}",
      "{\"record\":{\"score_tVqQFp\":\"5\",\"input_BroG77\":\"数值\",\"status\":\"待审核\"},\"last_modified_date\":1689781088000,\"id\":\"dkFLZnB4S21ZeThsbDRnOVpIbDdLQT09\",\"created_date\":1689781088000}",
      "{\"record\":{\"input_BroG77\":\"数值\",\"numberInput_6_BFyA\":\"1.123\",\"status\":\"待审核\"},\"last_modified_date\":1689781049000,\"id\":\"cmNOUjRkaFpsWjZ4QTBvY2FpL0JkQT09\",\"created_date\":1689781049000}",
      "{\"record\":{\"input_BroG77\":\"地址\",\"receivingInfo_WmS-EK\":{\"province\":\"河南省\",\"city\":\"洛阳市\"},\"status\":\"待审核\"},\"last_modified_date\":1689775889000,\"id\":\"NGlhWTUrOEFhMThtdm5nNUx4QnBFUT09\",\"created_date\":1689775889000}",
      "{\"record\":{\"input_BroG77\":\"地址\",\"receivingInfo_WmS-EK\":{\"province\":\"河南省\",\"city\":\"郑州市\"},\"status\":\"待审核\"},\"last_modified_date\":1689775869000,\"id\":\"TzlHZXVTNWFKR3BqWU84MFExb1JUUT09\",\"created_date\":1689775869000}",
      "{\"record\":{\"input_BroG77\":\"地址\",\"receivingInfo_WmS-EK\":{\"province\":\"河南省\",\"city\":\"郑州市\"},\"status\":\"待审核\"},\"last_modified_date\":1689775821000,\"id\":\"Nk8xeXgvOTdmYnkyQ1R2dmZmaHJCUT09\",\"created_date\":1689775821000}",
      "{\"record\":{\"input_BroG77\":\"地址\",\"receivingInfo_GURJTE\":{\"province\":\"河南省\"},\"status\":\"待审核\"},\"last_modified_date\":1689775570000,\"id\":\"U3FEajl2dllaSnppRTNZcXdVc0R2QT09\",\"created_date\":1689775570000}",
    ]
  }
}

更新工单数据

taobao.smartapp.table.update

{
    "table_id": "tableName", //待更新表名
    
	"id": "aW9sRThNQUhJRDA3djNqNDE0bFhFZz09", // 待更新数据主键ID
    // 更新数据，字段名称参考表单元数据接口
	"record": "{\"score_9PYwoV\":\"4\"}"
	
}

{
  "business_success": true,
  "count": 1,
  "request_id": "772qbnv9iaq5"
}

五、错误码解释