Lengow 的目录 API 目前仅对获得授权的用户开放。请联系 Lengow 支持团队以获取访问权限。
未获得授权访问权限的帐户将收到 403 Forbidden 响应。
/catalogues
Lengow API 的此端点允许您管理产品目录,而无需依赖手动导入或基于 UI 的更新。您可以:
获取现有目录和其他数据源
读取目录结构和属性
列出、获取、创建、更新和删除单个产品或一组产品
持续从您的系统(PIM、ERP、自定义工具)同步产品数据
目录 API 不支持创建目录。它只能用于更新和修改现有目录。
必须先在 Lengow 平台中创建目录结构,然后才能通过 API 进行管理。
在 Lengow Sandbox 中测试目录 API
您可以使用 Lengow Sandbox 测试目录 API,方法是在此处开通 Sandbox 帐户:https://my.lengow.net/registration
在 Sandbox 帐户中添加您的目录。
API 调用可以通过访问 .net(Sandbox)环境来执行,而不是通常使用的 .io(生产环境)。
API 文档:https://api.lengow.io/docs/
API 更新和目录同步
为支持所有 Lengow 客户可靠地更新目录,自 2026 年 12 月 11 日起,目录 API 限制为:
- 每分钟 250 次 API 调用
- 每次 API 调用 1,000 个产品行
通过目录 API 更新产品时,更改会在 Lengow 中立即应用。根据您的数据架构,您可以选择 API 与标准目录导入的交互方式:
- 选项 1:API 更新 + 计划目录导入
如果您的目录也通过计划文件导入进行同步,则下一次文件刷新仍将作为权威数据源,并使用最新文件中的值覆盖产品信息。
实际上,只要源文件中的产品数据保持最新,这就是一种非常出色的工作流程。这种混合机制允许您在白天通过 API 推送紧急数据(例如库存减少),同时每晚的计划更新可确保您的目录始终与主要数据源完全一致,并保证所有产品之间的数据一致性。
- 选项 2:仅使用 API 更新
- ✓ 实时产品更新
- ✓ 无需计划协调
如果您不需要定期进行基于文件的协调,并希望 API 成为管理目录的唯一机制,则可以完全移除计划更新。要使用此模式,只需在 Lengow 界面中将目录同步计划留空即可。
Lengow 中的目录更新报告
计划更新和 API 更新可在 Lengow 中查看,路径为“目录” > 选择您的目录 >“查看之前的目录报告”。
您可以按更新类型进行筛选:计划、手动或 API。
每次更新都会列出新增、更新和删除的产品。
支持的 API 功能
| 功能 | 状态 |
|---|---|
| 目录 | |
| 列出目录和其他数据源 | ✅ 支持 |
| 通过 catalogue_id 获取目录或其他数据源的元数据 | ✅ 支持 |
| 创建目录 | ❌ 不支持 |
| 启用、停用、删除目录 | ❌ 不支持 |
| 读取分组 | ❌ 不支持 |
| 产品 | |
| 列出目录中的产品 | ✅ 支持 |
| 通过 product_id_key 获取产品 | ✅ 支持 |
| 创建或替换产品(单个或批量) | ✅ 支持 |
| 部分更新 1 个产品或一组产品(单个或批量) | ✅ 支持 |
| 删除产品(单个或批量) | ✅ 支持 |
| 获取产品数据中的优化规则 | ❌ 不支持 |
| 属性 | |
| 列出目录或其他数据源中的属性 | ✅ 支持 |
| 创建属性 | ❌ 不支持 |
| 更新属性 | ❌ 不支持 |
| 删除属性 | ❌ 不支持 |
| 通过主目录列出其他数据源中的属性 | ❌ 不支持 |
关键概念
- catalogue_id
API 请求必须使用特定目录的“catalogue_id”作为目标。
- 列出目录通常是第一个调用的端点,因为它会返回帐户中所有可用主目录和其他数据源的列表。其中包含每个目录对应的 “catalogue_id”,后续所有请求都会使用该 ID。
- 获取目录使用“catalogue_id”返回主目录或其他数据源的元数据(例如名称、状态、product_id_key 等)。对于主目录,还会列出其其他数据源。
GET /catalogues/{catalogue_id} 的响应示例:
{
"catalogue_id": 95000,
"name": "FR Catalogue",
"status": "enabled",
"product_id_key": "id_product",
"products_count": 2500,
"role": "main_source",
"created_at": "2024-09-11T10:42:28.661555Z",
"updated_at": "2026-10-06T13:57:48.078126Z",
"indexed_at": "2026-10-06T13:57:49.571801Z",
"source": "link",
"additional_sources": [
124,
125
]
}- product_id_key
所有与产品相关的 API 操作都依赖于“product_id_key”(显示在上述响应中)。
“product_id_key”在 Lengow 的目录设置中定义,用于标识包含唯一产品 ID 的字段。
有关更多信息,请参阅初始产品属性映射
调用产品端点(例如获取产品)时,您必须提供存储在目录字段中的产品 ID 值,该字段由 product_id_key 定义。
API 端点概览
| 操作 | 端点用途 | 典型使用场景 | 行为 |
|---|---|---|---|
| 目录 | |||
| 列出目录 | 获取帐户中的所有目录和其他数据源 | 获取目录的 catalogue_id | 返回帐户中可访问的所有目录 |
| 获取目录 | 通过 catalogue_id 获取目录详细信息 | 获取目录的 product_id_key | - 返回目录信息,例如名称、状态、product_id_key 等 - 指示上次更新(用户修改)和上次索引(Lengow 获取)的时间 |
| 属性 | |||
| 列出属性 | 获取目录或其他数据源的属性列表 | 了解目录结构 | - 返回目录或其他数据源中存在的所有字段名称 - 主目录中不会显示其他数据源的属性 |
| 产品 | |||
| 列出产品 | 获取目录中的所有产品 | 浏览或导出目录数据 | - 返回目录中可用的产品,包括每个产品的所有属性值 - 在 Lengow 平台中添加的优化规则不会显示 |
| 获取产品 | 通过 product_id_key 获取单个产品 | 检查或调试产品 | - 返回单个产品的所有属性值 - 需要提供 product_id_key |
| 创建或替换产品 | 创建或完全覆盖产品数据 | 完整重新同步目录 | - 清除并替换:覆盖现有数据 - 需要提供 product_id_key - 可使用单个或批量模式 |
| 部分更新产品 | 仅更新选定的产品字段 | 价格和库存更新 | - 仅更新提供的字段 (未指定的字段保持不变) - 需要提供 product_id_key - 可使用单个或批量模式 - 对于其他数据源,必须在属性名称前加上其专属 Source ID。例如: SRC_123456:attributename
|
| 删除产品 | 从目录中删除产品 | 移除过时产品 | - 根据 product_id_key 删除产品 - 可使用单个或批量模式 |
评论
请登录写评论。