The s7.1 release group of the Xiaoman OKKI CRM Open API — 35 operations covering customer detail/field dictionaries, follow-up trails, inventory, capital accounts and reporting.
openapi: 3.0.3
info:
title: Xiaoman (OKKI CRM) s7.1 API
description: 'Split by tag from the aggregated Xiaoman / OKKI CRM Open API (小满科技, an Alibaba company), assembled verbatim from the per-operation OpenAPI 3.0.1 fragments published on the provider''s developer documentation site at https://open.xiaoman.cn (Apifox-hosted; each operation page embeds its own OpenAPI fragment, harvested from the .md endpoints listed in https://open.xiaoman.cn/llms.txt). OAuth2 module-scoped Bearer tokens from POST /v1/oauth2/access_token; responses use a {code, message, now, data} envelope. Corrected 2026-08-13: the tag-split pass had stamped this document with the OKKI Go title, description and server host; its operations belong to the OKKI CRM Open API on https://api-sandbox.xiaoman.cn, the host the quick-start doc labels 正式域名 (production domain).'
version: 1.0.0
x-generated: '2026-08-13'
x-method: harvested
x-source: https://open.xiaoman.cn/llms.txt
servers:
- url: https://api-sandbox.xiaoman.cn
description: OKKI CRM Open API host (quick-start doc labels this 正式域名 / production domain)
tags:
- name: s7.1
paths:
/v1/company/info:
get:
summary: 客户详情
deprecated: false
description: '| 异常码 | 异常消息 |异常解决方案|
| --- | --- | --- |
| 404 | Not Found Resource | 检查传入的company_id 或者 serial_id是否正确 |'
tags:
- s7.1
parameters:
- name: company_id
in: query
description: ' 公司客户ID 来自于/v1/company/list接口company_id'
required: false
example: 1
schema:
type: integer
- name: format
in: query
description: ' 是否返回格式化后的数据，默认值: 0 '
required: false
example: ' 1'
schema:
type: string
- name: serial_id
in: query
description: ' 客户编号 来自于/v1/company/list接口serial_id'
required: false
example: ' A01'
schema:
type: string
- name: Authorization
in: header
description: ''
required: true
example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMWMxMzU5NmRlMGJjYzM1MzRlYTIxMWEyMTE0MTdjODcxZjMzZGVjNjVmMzE1MDcxM2EwMTE5N2I0NGJlODY2NDM0YWFmYjczZmI0ZWIwYiIsImp0aSI6ImU3NTBiMWY2MDZjMDc5MTc3YzdmZjZjZDM3ZWZkMWFjYWZlMjhmNjNhY2U2YzJlMDg2ZmQyMTY4YmRhYTkzYTAzMDAyZDY3OGJhOTBkMDgxIiwiaWF0IjoxNjc4OTQ5NTQwLjcyNjQwMSwibmJmIjoxNjc4OTQ5NTQwLjcyNjQwNCwiZXhwIjoxNjc4OTc4MzQwLjcxODk3Niwic3ViIjoiIiwic2NvcGVzIjpbInByb2R1Y3QiLCJjb21wYW55IiwiaW52b2ljZXMiLCJsZWFkIiwib3Bwb3J0dW5pdHkiLCJ1c2VyIl19.XJfFkUedgP9Kz-a4-nIKlb8DNt2YoIXxatZiUJDaMXxVEtpceWz59QMJtpqMHS-qgB38bY8B5_9bdMUYg3fCvSTu0RNWfMyvEri9Dqmp3RBE88DYoKC4b-kugv-49ujkAl_GUv1X3FVI5L3RXDdhGVmVVEwqbDXnIWaSSNi9LhdJ2XX6RU0LkjVYnL3_nwwrcmDB_FJ2JHDNnB6Hin0fiteA6SY03vsxB2jnwMLKtoN6wab5eJex7mGnhEe8d0lG1XviOjIeU9DhQN-31dSKdjbDjfCCtrxtqmxCDFVdIDiuoH2CuxSVn2c0skjiBMm9zOQ5bfV-wWRjY_fxdG-e4g
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: integer
title: 错误码
examples:
- 0
message:
type: string
title: 错误信息
examples:
- success
now:
type: string
title: 当前时间
examples:
- '2022-01-01 00:00:00'
data:
type: object
properties:
company_id:
type: integer
title: 公司客户ID
name:
type: string
title: 公司名称
short_name:
type: string
title: 公司简称
serial_id:
type: string
title: 客户编号
order_time:
type: string
title: 最近联系时间
create_time:
type: string
title: 系统创建时间
create_user:
type: string
title: 创建人
update_time:
type: string
title: 更新时间
last_edit_user:
type: integer
title: 更新人
archive_type:
type: integer
title: 创建方式
description: 1手动新建，2AI自动新建，3AI建档建议，4客户通同步
category_ids:
type: array
items:
type: integer
title: 主营产品
examples:
- - 1
- 2
- 3
country:
type: string
title: 国家地区
province:
type: string
title: 省
city:
type: string
title: 市
biz_type:
type: string
title: 客户类型
intention_level:
type: integer
title: 采购意向
description: 0未知，1低，2中，3高
annual_procurement:
type: integer
title: 年采购额
timezone:
type: integer
title: 时区
scale_id:
type: integer
title: 规模
description: '1：少于59人,2：60-149人,3：150-499人,4：500-999人,5：1000-4999人，6: 5000人以上'
star:
type: integer
title: 客户星级
group_id:
type: integer
title: 客户分组
pool_id:
type: integer
title: 公海分组
trail_status:
type: object
properties:
status_id:
type: integer
title: 状态ID
status_name:
type: string
title: 状态名称
title: 客户状态
x-apifox-orders:
- status_id
- status_name
origin:
type: integer
title: 客户来源
tag:
type: object
properties:
tag_id:
type: integer
title: 标签ID
tag_name:
type: string
title: 标签名称
title: 客户标签
x-apifox-orders:
- tag_id
- tag_name
product_group_ids:
type: array
items:
type: integer
title: 产品分组
examples:
- - 1
- 2
- 3
homepage:
type: string
title: 公司主页网址
fax:
type: string
title: 传真
tel:
type: object
properties:
'0':
type: string
title: 区号
'1':
type: string
title: 电话号码
title: 座机电话信息
x-apifox-orders:
- '0'
- '1'
address:
type: string
title: 公司地址
image_list:
type: array
items:
type: object
properties:
file_path:
type: string
title: 文件地址
file_preview_url:
type: string
title: 文件预览地址
file_name:
type: string
title: 文件名称
file_size:
type: integer
title: 文件大小
x-apifox-orders:
- file_path
- file_preview_url
- file_name
- file_size
title: 公司logo列表
customers:
type: array
items:
type: object
properties:
customer_id:
type: integer
title: 客户联系人ID
company_id:
type: integer
title: 从属的公司客户ID
name:
type: string
title: 昵称
email:
type: string
title: 联系人邮箱
tel_list:
type: array
items:
type: object
properties:
'0':
type: string
title: 区号
'1':
type: string
title: 电话号码
x-apifox-orders:
- '0'
- '1'
title: 电话信息
post_grade:
type: integer
title: 职级
post:
type: string
title: 职位
contact:
type: array
items:
type: object
properties:
type:
type: string
title: 联系平台
value:
type: string
title: 平台号
x-apifox-orders:
- type
- value
title: 联系人社交平台信息列表
birth:
type: string
title: 生日
gender:
type: integer
title: 性别
description: 1男，2女
remark:
type: string
title: 联系人备注
main_customer_flag:
type: integer
title: 是否主要联系人
description: 0=不是，1=是主要联系人
external_field_data:
type: object
title: 自定义数据字段列表
x-apifox-orders: []
properties: {}
image_list:
type: array
items:
type: object
properties:
file_path:
type: string
title: 文件地址
file_preview_url:
type: string
title: 文件预览地址
file_name:
type: string
title: 文件名称
file_size:
type: integer
title: 文件大小
x-apifox-orders:
- file_path
- file_preview_url
- file_name
- file_size
title: 头像列表
x-apifox-orders:
- customer_id
- company_id
- name
- email
- tel_list
- post_grade
- post
- contact
- birth
- gender
- remark
- main_customer_flag
- external_field_data
- image_list
title: 客户联系人列表
remark:
type: string
title: 公司备注
owner:
type: array
items:
type: object
properties:
user_id:
type: integer
title: 跟进人ID
nickname:
type: string
title: 昵称
x-apifox-orders:
- user_id
- nickname
title: 跟进人列表
company:
type: array
items:
type: object
properties:
group_id:
type: integer
title: 客户数据信息分组ID
name:
type: string
title: 客户数据信息分组名称
fields:
type: array
items:
type: object
properties:
id:
type: string
title: 数据字段ID
name:
type: string
title: 数据字段名称
type:
type: string
title: 数据字段值
x-apifox-orders:
- id
- name
- type
title: 客户数据字段列表
x-apifox-orders:
- group_id
- name
- fields
title: 客户数据列表
archive_time:
type: string
title: 创建时间（对应Web显示的创建时间）
recent_follow_up_time:
type: string
title: 最近跟进时间
next_move_to_public_date:
type: string
title: 下次移入公海时间
title: 响应数据
x-apifox-orders:
- company_id
- name
- short_name
- serial_id
- order_time
- create_time
- create_user
- update_time
- archive_time
- recent_follow_up_time
- last_edit_user
- archive_type
- category_ids
- country
- province
- city
- biz_type
- intention_level
- annual_procurement
- timezone
- scale_id
- star
- group_id
- pool_id
- trail_status
- origin
- tag
- product_group_ids
- homepage
- fax
- tel
- address
- image_list
- customers
- remark
- owner
- company
- next_move_to_public_date
required:
- next_move_to_public_date
required:
- code
- message
- now
x-apifox-orders:
- code
- message
- now
- data
example:
code: 200
message: success
now: '2026-01-21 16:02:22'
data:
company_id: 56657420945678
short_name: ''
name: buxiangshangban
category_ids: []
serial_id: 乔三乔三8164babyface
archive_time: '2025-07-30 09:43:47'
archive_type: 1
country: ''
province: ''
city: ''
biz_type: ''
last_owner: 55280038
pool_id: 0
private_time: '2025-07-30 09:43:47'
public_time: '2025-11-06 00:08:47'
intention_level: 0
annual_procurement: 0
timezone: ''
scale_id: 0
star: 0
group_id: 0
trail_status:
status_id: '0'
status_name: 无
status_color: '#cccccc'
info_value: '0'
info_label: 无
origin: 0
origin_list: []
homepage: ''
fax: ''
tel:
- ''
- ''
tel_area_code: ''
address: ''
remark: ''
image_list: []
next_follow_up_time: '1970-01-01 00:00:00'
create_user: 55280040
create_time: '2025-07-30 09:43:47'
last_edit_user: '55280038'
update_time: '2025-11-06 00:08:47'
tag: []
product_group_ids: []
release_count: 1
public_type: 1
edit_time: '2025-09-05 15:19:15'
main_lead_id: 0
order_time: '2025-11-07 16:03:38'
recent_follow_up_time: '2025-11-07 16:03:38'
client_tag_list: []
next_move_to_public_date: '1970-01-01'
ali_store_id: []
country_region:
city: ''
country: ''
province: ''
user_id: []
deal_time: ''
origin_name: ''
trail_status_name: 无
pool_name: 公共公海分组
alibaba_store_info: []
source_detail:
alibaba_store_info: []
site_info: []
alibaba_relation_list: []
alibaba_user_info: []
alibaba_last_owner_info: []
company:
- group_id: 1
name: 基本信息
fields:
- id: '13193361400290'
name: 是否同步
field_type: '3'
value: ''
- id: name
name: 公司名称
field_type: '1'
value: buxiangshangban
- id: short_name
name: 简称
field_type: '1'
value: ''
- id: origin_list
name: 客户来源
field_type: '7'
value: []
- id: '13193448310389'
name: 营业额
field_type: '2'
value: ''
- id: '13193462587148'
name: 成立时间
field_type: '4'
value: ''
- id: '13193575265935'
name: 客户主营产品
field_type: '7'
value: ''
- id: '13193602539659'
name: 是否具备研发能力
field_type: '7'
value: ''
- id: '13193716666847'
name: 关联销售员
field_type: '3'
value: ''
- id: '13193742303403'
name: 客户所属行业
field_type: '2'
value: ''
- id: '13193785265137'
name: 客户编号(客户级别）
field_type: '2'
value: ''
- id: '13193889505134'
name: 联系阶段
field_type: '3'
value: ''
- id: '13193949334238'
name: 区域（国内必填）
field_type: '3'
value: ''
- id: '13193998000309'
name: 省
field_type: '1'
value: ''
- id: '13194029142663'
name: 市
field_type: '1'
value: ''
- id: '13194101283466'
name: 注册资金
field_type: '1'
value: ''
- id: '13194125253203'
name: 客户所属组织
field_type: '3'
value: ''
- id: '13194168691177'
name: 结算货币
field_type: '3'
value: ''
- id: '13194201423464'
name: 团队跟进人
field_type: '3'
value: ''
- id: '13194245593312'
name: 业务部门
field_type: '3'
value: ''
- id: origin
name: 客户来源
field_type: 3
value: ''
- group_id: 2
name: 特征信息
fields:
- id: intention_level
name: 采购意向
field_type: '3'
value: 0
- id: annual_procurement
name: 年采购额
field_type: '3'
value: 0
- id: province
name: 省份
field_type: '3'
value: ''
- id: biz_type
name: 客户类型
field_type: '3'
value: ''
- id: city
name: 城市
field_type: '3'
value: ''
- id: country
name: 国家地区
field_type: '3'
value: ''
- id: scale_id
name: 规模
field_type: '3'
value: 0
- id: category_ids
name: 主营产品
field_type: '7'
value: []
- id: timezone
name: 时区
field_type: '3'
value: ''
- id: '13195018941876'
name: 客户意向采购产品
field_type: '2'
value: ''
- group_id: 3
name: 管理信息
fields:
- id: star
name: 客户星级
field_type: '5'
value: 0
- id: group_id
name: 客户分组
field_type: '3'
value: 未分组
- id: trail_status
name: 客户阶段
field_type: '3'
value: 无
- group_id: 4
name: 联系信息
fields:
- id: homepage
name: 公司网址
field_type: '1'
value: ''
- id: tel
name: 座机
field_type: '1'
value:
tel_area_code: ''
tel: ''
- id: address
name: 详细地址
field_type: '2'
value: ''
- id: fax
name: 传真
field_type: '1'
value: ''
- group_id: 5
name: 其他信息
fields:
- id: '5611336406277'
name: 客户产品
field_type: '3'
value: ''
- id: remark
name: 公司备注
field_type: '2'
value: ''
- id: '14336719487'
name: 文本字段
field_type: '1'
value: ''
- id: '14336724791'
name: 多行文本字段
field_type: '2'
value: ''
- id: '14336740094'
name: 下拉单选
field_type: '3'
value: ''
- id: '18912239641'
name: 客户地址
field_type: '2'
value: ''
- id: '1830529538578'
name: 产品类型
field_type: '7'
value: ''
- id: '14336745505'
name: 自定义日期
field_type: '4'
value: ''
- id: '14336749225'
name: 自定义数值
field_type: '5'
value: ''
- id: '14336771360'
name: 自定义下拉多选
field_type: '7'
value: ''
- id: '17224560985'
name: 小可爱
field_type: '1'
value: ''
- id: '14336777140'
name: 日期-时间
field_type: '10'
value: ''
- id: '2556294010332'
name: 客户重要程度
field_type: '5'
value: ''
- id: '791080592468'
name: 红包
field_type: '1'
value: ''
- id: '4967222183893'
name: 产品属性
field_type: '7'
value: ''
- id: '791082449933'
name: y产品
field_type: '1'
value: ''
- id: '6384932198880'
name: 阿里买家等级
field_type: '3'
value: ''
- id: '791086073454'
name: j产品
field_type: '1'
value: ''
- id: '6590866819234'
name: 买家分层
field_type: '3'
value: ''
- id: '791089427247'
name: h产品
field_type: '1'
value: ''
- id: '6884174737520'
name: 临时分组
field_type: '3'
value: ''
- id: '1764693531582'
name: 客户采购产品
field_type: '2'
value: ''
- id: '6965504713479'
name: 客户分类
field_type: '3'
value: ''
- id: '7177053929221'
name: 行业
field_type: '3'
value: ''
- id: '7193065259936'
name: 数据来源下载
field_type: '3'
value: ''
- id: '7714808053202'
name: 自定义多行文本
field_type: '2'
value: ''
- id: '7714811584321'
name: 自定义单行文本
field_type: '1'
value: ''
- id: '7714819114619'
name: 自定义单选
field_type: '3'
value: ''
- id: '7714825824675'
name: 自定义zbp时间
# --- truncated at 32 KB (668 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/xiaoman/refs/heads/main/openapi/xiaoman-s7-1-api-openapi.yml