商品和订单查询详细说明

七鱼调用企业商品、订单查询接口时的请求、签名、分页和响应结构。

商品、订单查询

业务流程说明

通过设置订单、商品查询接口，支持访客自主查询信息，并发送至人工客服会话中。

三方服务需在设置-访客端，定义好以下3项内容：

访客点击查询入口时，七鱼携带userId向三方查询服务地址发起请求。 ** 首次请求时不携带标签页ID（tabId），三方服务默认返回首个标签页信息

业务时序图

访客端样式

接口定义

七鱼向三方查询数据：

请求参数

请求头

参数	字段类型	是否必须	参数说明
appid	String	否	企业的appId
nonce	String	是	随机字符串
time	String	是	当前UTC时间戳，秒为单位
checksum	String	是	SHA1(appSecret+nonce+time)将三个参数拼接的字符串，进行SHA1哈希计算

Body

content-type： "application/json", 接口需要支持json形式的body请求

参数	字段类型	是否必须	参数说明
pageNo	Integer	是	当前页码（从1开始）
pageSize	Integer	是	每页展示信息数量（默认5）
tabId	String	否	商品订单列表中的标签页ID（若不传tabId，默认返回第一tab页数据。*即不传tabId时，代表用户第一个tab查询
userId	String	是	用户ID
fromType	String	否	来源类型： iOS：苹果设置 android ：安卓 WEB：网页端 wx ：微信公从号 wx_ma：微信小程序 wb：微博 wx_sdk ：微信小程序sdk接入 wx_work：企微员工原生接入 douyin：抖音 baidu ：百度 wxkf：微信客服 facebook：脸书 wx_cs ：企微客户接入 twitter line whatsapp feishu：飞书 dingding：钉钉 instagram discord wxworkweb ：企微员工见面接入：youzan：有赞 weimob：微盟
fromSubType	String	否	终端明细：来源类型的详细信息，与管理端导出会话的终端明细相同
fromPage	String	否	来源页：或为空，url

响应参数

三方返回查询数据

参数	字段类型	是否必须	参数说明
code	Integer	是	返回码，如200
message	String	是	错误信息
data	Object	是	返回商品标签页信息

data结构说明

参数	字段类型	是否必须	参数说明
dataList	List	否	标签页商品订单信息列表（入参未传tabId时，dataList默认返回第一个标签页数据）不支持订单&商品混合，只能单类型消息传递
tabList	List	是	标签页列表，标签页数量不可超过5个
currentTabId	String	是	当前标签页ID
pageNo	Integer	是	页码（从1开始）
pageSize	Integer	是	页大小
total	Long	是	记录数

dataList结构说明

eventType=1时，订单字段对应显示位置如下：

参数	字段类型	是否必须	参数说明
orderId	String	是	订单ID
orderTime	String	否	时间，例：2021-01-21 01:00
orderSku	String	否	sku描述
orderCount	Integer	否	数量
orderStatus	String	否	状态描述，如：已发货、待支付
eventType	Integer	是	共两种类型：1-订单，2-商品
picture	String	是	缩略图url
title	String	是	标题
desc	String	否	描述
payMoney	String	否	价格，例如：¥19.99

eventType=2时，商品字段对应显示位置如下：

信息按照如下字段对应位置显示

参数	字段类型	是否必须	参数说明
eventType	Integer	是	共两种类型：1-订单，2-商品
picture	String	是	缩略图url
title	String	是	标题
desc	String	否	描述
price	String	否	价格，例如：¥19.99
url	String	否	商品卡片点击跳转链接

tabList结构说明

参数	字段类型	是否必须	参数说明
tabId	String	是	标签页ID
tabName	String	是	标签页名称

示例

请求示例

curl --location --request POST 'https://{yourAddress}' \
--header 'checksum: f29fb3e9707142f7e74e539b5adaa788628d6b1e' \
--header 'time: 1642415268' \
--header 'appid: nehiuylkdifhhids' \
--header 'nonce: zdfdiufedofxncbn' \
--header 'content-type: application/json' \
--data-raw '{
"pageNo": 1,
"pageSize": 5,
"userId": "342566432",
"tabId": "first"
}'

返回示例

订单

   {
   "code": 200,
   "message": "查询成功",
   "data": {
       "pageNo": 1,
       "pageSize": 3,
       "operateTitle": "请选择你要咨询的内容",
       "total": 10,
       "currentTabId": "first",
       "dataList": [
           {
               "orderName": "订单号",
               "orderId": "00000000000000000001",
               "orderTime": "2021-08-23 19:23",
               "skuName": "可口可乐瓶装 330ml",
               "orderCount": 5,
               "orderStatus": "未发货",
               "eventType": 1,
               "picture": "[https://gimg2.baidu.com/image_search](https://gimg2.baidu.com/image_search)",
               "title": "可口可乐 330ml",
               "desc": "2022春节大促",
               "price": "¥19.99"
           },
           {
               "orderName": "订单号",
               "orderId": "00000000000000000002",
               "orderTime": "2021-08-23 19:24",
               "skuName": "可口可乐瓶装 450ml",
               "orderCount": 5,
               "orderStatus": "未发货",
               "eventType": 1,
               "picture": "[https://gimg2.baidu.com/image_search2](https://gimg2.baidu.com/image_search2)",
               "title": "可口可乐 330ml",
               "desc": "2022元旦大促",
               "price": "¥29.99"
           }
       ],
       "tabList": [
           {
               "tabId": "first",
               "tabName": "未发货"
           },
           {
               "tabId": "second",
               "tabName": "已发货"
           },
           {
               "tabId": "third",
               "tabName": "售后"
           },
           {
               "tabId": "fifth",
               "tabName": "待配送"
           }
       ]
   }
}

商品

 {
   "code":200,
   "message":"查询成功",
   "data":{
       "pageNo":1,
       "pageSize":3,
       "operateTitle":"请选择你要咨询的内容",
       "total":10,
       "currentTabId":"first",
       "dataList":[
           {
               "url":"[http://baidu.com](http://baidu.com)",
               "eventType":2,
               "picture":"[https://gimg2.baidu.coml](https://gimg2.baidu.coml)",
               "title":"可口可乐 330ml",
               "desc":"2022春节大促",
               "price":"19.99"
           },
           {
               "url":"[http://baidu.com/2](http://baidu.com/2)",
               "eventType":2,
               "picture":"[https://gimg2.baidu.coml](https://gimg2.baidu.coml)",
               "title":"可口可乐 220ml",
               "desc":"2022元旦大促",
               "price":"19.99"
           }
       ],
       "tabList":[
           {
               "tabId":"first",
               "tabName":"未发货"
           },
           {
               "tabId":"second",
               "tabName":"已发货"
           },
           {
               "tabId":"third",
               "tabName":"售后"
           },
           {
               "tabId":"fifth",
               "tabName":"待配送"
           }
       ]
   }
}

商品和订单查询详细说明

目录