Ideal House
Saltar al contenido

Obtener estado de importación#

El endpoint de estado devuelve el trabajo de importación actual o más reciente para la tienda.

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

Parámetros de consulta#

CampoTipoObligatorioRestriccionesDescripción
shopIdstringMáximo 64 caracteresShop ID utilizado cuando se envió el lote.

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

Campos de respuesta#

CampoTipoDescripción
jobIdstringIdentificador del trabajo de importación.
shopIdstringTienda asociada con el trabajo.
statusstringUno de pending, running, completed o failed.
totalCountnumberNúmero total de productos enviados.
processedCountnumberNúmero de productos procesados hasta ahora.
successCountnumberNúmero de productos creados o actualizados exitosamente.
failedCountnumberNúmero de productos que fallaron durante el procesamiento a nivel de ítem.
failuresarrayFallos a nivel de ítem. Vacío cuando no han ocurrido fallos a nivel de ítem.
createdAtstringHora de creación del trabajo en formato ISO 8601.
startedAtstring or nullHora de inicio del procesamiento en formato ISO 8601.
updatedAtstringHora de la última actualización del trabajo en formato ISO 8601.
completedAtstring or nullHora de finalización en formato ISO 8601.
errorstring or nullError a nivel de trabajo. Normalmente solo se rellena cuando status es failed.

processedCount es igual a successCount + failedCount.

successCount confirma que el producto fue creado o actualizado en el catálogo. Esto no necesariamente significa que el procesamiento de imágenes haya tenido éxito o que el producto esté inmediatamente disponible para su visualización.

Cada objeto en failures contiene:

CampoTipoDescripción
indexnumberPosición basada en cero del producto en el array original products.
skustringSKU del producto fallido.
messagestringDescripción del fallo. No construya lógica de aplicación que dependa del texto exacto del mensaje.

Estados del trabajo#

EstadoSignificadoAcción recomendada
pendingLa solicitud fue aceptada y está esperando para comenzar.Continuar haciendo polling.
runningLos productos se están procesando.Continuar haciendo polling y usar los campos de conteo para mostrar el progreso.
completedEl lote terminó de procesarse. Algunos productos pueden haber fallado.Verificar failedCount y failures.
failedUn error a nivel de trabajo impidió que el lote se completara normalmente.Revisar error, luego reintentar como se describe a continuación.

Trabajo completado con un fallo a nivel de ítem#

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
}

Un estado completed significa que el flujo de trabajo del lote terminó; no significa que cada producto haya tenido éxito. Los fallos a nivel de ítem no detienen a otros productos en el mismo lote.