Lengow 的目录 API 目前处于封闭测试阶段，仅授权用户可访问。如需获取访问权限，请联系 Lengow 支持团队。
没有测试权限的账户将收到 403 Forbidden 响应。
没有测试权限的账户将收到 403 Forbidden 响应。
/catalogues
该 Lengow API 端点允许您管理产品目录，无需依赖手动导入或基于界面的更新。它使您能够：
检索您现有的目录和附加来源
读取目录结构和属性
列出、检索、创建、更新和删除单个产品或一组产品
使您的产品数据与您的系统（PIM、ERP、自定义工具）持续同步
目录 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": "Main Catalogue",
"status": "enabled",
"product_id_key": "id_product",
"created_at": "2024-09-11T10:42:28.661555Z",
"updated_at": "2025-11-06T13:57:48.078126Z",
"indexed_at": "2025-11-06T13:57:49.571801Z",
"source": "link",
"products_count": 2134
}- product_id_key
所有与产品相关的 API 操作都依赖于 "product_id_key"（如上面的响应所示）。
"product_id_key" 在您的 Lengow 目录设置中定义，用于标识包含唯一产品 ID 的字段。
更多信息请参见 初始产品属性映射
调用产品端点（例如 获取产品）时，您必须提供在目录中定义为 product_id_key 字段中存储的 产品 ID 值。
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 - 支持单个或批量模式 |
| 删除产品 | 从目录中删除产品 | 移除过时产品 | - 根据 product_id_key 删除产品 - 支持单个或批量模式 |