小满OKKICRM 产品查询接口字段手册权威教程
小满OKKICRM聚水潭接口字段手册产品主数据增量同步轻易云
这个接口解决什么问题
在 CRM 与 ERP 的双向集成场景中,「产品主数据」往往是订单、库存、价格的共同底座。小满 OKKICRM 的 /v1/product/list 接口用于按更新时间增量拉取产品主数据,为聚水潭侧的商品映射、订单同步、报价计算提供统一的产品字典。典型用途包括产品主数据同步、产品分类关联、成本价与离岸价获取,是销售订单集成链路上游的「数据源开关」。
接口能力总览
- 认证方式:小满 OKKICRM 开放平台 OAuth 风格的 AccessToken,通常由聚水潭侧的连接器统一托管刷新。
- 请求方式:
POST /v1/product/list,JSON Body。 - 可传筛选条件:
product_type(1=无规格、2=多规格、3=组合)、update_time_start/update_time_end(增量时间窗)、page/page_size(分页)。 - 响应结构:通常为
{ code, message, data: { items: [...], total } },列表元素即产品对象。 - 分页模式:经典
page+page_size组合,推荐在轻易云里把page_size设到平台允许的上限以减少请求次数。 - 增量模式:基于
update_time字段的窗口式增量,稳妥做法是上一次窗口结束时间 -1s ~ 当前时间,避免边界漏单。
典型字段映射
| 字段名 | 类型 | 含义 | 实战注意事项 |
|---|---|---|---|
| product_id | string | 产品主键,系统内唯一 | 在轻易云字段映射器里通常映射为目标侧 SKU 主键或自定义外部编码 |
| product_no | string | 产品编号/编码 | 作为跨系统业务引用键,建议作为去重与幂等键 |
| name | string | 产品名称 | 注意是否包含前后空格,显示前建议 trim |
| group_id | string | 产品分类 ID | 关联 /v1/product/groups 的分类主数据,常常需要先同步分类再回填 |
| group_name | string | 产品分类名称 | 冗余展示字段,跨系统时不要将其当作唯一关联键 |
| image | string | 产品主图 URL | 注意 HTTPS 协议与过期签名,展示侧通常需要转存 CDN |
| cost_with_tax | object | 含税成本价 | 金额对象,真实场景中常需解析 amount 与 currency 子字段 |
| fob | object | 离岸价 FOB | 与 cost_with_tax 同结构,容易混淆币种 |
| minimum_order_quantity | object | 最小起订量 | 对象类型,解析后转 int/double 写入下游 |
在轻易云上如何配置
在轻易云数据集成平台里,小满「产品查询」通常被封装为一个只读源端适配器:注册应用后,平台托管 Token 刷新与限速;字段映射器把 product_id/product_no/name 等自动对接到聚水潭商品模型;调度器按 crontab: 15 7-22 * * * 每 15 分钟触发,Target 配置为「写入空操作」,即纯查询策略,不回写小满。增量键推荐直接选用平台内置的「按更新时间窗口」模式,平台会自动记忆上一次边界。
跨方案实战要点
- 产品类型先分流:
product_type决定下游 SKU 写入逻辑,集成时务必先按类型分桶,再决定是否需要展开多规格子项。 - 分类先于产品:多个真实项目里我们都发现,先同步
/v1/product/groups再写产品,可以显著降低脏数据率。 - 金额对象一律按子字段解析:
cost_with_tax、fob是 object,务必明确币种与精度,避免被默认 0 覆盖。 - product_no 是稳定锚点:
product_id在某些后台重导后会变,真正稳定的是product_no,建议在下游把product_no作为外部编码唯一键。 - 图片链接做转存而非直连:小满图床常带签名过期,直接落库会被前端展示侧判定为失效。
- 增量窗口别忘了去重:
update_time同一秒内可能多条,稳妥做法是用product_id在下游做幂等 upsert。
踩坑复盘
- 坑 1:把
group_name当 ID 用。它是冗余展示字段,跨系统后名称会被改写,导致原本挂好的分类链路全断。 - 坑 2:金额对象当成数值直接相加。
cost_with_tax是 object,直接+会报错或得到拼接字符串。 - 坑 3:
page_size设太大触发限流。小满侧对单次返回体大小有限制,真实场景中超过平台允许上限会被截断或拒绝。 - 坑 4:增量漏单。增量窗口没有包含
update_time == last_end这一秒,边界记录会被遗漏。 - 坑 5:Token 过期未自动续期。凌晨任务偶发 401,根因是长任务跨过了 Token 有效期,需要在轻易云里开启自动刷新。
何时选用
适用于「小满 OKKICRM 作为产品主数据源 + 聚水潭作为下游交易系统」的销售订单链路,需要做产品字典同步、订单商品映射、价格成本对齐等场景。不适用于反向把聚水潭商品回写小满、不涉及产品主数据只查订单明细的场景,以及需要实时强一致而非近实时同步的财务对账场景。
本文为原创内容,转载请注明出处:https://www.qeasy.cloud/insights/engineering/hb-p2-053-7fdb