Ideal House
Aller au contenu principal

Obtenir l'état d'importation#

Le point de terminaison de statut renvoie la tâche d'importation actuelle ou la plus récente pour la boutique.

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

Paramètres de requête#

ChampTypeRequisContraintesDescription
shopIdstringOuiMaximum 64 caractèresShop ID utilisé lors de la soumission du lot.

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

Champs de réponse#

ChampTypeDescription
jobIdstringIdentifiant de la tâche d'importation.
shopIdstringBoutique associée à la tâche.
statusstringL'une des valeurs suivantes : pending, running, completed ou failed.
totalCountnumberNombre total de produits soumis.
processedCountnumberNombre de produits traités à ce jour.
successCountnumberNombre de produits créés ou mis à jour avec succès.
failedCountnumberNombre de produits ayant échoué lors du traitement au niveau de l'article.
failuresarrayÉchecs au niveau de l'article. Vide lorsqu'aucun échec au niveau de l'article ne s'est produit.
createdAtstringDate de création de la tâche au format ISO 8601.
startedAtstring or nullDate de début du traitement au format ISO 8601.
updatedAtstringDernière date de mise à jour de la tâche au format ISO 8601.
completedAtstring or nullDate de fin du traitement au format ISO 8601.
errorstring or nullErreur au niveau de la tâche. Généralement renseignée uniquement lorsque status vaut failed.

processedCount est égal à successCount + failedCount.

successCount confirme que le produit a été créé ou mis à jour dans le catalogue. Cela ne signifie pas nécessairement que le traitement des images a réussi ou que le produit est immédiatement disponible à l'affichage.

Chaque objet dans failures contient :

ChampTypeDescription
indexnumberPosition indexée à partir de zéro du produit dans le tableau products d'origine.
skustringSKU du produit en échec.
messagestringDescription de l'échec. Ne construisez pas de logique applicative dépendant du texte exact du message.

Statuts des tâches#

StatutSignificationAction recommandée
pendingLa requête a été acceptée et attend de démarrer.Continuer l'interrogation périodique.
runningLes produits sont en cours de traitement.Continuer l'interrogation périodique et utiliser les champs de comptage pour afficher la progression.
completedLe lot a terminé son traitement. Certains produits peuvent toujours avoir échoué.Vérifier failedCount et failures.
failedUne erreur au niveau de la tâche a empêché le lot de s'achever normalement.Examiner error, puis réessayer comme décrit ci-dessous.

Tâche terminée avec un échec au niveau de l'article#

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 statut completed signifie que le flux de travail du lot est terminé ; cela ne signifie pas que tous les produits ont réussi. Les échecs au niveau de l'article n'arrêtent pas les autres produits du même lot.