没有beta访问权限的帐户将收到403禁止响应。
/catalogues
这个Lengow API的端点允许你管理你的产品目录,而不依赖于手动导入或基于UI的更新。它使你能够:
检索你现有的目录和额外的来源
阅读目录结构和属性
列出,检索,创建,更新和删除单个产品或一组产品
从你的系统(PIM,ERP,自定义工具)持续同步你的产品数据
目录API 不支持创建目录。它只能用于更新和修改现有的目录。
目录结构必须首先在Lengow平台上创建,然后才能通过API进行管理。
API更新和目录同步
当通过目录API更新产品时,更改会立即在Lengow中应用。根据你的数据架构,你可以选择API如何与你的标准目录导入交互:
选项1:API更新+计划的目录导入
如果你的目录也通过计划的文件导入同步,那么下一个文件刷新将保持为数据的权威来源,并将用最新文件中的值覆盖产品信息。
实际上,只要你的源文件中的产品数据是最新的,这就是一个优秀的工作流程。这种混合机制允许你在白天通过API推送紧急数据(如库存下降),而计划的夜间更新确保你的目录与你的主要数据源完全对齐,并保证所有产品的一致性。
选项2:仅API更新
- ✓ 实时产品更新
- ✓ 无计划的对账
如果你不需要常规的基于文件的对账,并希望API成为你目录管理的唯一机制,你可以完全删除计划的更新。要使用此模式,只需在Lengow界面中留空目录同步计划即可。
在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 获取产品 | ✅ 支持 |
| 创建或替换产品(单个或批量) | ✅ 支持 |
| 部分更新1个产品或一组产品(单个或批量) | ✅ 支持 |
| 删除产品(单个或批量) | ✅ 支持 |
| 在产品数据中检索优化规则 | ❌ 不支持 |
| 属性 | |
| 在目录或附加源中列出属性 | ✅ 支持 |
| 创建属性 | ✅ 支持 |
| 更新属性 | ❌ 不支持 |
| 删除属性 | ❌ 不支持 |
| 通过主目录从其他来源列出属性 | ❌ 不支持 |
关键概念
- catalogue_id
API请求必须针对其"catalogue_id"的特定目录。
- 列出目录通常是首先调用的端点,因为它返回帐户上所有主目录和可用的其他来源的列表。它包括每一个的"catalogue_id",这是所有后续请求所使用的。
- 获取目录使用"catalogue_id"返回主目录或其他来源的元数据(如其名称,状态,product_id_key等)。
GET /catalogues/{catalogue_id}的示例响应:
{
"catalogue_id": 95000,
"name": "主目录",
"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 | 返回所有calogues accessible on the account |
| 获取目录 | 通过目录_id检索目录详细信息 | 获取目录的product_id_key | - 返回目录信息,如名称、状态、product_id_key等 - 表示最后更新(用户修改)和最后索引(Lengow检索) |
| 属性 | |||
| 列出属性 | 检索目录的属性列表 | 理解目录结构 | - 返回目录中存在的所有字段名称 - 附加源的属性在主目录中不显示 |
| 产品 | |||
| 列出产品 | 从目录中检索所有产品 | 浏览或导出目录数据 | - 返回目录中可用的产品,包括每个产品的所有属性值 - 优化规则 在Lengow平台中未显示 |
| 获取产品 | 通过product_id_key检索单个产品 | 检查或调试产品 | - 返回单个产品的所有属性值 - 需要product_id_key |
| 创建或替换产品 | 创建或完全覆盖产品数据 | 完全目录重新同步 | - 清除&替换:覆盖现有数据 - 需要product_id_key - 单个或批量模式可用 |
| 部分更新产品 | 仅更新选定的产品字段 | 价格&库存更新 | |