Ideal House
跳转到主要内容

Ideal House Product Import API#

使用 Product Import API 导入、列出并逻辑删除您 Ideal House 目录中的商品。批量导入接受 1 至 500 个商品，并异步处理。列表和删除操作同步处理。

基础 URL#

text
https://sdkapi.ideal.house

所有请求使用 HTTPS。JSON 请求和响应体采用 UTF-8 编码。

开始之前#

Ideal House 将在商家开通流程中提供以下值：

  • Shop ID
  • 一个 Client ID
  • 一个 Client Secret

Client ID 和 Client Secret 是服务端凭据。切勿在浏览器代码、移动应用、公共仓库、日志或其他客户端环境中暴露 Client Secret。

认证#

每条请求均需包含以下请求头：

http
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>

对于带有 JSON 体的请求，还需包含：

http
Content-Type: application/json

请求中的 shopId 必须与凭据关联的店铺匹配。不匹配将返回 403 Forbidden。

API 概览#

方法路径用途
POST/product-import/products提交异步商品导入批次。
GET/product-import/products/status获取当前或最近的导入任务。
GET/product-import/products列出店铺的当前商品。
DELETE/product-import/products按商品 ID 或 SKU 逻辑删除单个商品。

批量导入流程#

  1. 通过 POST /product-import/products 提交商品批次。
  2. 保存 202 Accepted 响应中返回的 jobId。
  3. 每 2 到 5 秒轮询一次 GET /product-import/products/status。
  4. 当状态变为 completed 或 failed 时停止轮询。
  5. 若任务状态为 completed，请检查 failedCount 和 failures 以查看条目级错误。

同一时间每个店铺只能有一个导入任务处于活跃状态。