Ideal House
Passa al contenuto

Ottieni lo stato dell'importazione#

L'endpoint di stato restituisce il processo di importazione corrente o più recente per il negozio.

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

Parametri della query#

CampoTipoObbligatorioVincoliDescrizione
shopIdstringMassimo 64 caratteriID negozio utilizzato quando è stato inviato il batch. (Shop ID)

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

Campi di risposta#

CampoTipoDescrizione
jobIdstringIdentificatore del processo di importazione.
shopIdstringNegozio associato all’attività.
statusstringUno di pending, running, completed, o failed.
totalCountnumberNumero totale di prodotti inviati.
processedCountnumberNumero di prodotti elaborati finora.
successCountnumberNumero di prodotti creati o aggiornati correttamente.
failedCountnumberNumero di prodotti la cui elaborazione individuale non è riuscita.
failuresarrayErrori relativi a singoli prodotti. Vuoto se non si sono verificati errori a livello di singolo prodotto.
createdAtstringData e ora di creazione dell’attività in formato ISO 8601.
startedAtstring or nullOra di inizio elaborazione in formato ISO 8601.
updatedAtstringOra dell'ultimo aggiornamento del lavoro in formato ISO 8601.
completedAtstring or nullData e ora di conclusione dell’attività in formato ISO 8601.
errorstring or nullErrore a livello di attività. Il campo è normalmente valorizzato solo quando status è failed.

processedCount è uguale successCount + failedCount.

successCount conferma che il prodotto è stato creato o aggiornato nel catalogo. Questo non implica necessariamente che l’elaborazione dell’immagine sia riuscita o che il prodotto sia immediatamente disponibile per la visualizzazione.

Ogni oggetto dentro failures contiene:

CampoTipoDescrizione
indexnumberPosizione del prodotto nell’array originale products, con indice iniziale zero.
skustringSKU del prodotto la cui elaborazione non è riuscita.
messagestringDescrizione dell’errore. Non creare una logica dell'applicazione che dipenda dal testo esatto del messaggio.

Stati dell’attività#

StatoSignificatoAzione consigliata
pendingLa richiesta è stata accettata ed è in attesa di avvio.Continuare a interrogare periodicamente lo stato.
runningI prodotti sono in fase di elaborazione.Continuare a interrogare lo stato e usare i contatori per visualizzare l’avanzamento.
completedL’elaborazione del lotto è terminata. L’elaborazione di alcuni prodotti potrebbe non essere riuscita.Controllare failedCount e failures.
failedUn errore a livello di lavoro ha impedito il normale completamento del batch.Esaminare error, quindi riprovare come descritto di seguito.

Lavoro completato con un errore a livello di articolo#

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
}

Lo stato completed indica che il flusso di elaborazione del lotto è terminato; non significa che ogni prodotto sia stato elaborato correttamente. Gli errori relativi a singoli prodotti non interrompono l’elaborazione degli altri prodotti nello stesso lotto.