尘锋SCRM开放平台
  1. 预约单
尘锋SCRM开放平台
  • 接入前准备
    • 接口鉴权说明
    • 回调接入指南
    • 报错code码说明
    • 省市区code码
    • 获取附件URL访问签名
    • 更新日志
  • 对接方案介绍
    • 联系人架构介绍
    • 员工概览
    • ERP打通
    • 客户信息打通
    • 订单打通
    • 微信unionid互通场景
    • 获客助手对接场景
  • API文档
    • 客户
      • 联系人
        • 联系人管理
          • 查询联系人
          • 新增联系人
          • 编辑联系人
          • 删除联系人
          • 编辑联系人状态
          • 获取联系客户统计数据
          • 外部ID
            • 删除联系人外部ID
            • 更新联系人外部ID
            • 绑定外部ID与联系人ID
        • 联系人字段ID
          • 查询联系人自定义字段模板
          • 查询跟进状态列表
          • 查询联系人公海列表
          • 无效&放弃&删除原因查询
          • 联系人类型与标签和自定义字段关联关系
          • 联系人类型
          • 联系人联系方式
          • 多级联选列表
          • 来源
            • 来源列表查询(企业&联系人)
            • 编辑来源
            • 创建来源
        • 标签库
          • 给联系人打标签
          • 好友标签(企业微信标签)
            • 查询好友标签列表
            • 编辑好友标签
            • 新增好友标签
          • 联系人标签
            • 编辑联系人标签值
            • 新增联系人标签组
            • 编辑联系人标签组
            • 新增联系人标签值
            • 查询联系人标签列表
        • 跟进团队
          • 编辑(联系人/企业)共享人
          • 查询创建⼈跟进⼈和共享⼈
        • 跟进提醒
          • 查询跟进提醒
          • 新增跟进提醒
          • 编辑跟进提醒
          • 完成跟进提醒
          • 删除跟进提醒
        • 跟进记录
          • 查询跟进记录
          • 查询跟进记录模板
          • 新增跟进记录
        • 在职继承
          • 分配在职成员联系人
          • 查询接替状态
        • 签到
          • 查询签到记录
        • 行为轨迹
          • 轨迹参数说明
          • 上报轨迹事件
          • 查询轨迹事件
          • 查询旅程项目
      • 企业
        • 企业字段ID
          • 查询企业字段ID
          • 查询企业跟进状态
          • 查询企业公海列表
          • 来源列表查询(企业&联系人)
          • 查询企业类型
          • 查询企业删除原因
          • 查询多级联选
        • 企业管理
          • 查询企业列表
          • 新增企业
          • 编辑企业
          • 删除企业
          • 企业绑定联系人
          • 更新企业跟进人
          • 放弃企业到公海
          • 分配公海中企业
        • 企业标签
          • 查询企业标签
      • 好友
        • 查询好友列表
        • 编辑好友信息
        • 好友关联联系人
        • 好友取消关联联系人
        • unionId上传&关联externalUserId
      • 客户群
        • 查询客户群列表
        • 查询客户群详情
        • 编辑客户群标签
        • 查询群标签列表
        • 查询群聊数据统计-按群主聚合方式
        • 查询群聊数据统计-按自然日聚合方式
    • 销售机会
      • 销售机会管理
        • 查询销售机会列表
        • 新增销售机会
        • 编辑销售机会
        • 删除销售机会
        • 新增销售机会协同人
        • 移除销售机会协同人
        • 销售机会绑定订单
        • 销售机会解绑订单
        • 销售机会阶段变更记录
      • 销售机会字段ID
        • 查询销售机会字段ID
        • 查询销售机会类型
        • 查询销售机会阶段
        • 查询协同角色ID
        • 查询竞争对手
        • 查询丢单原因
        • 查询销售机会多级联选选项
        • 修改销售机会多级联选选项
    • 交易
      • 订单
        • 查询订单列表
        • 新增&编辑订单
        • 查询订单自定义字段ID
        • 修改订单归属人/归属部门
        • 订单发货
        • 查询物流公司列表
        • 查询订单来源
        • 编辑自主下单
      • 售后单
        • 查询售后单列表
        • 创建售后单
        • 售后单操作退款
      • 回款单
        • 查询回款单列表
        • 创建回款单
      • 会员积分
        • 查询会员列表
        • 新增会员
        • 变更会员等级
        • 查询会员等级变更明细
        • 变更会员积分
        • 变更会员成长值
        • 查询会员积分变更明细
      • 商品类
        • 查询商品列表
        • 查询商品详情
        • 新增商品
        • 商品图片/视频上传
        • 编辑商品库存
    • 员工
      • 查询员工信息
      • 编辑员工信息
      • 部门信息查询
      • 批量为员工启用系统
      • 给员工发送企微通知
    • 预约单
      • 查询预约列表
    • 评论
      • 查询评论列表接口
    • 运营
      • 活码
        • 查询活码详情
        • 查询活码列表
      • 表单
        • 查询表单字段模板
        • 查询表单填写内容
      • sop
        • 查询sop列表
        • 查询sop执行情况列表
      • 素材
        • 查询素材列表
        • 查询素材详情
        • 查询员工发送素材明细
      • 营销任务
        • 查询营销任务执行情况
        • 查询营销任务列表
      • 朋友圈
        • 获取企业发布的朋友圈员工执行情况
        • 获取朋友圈的互动数据
        • 获取企业全部发布列表
      • 获客助手短链
        • 查询获客助手来源及链接信息
        • 查询获客助手配置列表
        • 获取专属短链详情列表
        • 生成用户专属短链接
    • 会话存档
      • 上传会话存档记录
    • 通话短信
      • 查询通话记录列表
      • 电销手机外呼
      • 查询通话录音转文字结果
      • 查询短信记录列表
    • 页面嵌入
      • 页面嵌入配置说明
      • 解密嵌入页面传参
      • 菜单嵌入说明
    • 应用
      • 楼盘管理
        • 查询楼盘
        • 新增楼盘
        • 删除楼盘
      • 外联盟管理
        • 查询外联盟
        • 新增外联盟
        • 编辑外联盟
        • 删除外联盟
        • 启停用外联盟
        • 查询外联盟字段ID
        • 外联盟多级联选选项
  • 事件推送
    • 联系人
      • 新增联系人事件
      • 编辑联系人事件
      • 联系人跟进状态变更事件
      • 删除联系人事件
      • 联系人合并事件
      • 跟进提醒
        • 联系人跟进提醒状态变更
      • 联系人流转
        • 跟进团队变更事件
        • 联系人流转事件
      • 跟进记录
        • 跟进记录操作事件
    • 好友
      • 添加好友事件
      • 好友与联系人绑定事件
      • 好友与联系人解绑事件
      • 好友主动删除员工事件
      • 员工主动删除好友事件
      • 更新好友信息事件
    • 客户群
      • 新增客户群事件
      • 变更客户群事件
      • 解散客户群事件
    • 销售机会
      • 销售机会负责人变更
      • 销售机会协同人变更
      • 销售机会操作事件
    • 企业
      • 企业跟进团队流转事件
      • 企业新增事件
      • 编辑企业事件
      • 企业跟进状态变更事件
      • 企业删除事件
    • 交易
      • 推送说明
      • 订单
        • 新增订单事件
        • 编辑订单事件
        • 订单状态变更事件
        • 订单支付完成事件
        • 删除订单事件
      • 售后单
        • 售后单创建事件
        • 编辑售后单事件
        • 售后单状态变更事件
        • 删除售后单事件
        • 售后单退款成功事件
      • 商品
        • 新增商品事件
        • 商品库存变更事件
        • 编辑商品事件
        • 商品状态变更事件
      • 会员积分
        • 新增会员事件
        • 会员合并事件
        • 成长值变更事件
        • 会员等级变更事件
        • 会员积分变更事件
    • 工单
      • 新增工单事件
      • 流转工单事件
      • 编辑工单事件
    • 运营
      • 提交表单事件
    • 通话短信
      • 通话记录操作事件
      • 短信记录操作事件
    • 预约单
      • 新增预约单事件
    • 应用
      • 楼盘
        • 新增楼盘事件
        • 编辑楼盘事件
        • 删除楼盘事件
      • 外联盟
        • 新增外联盟事件
        • 编辑外联盟事件
        • 删除外联盟事件
        • 启/停外联盟事件
        • 外联盟审批完成事件
  1. 预约单

