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Одно из pending, running, completed или failed.
totalCountnumberОбщее количество отправленных товаров.
processedCountnumberКоличество обработанных товаров на данный момент.
successCountnumberКоличество товаров, успешно созданных или обновленных.
failedCountnumberКоличество товаров, которые не удалось обработать на уровне элементов.
failuresarrayОшибки на уровне элементов. Пусто, если ошибки на уровне элементов не возникали.
createdAtstringВремя создания задания в формате ISO 8601.
startedAtstring or nullВремя начала обработки в формате ISO 8601.
updatedAtstringВремя последнего обновления задания в формате ISO 8601.
completedAtstring or nullВремя завершения в формате ISO 8601.
errorstring or nullОшибка на уровне задания. Обычно заполняется только тогда, когда status равно failed.

processedCount равно successCount + failedCount.

successCount подтверждает, что товар был создан или обновлен в каталоге. Это не обязательно означает, что обработка изображений прошла успешно или что товар немедленно доступен для отображения.

Каждый объект в failures содержит:

ПолеТипОписание
indexnumberПозиция товара в исходном массиве products, начиная с нуля.
skustringSKU товара, обработка которого завершилась ошибкой.
messagestringОписание ошибки. Не создавайте логику приложения, зависящую от точного текста сообщения.

Статусы заданий#

СтатусЗначениеРекомендуемое действие
pendingЗапрос принят и ожидает начала.Продолжайте опрос.
runningТовары обрабатываются.Продолжайте опрос и используйте поля счетчиков для отображения прогресса.
completedОбработка партии завершена. Обработка некоторых товаров могла завершиться ошибкой.Проверьте failedCount и failures.
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 означает, что рабочий процесс партии завершён; это не означает, что все товары были обработаны успешно. Ошибки на уровне элементов не останавливают другие товары в той же партии.