纷享销客开发者手册 纷享销客开发者手册
  • APL开发手册
  • PWC开发手册
  • OpenAPI 文档
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门

  • API授权流程

  • API基础说明

  • OpenAPI

    • CRM对象接口

      • 商品对象接口

      • 自定义对象接口

        • 查询自定义对象详情
        • 创建自定义对象
        • 修改自定义对象
        • 变更自定义对象负责人
        • 查询自定义对象列表
          • 作废自定义对象
          • 恢复自定义对象
          • 删除自定义对象
          • 批量作废自定义对象
        • 发货单产品对象接口

        • GoalRuleObj对象接口

        • 子产品分组对象接口

        • 出库单产品对象接口

        • 设备配件规格关系对象接口

        • 价目表明细对象接口

        • 报价单明细对象接口

        • 商机联系人对象接口

        • 通话记录对象接口

        • 商机2.0明细对象接口

        • 销售记录(已下线)对象接口

        • 退料单产品对象接口

        • 信用对象接口

        • 回款计划对象接口

        • 出入库明细对象接口

        • 规格表对象接口

        • 价目表对象接口

        • 会员等级对象接口

        • 入库单对象接口

        • 库存对象接口

        • 客户对象接口

        • 盘点单产品对象接口

        • 会员积分明细对象接口

        • 工作圈回复对象接口

        • 子产品明细对象接口

        • 退款单对象接口

        • 设备对象接口

        • 回款明细对象接口

        • 供应商对象接口

        • 规格值表对象接口

        • 退款对象接口

        • 会员成长值明细对象接口

        • 返利对象接口

        • 仓库对象接口

        • 入库单产品对象接口

        • 市场活动对象接口

        • 线索转换日志对象接口

        • 出库单对象接口

        • 批次库存对象接口

        • 工单设备对象接口

        • ERP仓库对象接口

        • 序列号对象接口

        • 盘点单对象接口

        • 退换货单对象接口

        • 领料单产品对象接口

        • 采购订单对象接口

        • 退货单关联的产品对象接口

        • 可售客户对象接口

        • 商机2.0对象接口

        • 报价单对象接口

        • 目标规则适用部门接口

        • 调拨单产品对象接口

        • 促销产品对象接口

        • 采购订单产品对象接口

        • 电销记录对象接口

        • 促销规则对象接口

        • 批次对象接口

        • 退货单对象接口

        • 销售记录对象接口

        • 微信粉丝对象接口

        • 发货单对象接口

        • 会员对象接口

        • 财务信息对象接口

        • 销售活动对象接口

        • 促销对象接口

        • 销售订单对象接口

        • 账户余额对象接口

        • 合同对象对象接口

        • 领料单对象接口

        • 商机对象接口

        • 可售范围对象接口

        • 回款对象接口

        • ERP库存对象接口

        • 部门对象接口

        • 退换货单产品对象接口

        • 可售价目表对象接口

        • 客户地址对象接口

        • 开票申请对象接口

        • 预存款对象接口

        • 合作伙伴对象接口

        • 调拨单对象接口

        • 人员对象接口

        • 产品单位对象接口

        • 产品对象接口

        • 订单产品对象接口

        • 返利支出对象接口

        • 线索对象接口

        • 开票申请明细对象接口

        • 联系人对象接口

        • 目标值对象接口

        • 工单对象接口

        • 退料单对象接口

        • 审批流程接口

        • Bom对象对象接口

        • 费用明细对象接口

        • 配件消耗明细对象接口

        • 多单位对象接口

        • 活动方案项目接口

        • 返利单对象接口

        • 活动方案接口

        • 活动举证接口

        • 活动协议接口

        • 活动项目管理接口

        • 活动协议项目接口

        • 活动举证项目接口

        • 流程任务对象接口

        • 活动成员对象接口

        • 竞争对手接口

        • 日程对象接口

        • 客户账户余额对象接口

        • 线索跟进记录对象接口

        • 账户对象接口

        • 行为记录对象接口

        • 服务评价对象接口

        • 路线对象接口

        • 项目对象接口

        • 项目阶段对象接口

        • 任务对象接口

        • 工时记录对象接口

        • 工单多次签到记录对象接口

        • 高级外勤对象接口

        • 外勤图片对象接口

        • 采购退货申请对象接口

        • 采购退货申请产品对象接口

        • 经销商采购退货申请对象接口

        • 经销商采购退货产品对象接口

        • 互联企业对象接口

        • 互联用户对象接口

        • 日志对象接口

        • 客户主数据对象接口

        • 费用预算对象接口

        • 产品约束对象接口

        • 产品属性约束对象接口

        • 产品约束明细对象接口

        • 产品属性约束明细对象接口

        • 关键词投放计划对象接口

        • 落地页对象接口

        • 关键词投放明细对象接口

        • 营销关键词对象接口

        • 企微好友对象接口

        • 营销推广来源对象接口

        • 企业微信客户对象接口

        • 企微客户群对象接口

        • 销售合同产品对象接口

        • 可售产品对象接口

        • 属性对象接口

        • 属性值对象接口

        • 设备资产BOM对象接口

        • 业务流程接口

        • 账户收支流水对象接口

        • 服务请求对象接口

        • 阶段推进器接口

        • 企微客户群对象接口

        • 产品组合对象接口

        • 阶段推进器任务对象接口

        • 阶段推进器实例对象接口

        • 流程任务对象接口

        • 企业库对象接口

        • 客户树对象接口

        • 老商机流程对象接口

        • 产品分组对象接口

        • 价目表适用客户对象接口

        • 邮件对象接口

        • 备件发运单对象接口

        • 备件发运单明细对象接口

        • 个人库对象接口

        • 个人库明细对象接口

        • 备件消耗对象接口

        • 备件申请对象接口

        • 备件退运对象接口

        • 备件维修任务对象接口

        • 备件维修计划对象接口

        • 个人库调拨单对象接口

        • 个人库调整单对象接口

        • 个人库盘点单对象接口

        • 优惠券方案对象接口

        • 优惠券实例对象接口

        • 服务技能表对象接口

        • 服务技能对象接口

        • 人员拜访数据对象接口

        • 广告投放明细对象接口

        • 银行流水标准对象接口

        • 虚拟账户标准对象接口

        • 到款认领标准对象接口

        • 结算单标准对象接口

        • 结算单明细标准对象接口

        • 预设销售合同对象接口

        • 企微员工对象接口

        • 用户行为记录对象接口

        • 服务信息对象接口

        • 忠诚度计划对象接口

        • 会员管理对象接口

        • 等级分类对象接口

        • 会员等级对象接口

        • 积分分类对象接口

        • 积分池对象接口

        • 积分明细对象接口

        • 会员变动记录对象接口

        • 交易事件对象接口

        • 知识文章对象接口

        • 商品条码对象接口

        • 商品条码状态对象接口

        • 活动奖励发放明细对象接口

        • 访客信息对象接口

        • 留言对象接口

        • 客服会话对象接口

        • 满意度评价对象接口

      • CRM对象通用接口

      • 通讯录接口

      • 其他接口

    • 免登集成方案

    • 客户端开发

    • 常见问题

    目录

    查询自定义对象列表

    # 描述

    查询自定义对象列表

    # 请求说明

    请求方式 :POST + application/json

    请求路径 :https://${填入所在云的域名}/cgi/crm/custom/v2/data/query?thirdTraceId=${随机字符串}

    请求头填写 :参考公共参数填写

    本接口只适用于自定义对象(即对象的ApiName以__c结尾的对象)

    # 请求参数

    参数 类型 是否必填 说明
    data Map 是 数据map
      dataObjectApiName String 是 对象的api_name,固定取值:DeliveryNoteProductObj
      find_explicit_total_num String 否 是否返回总数(true:返回total总数,false:不返回total总数(默认true。设置为false可以加快接口响应速度))
      search_query_info String 是 查询条件
        limit Int 是 分页条数(最大值为100)
        offset Int 是 偏移量(从0开始、数值必须为limit的整数倍)
        filters List 是 过滤条件列表
          field_name String 是 字段名
          field_values List 是 字段值
          operator String 是 操作符
        orders List 是 排序
          fieldName String 是 字段名
          isAsc Boolean 是 是否升序(如果是true,按照升序排列,如果是false,则按照倒序排列)

    # 请求示例

    {
      "data": {
        "find_explicit_total_num": "hello",
        "search_query_info": {
          "offset": 0,
          "limit": 1,
          "orders": [
            {
              "fieldName": "hello",
              "isAsc": true
            }
          ],
          "filters": [
            {
              "operator": "EQ",
              "field_name": "name",
              "field_values": []
            }
          ]
        },
        "dataObjectApiName": ""
      }
    }
    

    # 返回参数

    参数 类型 说明
    traceId string 请求唯一ID
    errorDescription string 错误描述
    errorMessage string 错误信息
    errorCode Int 查看错误码

    # 返回示例

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0
    }
    

    # 注意事项

    • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;

    # 特殊说明

    # operator参数说明
    参数 参数含义 参数 参数含义
    EQ = GT >
    LT < GTE >=
    LTE <= N <>
    LIKE LIKE NLIKE NOT LIKE
    IS IS ISN IS NOT
    IN IN NIN NOT IN
    BETWEEN BETWEEN NBETWEEN NOT BETWEEN
    STARTWITH LIKE% ENDWITH %LIKE
    CONTAINS Array 包含
    变更自定义对象负责人
    作废自定义对象

    ← 变更自定义对象负责人 作废自定义对象 →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式