The 产品 (products and general CRM) module of the Xiaoman OKKI CRM Open API — 113 operations across products, customers, leads, opportunities, orders, quotations, payments, suppliers, inventory, users and webhook message-push.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/xiaoman-default-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Xiaoman (OKKI CRM) 产品 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: 产品
paths:
/v1/product/list:
get:
summary: 查询产品库列表
deprecated: false
description: ''
tags:
- 产品
parameters:
- name: time_type
in: query
description: 时间筛选 1-按更新时间，2-按创建时间
required: false
example: 1
schema:
type: integer
- name: start_time
in: query
description: 开始时间
required: false
example: '2024-01-21'
schema:
type: string
- name: end_time
in: query
description: 截止时间
required: false
example: '2025-01-11'
schema:
type: string
- name: start_index
in: query
description: 页码
required: false
example: 10
schema:
type: integer
- name: count
in: query
description: 每页数量
required: false
example: 1
schema:
type: integer
- name: product_type
in: query
description: 产品类型 1:无规格 2:多规格 3:组合
required: false
example: 0
schema:
type: integer
- name: Authorization
in: header
description: 从/v1/oauth2/access_token获取到的access_token
required: true
example: '{{access_token}}'
schema:
type: string
default: '{{access_token}}'
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
title: 响应数据
properties:
count:
type: integer
title: 总数
list:
type: array
title: 列表数据
items:
type: object
properties:
product_id:
type: integer
title: 产品ID
description: 产品唯一id，可用于各处查询/新建
product_no:
type: string
title: 产品编号(产品编码)
name:
type: string
title: 产品名称
group_id:
type: integer
title: 产品分组ID
group_name:
type: string
title: 产品分组名称
image:
type: string
title: 产品图片地址
cost_with_tax:
type: number
format: float
title: 含税成本价
cost_currency:
type: string
title: 币种
cost:
type: number
format: float
title: 成本价
cost_unit:
type: string
title: 单位
enable_flag:
type: integer
enum:
- 0
- 1
title: 是否删除
description: 0:删除,1:未删除
disable_flag:
type: integer
enum:
- 0
- 1
title: 是否停售
description: 0:停售,1:未停售
fob:
type: object
title: 离岸价
properties:
price_currency:
type: string
title: 币种
price_min:
type: number
format: float
title: 最小价格
price_max:
type: number
format: float
title: 最大价格
price_unit:
type: string
title: 单位
x-apifox-orders:
- price_currency
- price_min
- price_max
- price_unit
minimum_order_quantity:
type: integer
title: 最小起订量
quantity:
type: integer
title: 货量
quantity_unit:
type: string
title: 单位
model:
type: string
title: 产品型号
category_ids:
type: array
items:
type: integer
description: 产品类目id
title: 产品类目
from_url:
type: string
title: 产品链接
description:
type: string
title: 产品描述
product_remark:
type: string
title: 产品备注
unit:
type: string
title: 产品单位
package_volume:
type: integer
title: 产品体积
count_per_package:
type: integer
title: 每包装产品数
package_gross_weight:
type: integer
title: 包装毛重
package_remark:
type: integer
title: 包装备注
package_unit:
type: integer
title: 包装单位
info_json:
type: object
properties: {}
x-apifox-orders: []
title: 产品属性
hs_code:
type: integer
title: 海关编码
source_type:
type: integer
description: '0:手动创建,1:阿里巴巴同步,2:环球资源同步,3:自动创建,4: 文件导入,5:ERP导入,6:cms的产品从crm导入'
title: 来源
pin_flag:
type: integer
title: 是否关注
description: 1:关注 0:不关注
package_size:
type: object
properties:
package_size_length:
type: string
title: 包装尺寸长
package_size_weight:
type: string
title: 包装尺寸宽
package_size_height:
type: string
title: 包装尺寸高
x-apifox-orders:
- package_size_length
- package_size_weight
- package_size_height
x-apifox-orders:
- product_id
- product_no
- name
- group_id
- group_name
- image
- cost_with_tax
- cost_currency
- cost
- cost_unit
- enable_flag
- disable_flag
- fob
- minimum_order_quantity
- quantity
- quantity_unit
- model
- category_ids
- from_url
- description
- product_remark
- unit
- package_volume
- count_per_package
- package_gross_weight
- package_remark
- package_unit
- info_json
- hs_code
- source_type
- pin_flag
- package_size
x-apifox-orders:
- count
- list
x-apifox-orders:
- code
- message
- now
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: 产品
x-apifox-status: released
x-run-in-apifox: https://open.xiaoman.cn/web/project/345096/apis/api-3478259-run
externalDocs:
url: https://open.xiaoman.cn/api-3478259
description: Published operation doc (Apifox)
/v1/product/push:
post:
summary: 产品新建/编辑
deprecated: false
description: "**如何创建一个无规格产品**\n\n<details>\n <summary>新建无规格产品</summary>\n \n```\n{\n \"images\": [],\n \"name\": \"testname\",\n \"product_no\": \"testno\",\n \"product_type\": 1,\n \"package_remark\": \"remark\"\n }\n```\n</details>\n参数列表中有罗列可传入参数以及数据类型\n\n**如何编辑一个无规格产品**\n\n<details>\n <summary>编辑无规格产品</summary>\n```\n{\n \"product_id\":xxxxxx,\n \"images\": [],\n \"name\": \"testname\",\n \"product_no\": \"test\",\n \"product_type\": 1,\n \"package_remark\": \"remark\"\n }\n```\n</details>\n编辑无规格产品，需要获取info接口中的product_id传入，参数列表中有罗列可传入参数以及数据类型。\n\n\n===========================================================================================\n\n**如何创建一个多规格产品**\n\n<details>\n <summary>新建多规格产品</summary>\n \n```\n{\n\t\"images\": [],\n\t\"name\": \"测试23\",\n\t\"product_no\": \"编号12\",\n\t\"product_type\": 2,\n\t\"sku_items\": [{\n\t\t\"sku_code\": \"测试11\",\n\t\t\"attributes\": [{\n\t\t\t\"item_id\": 2056386462650, --规格类型id\n\t\t\t\"value\": {\n\t\t\t\t\"item_id\": 2268631617468 --规格值id\n\t\t\t}\n\t\t}],\n\t\t\"fob_price\": 123,\n\t\t\"disable_flag\": 0\n\t}, {\n\t\t\"sku_code\": \"测试21\",\n\t\t\"attributes\": [{\n\t\t\t\"item_id\": 2056386462650, --规格类型id\n\t\t\t\"value\": {\n\t\t\t\t\"item_id\": 2268631617469 --规格值id\n\t\t\t}\n\t\t}],\n\t\t\"fob_price\": 123,\n\t\t\"disable_flag\": 0\n\t}],\n\t\"package_remark\": \"备注\",\n\t\"sku_attributes\": [{\n --需要包含sku_items使用的规格值与类型，如item_id规格类型 2056386462650有使用规格值2268631617469/2268631617468，则都需要填写进来\n\t\t\"item_id\": 2056386462650,\n\t\t\"value\": [{\n\t\t\t\"item_id\": 2268631617469\n\t\t}, {\n\t\t\t\"item_id\": 2268631617468\n\t\t}]\n\t}]\n}\n \n```\n</details>\n创建多规格需要通过https://api-sandbox.xiaoman.cn/v1/product/push-sku-attribute ，创建规格后，item_id是由https://api-sandbox.xiaoman.cn/v1/product/sku-attribute-list 获得，用于创建多规格产品。多规格sku_attributes与sku_items必填，\n参数列表中有罗列可传入参数以及数据类型。\n\n**如何编辑一个多规格产品**\n<details>\n <summary>编辑多规格产品</summary>\n \n```\n {\n \"images\": [],\n \"name\": \"测试2\",\n \"product_no\": \"编号1\",\n \"product_type\": 2,\n \"product_id\":xxxxxx,\n \"sku_items\": [\n {\n \"sku_id\":xxxxxx,\n \"sku_code\": \"测试1\",\n \"attributes\": [\n {\n \"item_id\": 2056386462650, --规格类型id\n \"value\": {\n \"item_id\": 2268631617468 --规格值id\n }\n }\n ],\n \"fob_price\": 123,\n \"disable_flag\": 0\n }\n ],\n \"package_remark\": \"备注\",\n \"sku_attributes\": [\n {\n \"item_id\": 2056386462650, --规格类型id\n \"value\": [\n {\n \"item_id\": 2268631617468 --规格值id\n }\n ]\n }\n ]\n}\n \n```\n</details>\n编辑多规格产品，需要获取info接口中的product_id与sku_id传入，参数列表中有罗列可传入参数以及数据类型。\n\n\n\n\n离岸价传参\n<details>\n <summary>离岸价</summary>\n ```\n1. fob_type = 1（ 单一区间定价） \n{\n \"product_no\": \"PROD001\",\n \"name\": \"Sample Product\",\n \"product_type\": 1,\n \"fob_type\": 1,\n \"price_currency\": \"USD\",\n \"price_min\": 8.0,\n \"price_max\": 12.0,\n \"quantity\": 100,\n \"quantity_unit\": \"PCS\",\n \"price_unit\": \"USD/PCS\"\n}\n2. fob_type = 2（ 阶梯定价） \n{\n \"product_no\": \"PROD002\",\n \"name\": \"Sample Product\",\n \"product_type\": 1,\n \"fob_type\": 2,\n \"price_currency\": \"USD\",\n \"gradient_price\": [{\n \"quantity\": \"100\",\n \"price\": \"10.0\"\n }, {\n \"quantity\": \"500\",\n \"price\": \"9.5\"\n }, {\n \"quantity\": \"1000\",\n \"price\": \"9.0\"\n }],\n \"quantity_unit\": \"PCS\",\n \"price_unit\": \"USD/PCS\"\n}\n3. fob_type = 3（ 固定单价） \n{\n \"product_no\": \"PROD003\",\n \"name\": \"Sample Product\",\n \"product_type\": 1,\n \"fob_type\": 3,\n \"price_currency\": \"USD\",\n \"fob_price\": 10.5,\n \"quantity\": 100,\n \"quantity_unit\": \"PCS\",\n \"price_unit\": \"USD/PCS\"\n}\n ```\n</details>\n"
tags:
- 产品
parameters:
- name: Authorization
in: header
description: 从/v1/oauth2/access_token获取到的access_token
required: true
example: '{{access_token}}'
schema:
type: string
default: '{{access_token}}'
requestBody:
content:
application/json:
schema:
type: object
properties:
product_id:
type: integer
title: 产品ID
description: 编辑时必填
product_no:
type: string
title: 产品编码(产品SPU编号)
description: 最长256个字符
name:
type: string
title: 产品名称
description: 最长256个字符
cn_name:
type: string
title: 产品中文名称
description: 最长256个字符
create_user:
type: integer
title: 创建人
product_type:
type: integer
title: 产品类型
description: 1无规格、2多规格、3组合
enum:
- 1
- 2
- 3
model:
type: string
title: 产品型号
description: 最长256个字符
description:
type: string
title: 产品描述
intro:
type: string
title: 产品介绍
product_remark:
type: string
title: 产品备注
images:
type: array
items:
type: string
description: 支持传base64,图片url
title: 产品主图片(url)
from_url:
type: string
title: 产品链接
hs_code:
type: string
title: 海关编码
place:
type: string
title: 产地
info_json:
type: array
title: 产品属性
items:
type: object
properties:
name:
type: string
title: 属性名称
value:
type: string
title: 属性值
x-apifox-orders:
- name
- value
quantity:
type: string
title: 最小起订数量
quantity_unit:
type: string
title: 最小起订量单位
price_currency:
type: string
title: 离岸价货币币种
price_min:
type: number
format: float
title: 离岸价最小价格
price_max:
type: number
format: float
title: 离岸价最大价格
price_unit:
type: string
title: 离岸价单位
package_gross_weight:
type: string
title: 包装毛重
package_unit:
type: string
title: 包装单位
package_size_length:
type: number
format: float
title: 包装长
description: 单位cm
package_size_weight:
type: number
format: float
title: 包装宽
description: 单位cm
package_size_height:
type: number
format: float
title: 包装高
description: 单位cm
package_volume:
type: number
format: float
title: 包装体积
description: 单位m³
product_size_length:
type: number
format: float
title: 产品长
description: 单位cm
product_size_weight:
type: number
format: float
title: 产品宽
description: 单位cm
product_size_height:
type: number
format: float
title: 产品高
description: 单位cm
product_volume:
type: number
format: float
title: 产品体积
description: 单位m³
group_id:
type: integer
title: 产品分组
disable_flag:
type: integer
enum:
- 0
- 1
title: 是否停售
description: 1-是，0-否
fob_type:
type: integer
enum:
- 1
- 2
- 3
title: 离岸价设置类型
description: 1单一区间定价,2阶梯定价,3规格定价
gradient_price:
type: array
title: 阶梯定价
items:
type: object
properties:
quantity:
type: integer
title: 区间数量
price:
type: number
format: float
title: 区间价格
x-apifox-orders:
- quantity
- price
sku_items:
type: array
title: 产品SKU明细
items:
type: object
properties:
sku_id:
type: integer
title: SKU ID
sku_code:
type: string
title: SKU编号
description: 不能与SPU编号重复
sku_image_url:
type: string
title: SKU图片URL
fob_price:
type: number
format: float
title: SKU规格定价
description: 多规格必填
disable_flag:
type: integer
enum:
- 0
- 1
title: SKU是否停售
description: 0:否 1:停售
attributes:
type: array
items:
type: object
properties:
item_id:
type: integer
title: 规格类型ID
description: 可以从/v1/product/sku-attribute-list获取
value:
type: object
properties:
item_id:
type: integer
title: 规格属性值ID
description: 可以从/v1/product/sku-attribute-list获取
x-apifox-orders:
- item_id
required:
- item_id
x-apifox-orders:
- item_id
- value
required:
- item_id
- value
title: 产品规格
x-apifox-orders:
- sku_id
- sku_code
- sku_image_url
- fob_price
- disable_flag
- attributes
required:
- attributes
description: 多规格产品则必填
sub_product_sku_items:
type: array
title: 组合产品子产品列表
items:
type: object
properties:
sub_sku_id:
type: integer
title: 子产品SKU ID
sub_product_id:
type: integer
title: 子产品ID
count:
type: integer
title: 子产品数量
x-apifox-orders:
- sub_sku_id
- sub_product_id
- count
images_base64:
type: array
items:
type: object
properties:
file_name:
type: string
title: 图片名称
data:
type: string
title: base64编码的图片数据
x-apifox-orders:
- file_name
- data
required:
- file_name
- data
sku_attributes:
type: array
items:
type: object
properties:
item_id:
type: string
title: 规格类型id
description: 规格类型id 可以从规格接口获取 /v1/product/sku-attribute-list
value:
type: array
items:
type: array
items:
type: object
properties:
item_id:
type: string
title: 规格类型值id
description: 规格类型值id 可以从规格接口获取 /v1/product/sku-attribute-list
x-apifox-orders:
- item_id
required:
- item_id
x-apifox-orders:
- item_id
- value
required:
- item_id
- value
description: 多规格产品则必填
count_per_carton:
type: number
title: 每箱产品数
count_per_package:
type: number
title: 每包装产品数
product_net_weight:
type: number
title: 产品净重
carton_volume:
type: number
title: 单箱体积
carton_net_weight:
type: number
title: 单箱净重
carton_gross_weight:
type: number
title: 单箱毛重
package_type:
type: number
title: 包装方式
cost:
type: number
title: 含税成本价
cost_currency:
type: string
title: 含税成本价币种
cost_unit:
type: string
title: 含税成本价单位
unit:
type: string
title: 计量单位
description: 可以通过产品枚举接口获取计量单位值
is_parts:
type: integer
title: 是否允许为配件
description: 1是，0否
x-apifox-orders:
- product_id
- product_no
- name
- cn_name
- create_user
- product_type
- model
- description
- intro
- product_remark
- unit
- images
- from_url
- hs_code
- place
- info_json
- quantity
- quantity_unit
- price_currency
- price_min
- price_max
- price_unit
- package_gross_weight
- package_unit
- package_size_length
- package_size_weight
- package_size_height
- package_volume
- product_size_length
- product_size_weight
- product_size_height
- product_volume
- group_id
- disable_flag
- fob_type
- gradient_price
- sku_items
- sub_product_sku_items
- images_base64
- sku_attributes
- count_per_carton
- count_per_package
- product_net_weight
- carton_volume
- carton_net_weight
- carton_gross_weight
- package_type
- cost
- cost_currency
- cost_unit
- is_parts
required:
- product_type
example:
product_id: 0
product_no: string
name: string
cn_name: string
create_user: 0
product_type: 1
model: string
description: string
intro: string
product_remark: string
images: string
from_url: string
hs_code: string
place: string
info_json:
- name: string
value: string
quantity: string
quantity_unit: string
price_currency: string
price_min: 0
price_max: 0
price_unit: string
package_gross_weight: string
package_unit: string
package_size_length: 0
package_size_weight: 0
package_size_height: 0
package_volume: 0
product_size_length: 0
product_size_weight: 0
product_size_height: 0
product_volume: 0
product_net_weight: 0
customs_name: 0
customs_cn_name: 0
package_remark: string
count_per_package: string
cost_currency: string
cost: 0
cost_unit: string
unit: string
group_id: 0
# --- truncated at 32 KB (1919 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/xiaoman/refs/heads/main/openapi/xiaoman-default-api-openapi.yml