查询预约列表

应用场景
1.通过本接口可查询到预约单的预约列表数据
POST https://qw-openapi-tx.dustess.com/appointment/order/v1/page-list?accessToken=

Content-Type: application/json
请求参数
参数名类型说明是否必须
pageInt查询页码true
page_sizeInt查询条数,最大为500true
start_timeString到店时间,查询起始时间,yyyy-MM-dd,示例:"2023-10-01"false
end_timeString到店时间,查询结束时间,yyyy-MM-dd,示例:"2023-10-30"false
creatorsString[]预约单创建人,员工uid,不传则为全量查询false
order_statusInt预约单状态:10 待确认;20 待到店;30 取消;40 已失约;50 已完成。不传则为全量查询false
请求示例
json - Request-Example:
{
    "pageIndex": 1,
    "pageSize": 10,
    "startTime": "2023-12-18",
    "endTime": "2023-12-24",
    "orderStatus": 50,
}
响应参数
参数名类型说明
successBool请求成功失败标识
codeInt响应码
msgString响应信息
dataObject数据信息
data.totalInt总条数
data.pageInt查询页码
data.pageSizeInt查询条数
data.listObject[]预约单数据
data.list.order_idString预约单id
data.list.order_numString预约单编号
data.list.order_statusInt预约单状态码:10 待确认;20 待到店;30 取消;40 已失约;50 已完成
data.list.order_status_valueString预约单状态名称:10 待确认;20 待到店;30 取消;40 已失约;50 已完成
data.list.order_create_timeString预约单创建时间
data.list.order_create_user_idString预约单创建人id,指员工uid
data.list.order_create_user_nameString预约单创建人姓名,指员工姓名
data.list.network_idString网点id
data.list.network_nameString网点名称
data.list.arrival_timeString到店时间
data.list.person_idString人员id
data.list.person_nameString人员姓名
data.list.project_idString项目id
data.list.project_nameString项目名称
data.list.service_durationInt服务时长,单位:分钟
data.list.appointment_user_nameString到店顾客名称
data.list.appointment_user_phoneString到店顾客手机号
data.list.customer_idString联系人id
data.list.customer_nameString联系人名称
data.list.sign_in_statusInt到店状态码: 10 正常到店 ;20 异常到店
data.list.sign_in_status_valueInt到店状态名称: 10 正常到店 ;20 异常到店
data.list.sign_in_distanceInt到店距门店距离
data.list.sign_in_locationString到店定位地址
data.list.customer_wx_avatarString签到客户微信头像
data.list.customer_wx_nicknameString签到客户微信昵称
data.list.service_person_has_removedBooltrue:预约单服务人员已被删除
data.list.customer_field_listObject[]预约单自定义字段信息
data.list.customer_field_list.field_idString自定义字段id
data.list.customer_field_list.complete_valueString字段枚举结构,如果是多级联选,将会返回完整的选项id和name
data.list.customer_field_list.field_typeString自定义字段类型。字段类型(与自定义字段配置相同),date日期 datetime日期时间 single单行文本 multi多行文本 number数字 radio单选 checkbox多选 cascade多级下拉框 file附件
data.list.customer_field_list.field_valueString自定义字段值,根据字段类型不同,值内容会不同。
data.list.customer_field_list.field_nameString自定义字段名称
data.list.remarkString备注
data.list.service_end_timeString服务结束时间:仅当预约单选择了服务时长时才会计算结束时间,否则该字段为空
trace_idString上下文链路id
成功响应示例
json - Response-Example:
{
    "code": 0,
    "data": {
        "empty": false,
        "list": [
            {
                "appointment_user_name": "a",
                "appointment_user_phone": "1300010232",
                "arrival_time": "2023-12-19 15:00",
                "customer_field_list": [
                    {
                        "complete_value": "{\"id\": \"459059364006051840\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"2023-12-19 02:00:00\", \"valType\": \"dateTime\", \"cascadingValue\": null}",
                        "field_id": 459059364006051840,
                        "field_name": "自定义日期时间",
                        "field_type": "dateTime",
                        "field_value": "\"2023-12-19 02:00:00\""
                    },
                    {
                        "complete_value": "{\"id\": \"459060304764129280\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"\", \"valType\": \"cascade\", \"cascadingValue\": {\"key\": \"31b6e3c1-be5f-4627-8811-8650c6bd8642/3b7c1747-2852-4ec9-9b7e-b5604811c019\", \"value\": \"选项B/B1\"}}",
                        "field_id": 459060304764129280,
                        "field_name": "自定义多选下拉框",
                        "field_type": "cascade",
                        "field_value": "[\"31b6e3c1-be5f-4627-8811-8650c6bd8642\",\"3b7c1747-2852-4ec9-9b7e-b5604811c019\"]"
                    },
                    {
                        "complete_value": "{\"id\": \"459059922862170112\", \"aryVal\": [\"[{\\\"name\\\":\\\"3711676395412_.pic.jpg\\\",\\\"thumbUrl\\\":\\\"https://cdn-member-test.dustess.com/W00000000516/static/i/e/h/8/ieh8f9s8k991702968652130.jpg\\\",\\\"status\\\":\\\"done\\\"}]\"], \"numVal\": 0, \"strVal\": \"\", \"valType\": \"file\", \"cascadingValue\": null}",
                        "field_id": 459059922862170112,
                        "field_name": "自定义附件",
                        "field_type": "file",
                        "field_value": "[{\"name\":\"3711676395412_.pic.jpg\",\"thumbUrl\":\"https://cdn-member-test.dustess.com/W00000000516/static/i/e/h/8/ieh8f9s8k991702968652130.jpg\",\"status\":\"done\"}]"
                    },
                    {
                        "complete_value": "{\"id\": \"510449227470262272\", \"aryVal\": [], \"numVal\": 1, \"strVal\": \"\", \"valType\": \"number\", \"cascadingValue\": null}",
                        "field_id": 510449227470262272,
                        "field_name": "1",
                        "field_type": "number",
                        "field_value": "1"
                    },
                    {
                        "complete_value": "{\"id\": \"459059290187141120\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"2023-12-01\", \"valType\": \"date\", \"cascadingValue\": null}",
                        "field_id": 459059290187141120,
                        "field_name": "自定义日期",
                        "field_type": "date",
                        "field_value": "\"2023-12-01\""
                    },
                    {
                        "complete_value": "{\"id\": \"505407370701762560\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"1\", \"valType\": \"single\", \"cascadingValue\": null}",
                        "field_id": 505407370701762560,
                        "field_name": "测试111",
                        "field_type": "single",
                        "field_value": "\"1\""
                    },
                    {
                        "complete_value": "{\"id\": \"509421603771396096\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"1\", \"valType\": \"radio\", \"cascadingValue\": null}",
                        "field_id": 509421603771396096,
                        "field_name": "是否",
                        "field_type": "radio",
                        "field_value": "\"1\""
                    }
                ],
                "customer_id": "",
                "customer_name": null,
                "customer_wx_avatar": null,
                "customer_wx_nickname": null,
                "network_id": "ece05cd4-80bf-4360-abf2-bb5e68248c6c",
                "network_name": "维修点",
                "order_create_time": "2023-12-19 14:50:59",
                "order_create_user_id": "375",
                "order_create_user_name": "ces",
                "order_id": 524961851198681088,
                "order_num": "Y524961851201306625",
                "order_status": 10,
                "order_status_value": "待确认",
                "person_head_image": null,
                "person_id": 0,
                "person_name": "到店分配",
                "project_id": 524955570422575104,
                "project_name": "维修服务",
                "remark": "123123",
                "service_duration": 30,
                "service_end_time": "2023-12-19 15:30",
                "service_person_has_removed": null,
                "sign_in_distance": 0,
                "sign_in_location": "",
                "sign_in_status": 0,
                "sign_in_status_value": null,
                "union_id": ""
            },
            {
                "appointment_user_name": "ces",
                "appointment_user_phone": "13000010002",
                "arrival_time": "2023-12-19 15:00",
                "customer_field_list": [
                    {
                        "complete_value": "{\"id\": \"509421603771396096\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"1\", \"valType\": \"radio\", \"cascadingValue\": null}",
                        "field_id": 509421603771396096,
                        "field_name": "是否",
                        "field_type": "radio",
                        "field_value": "\"1\""
                    },
                    {
                        "complete_value": "{\"id\": \"459059364006051840\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"2023-12-20 14:49:58\", \"valType\": \"dateTime\", \"cascadingValue\": null}",
                        "field_id": 459059364006051840,
                        "field_name": "自定义日期时间",
                        "field_type": "dateTime",
                        "field_value": "\"2023-12-20 14:49:58\""
                    },
                    {
                        "complete_value": "{\"id\": \"505407370701762560\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"1\", \"valType\": \"single\", \"cascadingValue\": null}",
                        "field_id": 505407370701762560,
                        "field_name": "测试111",
                        "field_type": "single",
                        "field_value": "\"1\""
                    },
                    {
                        "complete_value": "{\"id\": \"510449227470262272\", \"aryVal\": [], \"numVal\": 1, \"strVal\": \"\", \"valType\": \"number\", \"cascadingValue\": null}",
                        "field_id": 510449227470262272,
                        "field_name": "1",
                        "field_type": "number",
                        "field_value": "1"
                    },
                    {
                        "complete_value": "{\"id\": \"459059290187141120\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"2023-12-19\", \"valType\": \"date\", \"cascadingValue\": null}",
                        "field_id": 459059290187141120,
                        "field_name": "自定义日期",
                        "field_type": "date",
                        "field_value": "\"2023-12-19\""
                    },
                    {
                        "complete_value": "{\"id\": \"459060304764129280\", \"aryVal\": [], \"numVal\": 0, \"strVal\": \"\", \"valType\": \"cascade\", \"cascadingValue\": {\"key\": \"5e9c70ce-51dc-4f7e-9af1-34aecb292e89/7edc0ddf-6194-4b70-9427-f350fd5781e3\", \"value\": \"选项A/A2\"}}",
                        "field_id": 459060304764129280,
                        "field_name": "自定义多选下拉框",
                        "field_type": "cascade",
                        "field_value": "[\"5e9c70ce-51dc-4f7e-9af1-34aecb292e89\",\"7edc0ddf-6194-4b70-9427-f350fd5781e3\"]"
                    },
                    {
                        "complete_value": "{\"id\": \"459059922862170112\", \"aryVal\": [\"[{\\\"name\\\":\\\"333.png\\\",\\\"thumbUrl\\\":\\\"https://cdn-member-test.dustess.com/W00000000516/static/l/h/t/m/lhtmahgv8u1702968612898.png\\\",\\\"status\\\":\\\"done\\\"}]\"], \"numVal\": 0, \"strVal\": \"\", \"valType\": \"file\", \"cascadingValue\": null}",
                        "field_id": 459059922862170112,
                        "field_name": "自定义附件",
                        "field_type": "file",
                        "field_value": "[{\"name\":\"333.png\",\"thumbUrl\":\"https://cdn-member-test.dustess.com/W00000000516/static/l/h/t/m/lhtmahgv8u1702968612898.png\",\"status\":\"done\"}]"
                    }
                ],
                "customer_id": "dd8a5e50-9e37-11ee-aa9a-028e98b07927",
                "customer_name": null,
                "customer_wx_avatar": null,
                "customer_wx_nickname": null,
                "network_id": "ece05cd4-80bf-4360-abf2-bb5e68248c6c",
                "network_name": "维修点",
                "order_create_time": "2023-12-19 14:50:23",
                "order_create_user_id": "375",
                "order_create_user_name": "ces",
                "order_id": 524961703222300672,
                "order_num": "Y524961703221813249",
                "order_status": 10,
                "order_status_value": "待确认",
                "person_head_image": null,
                "person_id": 0,
                "person_name": "到店分配",
                "project_id": 524955570422575104,
                "project_name": "维修服务",
                "remark": "备注内容",
                "service_duration": 30,
                "service_end_time": "2023-12-19 15:30",
                "service_person_has_removed": null,
                "sign_in_distance": 0,
                "sign_in_location": "",
                "sign_in_status": 0,
                "sign_in_status_value": null,
                "union_id": ""
            }
        ],
        "page": 1,
        "pageSize": 10,
        "total": 5
    },
    "msg": "OK",
    "success": true,
    "traceId": "d4b54ff2-7192-9cf4-904b-c7b5b2951004"
}
失败响应示例
json - Response-Example:
{
    "code": 444,
    "data": null,
    "msg": "参数格式错误",
    "success": true,
    "traceId": "7fc29715-b368-9875-ae9d-b940e10a0249"
}
上一页
给员工发送企微通知
下一页
查询评论列表接口
Built with