Get Import Status#

The status endpoint returns the current or most recent import job for the shop.

http

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

Query Parameters#

Field	Type	Required	Constraints	Description
`shopId`	string	Yes	Maximum 64 characters	Shop ID used when the batch was submitted.

cURL Example#

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>'

Response Fields#

Field	Type	Description
`jobId`	string	Identifier of the import job.
`shopId`	string	Shop associated with the job.
`status`	string	One of `pending`, `running`, `completed`, or `failed`.
`totalCount`	number	Total number of products submitted.
`processedCount`	number	Number of products processed so far.
`successCount`	number	Number of products successfully created or updated.
`failedCount`	number	Number of products that failed during item-level processing.
`failures`	array	Item-level failures. Empty when no item-level failures have occurred.
`createdAt`	string	Job creation time in ISO 8601 format.
`startedAt`	string or null	Processing start time in ISO 8601 format.
`updatedAt`	string	Last job update time in ISO 8601 format.
`completedAt`	string or null	Terminal time in ISO 8601 format.
`error`	string or null	Job-level error. Normally populated only when `status` is `failed`.

processedCount equals successCount + failedCount.

successCount confirms that the product was created or updated in the catalog. It does not necessarily mean that image processing succeeded or that the product is immediately available for display.

Each object in failures contains:

Field	Type	Description
`index`	number	Zero-based position of the product in the original `products` array.
`sku`	string	SKU of the failed product.
`message`	string	Failure description. Do not build application logic that depends on the exact message text.

Job Statuses#

Status	Meaning	Recommended action
`pending`	The request was accepted and is waiting to start.	Continue polling.
`running`	Products are being processed.	Continue polling and use the count fields to display progress.
`completed`	The batch finished processing. Some products may still have failed.	Check `failedCount` and `failures`.
`failed`	A job-level error prevented the batch from completing normally.	Review `error`, then retry as described below.

Completed Job with an Item-Level Failure#

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
}

A completed status means the batch workflow finished; it does not mean every product succeeded. Item-level failures do not stop other products in the same batch.