Lengow 的目录 API 目前处于封闭测试阶段，仅限授权用户访问。请联系 Lengow 支持团队以获取访问权限。
未获得测试访问权限的账户将收到 403 Forbidden 响应。
未获得测试访问权限的账户将收到 403 Forbidden 响应。
/catalogues
此 Lengow API 端点允许您管理产品目录，无需依赖手动导入或基于 UI 的更新。它使您能够：
检索您现有的目录及附加来源
读取目录结构和属性
列出、检索、创建、更新和删除单个产品或产品组
持续同步您的产品数据，来源于您的系统（PIM、ERP、自定义工具）
目录 API 不支持创建目录。只能用于更新和修改现有目录。
目录结构必须先在 Lengow 平台创建，然后才能通过 API 进行管理。
您可以通过 API 更新目录，同时保留 Lengow 平台中配置的定期索引频率，具体取决于您的需求。
重要提示：当触发定期索引时，将覆盖之前通过 API 所做的任何更新。
在 Lengow 沙箱中测试目录 API
您可以使用 Lengow 沙箱 测试目录 API，方法是注册沙箱账户：https://my.lengow.net/registration
在您的沙箱账户中添加目录。然后联系 Lengow 支持团队请求访问目录 API（请在工单中提供您的沙箱账户 ID）。
API 调用可以通过目标地址.net（沙箱环境）而非通常的 .io（生产环境）来完成。
API 文档：https://api.lengow.io/docs/
支持的 API 功能
| 功能 | 状态 |
|---|---|
| 目录 | |
| 列出目录和附加来源 | ✅ 支持 |
| 通过 catalogue_id 获取目录或附加来源元数据 | ✅ 支持 |
| 创建目录 | ❌ 不支持 |
| 启用、禁用、删除目录 | ❌ 不支持 |
| 读取分段 | ❌ 不支持 |
| 产品 | |
| 列出目录中的产品 | ✅ 支持 |
| 通过 product_id_key 获取产品 | ✅ 支持 |
| 创建或替换产品（单个或批量） | ✅ 支持 |
| 部分更新单个或多个产品（单个或批量） | ✅ 支持 |
| 删除产品（单个或批量） | ✅ 支持 |
| 检索产品数据中的优化规则 | ❌ 不支持 |
| 属性 | |
| 列出目录或附加来源中的属性 | ✅ 支持 |
| 创建属性 | ❌ 不支持 |
| 更新属性 | ❌ 不支持 |
| 删除属性 | ❌ 不支持 |
| 通过主目录列出附加来源的属性 | ❌ 不支持 |
关键概念
- 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 删除产品 - 支持单个或批量模式 |