Ideal House
跳转到主要内容

获取导入状态#

状态端点返回店铺当前或最近的导入作业。

http
GET https://sdkapi.ideal.house/product-import/products/status?shopId=<SHOP_ID>

查询参数#

字段类型必填约束条件说明
shopIdstring最多 64 个字符提交批次时使用的 Shop ID。

cURL 示例#

bash
curl --request GET \
  'https://sdkapi.ideal.house/product-import/products/status?shopId=shop_123' \
  --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
  --header 'X-Client-Secret: <YOUR_CLIENT_SECRET>'

响应字段#

字段类型说明
jobIdstring导入作业的标识符。
shopIdstring与该作业关联的店铺。
statusstring取值为 pendingrunningcompletedfailed 之一。
totalCountnumber提交的总商品数。
processedCountnumber截至目前已处理的商品数。
successCountnumber成功创建或更新的商品数。
failedCountnumber在项目级处理过程中失败的商品数。
failuresarray项目级失败记录。当未发生项目级失败时为空。
createdAtstring作业创建时间,采用 ISO 8601 格式。
startedAtstring or null处理开始时间,采用 ISO 8601 格式。
updatedAtstring最后一次作业更新时间,采用 ISO 8601 格式。
completedAtstring or null终止时间,采用 ISO 8601 格式。
errorstring or null作业级错误。通常仅在 statusfailed 时填写。

processedCount 等于 successCount + failedCount

successCount 确认商品已在目录中创建或更新。这并不一定意味着图片处理成功,也不意味着商品立即可用于展示。

failures 中的每个对象包含:

字段类型说明
indexnumber商品在原始 products 数组中的从零开始的索引位置。
skustring失败商品的 SKU。
messagestring失败描述。请勿构建依赖于该消息确切文本的应用程序逻辑。

作业状态#

状态含义推荐操作
pending请求已被接受,正在等待开始执行。继续轮询。
running正在处理商品。继续轮询,并使用计数字段显示进度。
completed批次处理完毕。部分商品可能仍有失败。检查 failedCountfailures
failed作业级错误导致批次未能正常完成。查看 error,然后按以下方式重试。

已完成但存在项目级失败的作业#

json
{
  "jobId": "1930000000000000000",
  "shopId": "shop_123",
  "status": "completed",
  "totalCount": 2,
  "processedCount": 2,
  "successCount": 1,
  "failedCount": 1,
  "failures": [
    {
      "index": 1,
      "sku": "SKU-10002",
      "message": "Unable to import the remote image"
    }
  ],
  "createdAt": "2026-07-21T06:30:00.000Z",
  "startedAt": "2026-07-21T06:30:00.010Z",
  "updatedAt": "2026-07-21T06:30:08.000Z",
  "completedAt": "2026-07-21T06:30:08.000Z",
  "error": null
}

completed 状态表示批次工作流已结束;但这并不意味着每个商品都成功。项目级失败不会阻止同一批次中的其他商品继续处理。