Ideal House
Naar inhoud gaan

Importstatus ophalen#

Het statuseindpunt retourneert de huidige of meest recente importtaak voor de winkel.

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

Queryparameters#

VeldTypeVereistBeperkingenBeschrijving
shopIdstringJaMaximaal 64 tekensShop ID die bij het indienen van de batch is gebruikt.

cURL-voorbeeld#

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

Antwoordvelden#

VeldTypeBeschrijving
jobIdstringIdentificatie van de importtaak.
shopIdstringWinkel die aan de taak is gekoppeld.
statusstringEen van pending, running, completed, of failed.
totalCountnumberTotaal aantal ingediende producten.
processedCountnumberAantal tot nu toe verwerkte producten.
successCountnumberAantal producten dat succesvol is aangemaakt of bijgewerkt.
failedCountnumberAantal producten waarvan de afzonderlijke verwerking is mislukt.
failuresarrayFouten op artikelniveau. Leeg als er geen fouten op artikelniveau zijn opgetreden.
createdAtstringAanmaaktijdstip van de taak in ISO 8601-formaat.
startedAtstring or nullStarttijd van verwerking in ISO 8601-formaat.
updatedAtstringLaatste taakupdatetijd in ISO 8601-indeling.
completedAtstring or nullEindtijdstip van de taak in ISO 8601-formaat.
errorstring or nullFout op taakniveau. Dit veld is normaal gesproken alleen ingevuld wanneer status de waarde failed heeft.

processedCount is gelijk aan successCount + failedCount.

successCount bevestigt dat het product in de catalogus is aangemaakt of bijgewerkt. Dit betekent niet noodzakelijk dat de beeldverwerking is geslaagd of dat het product direct kan worden weergegeven.

Elk object in failures bevat:

VeldTypeBeschrijving
indexnumberPositie van het product in de oorspronkelijke array products, geteld vanaf nul.
skustringSKU van het product waarvan de verwerking is mislukt.
messagestringBeschrijving van de fout. Bouw geen applicatielogica die afhankelijk is van de exacte berichttekst.

Taakstatussen#

StatusBetekenisAanbevolen actie
pendingHet verzoek is geaccepteerd en wacht tot de verwerking begint.Blijf de status regelmatig opvragen.
runningDe producten worden verwerkt.Blijf de status opvragen en gebruik de tellervelden om de voortgang te tonen.
completedDe verwerking van de batch is voltooid. De verwerking van sommige producten kan zijn mislukt.Controleer failedCount en failures.
failedEen fout op taakniveau verhinderde dat de batch normaal werd voltooid.Controleer error en probeer het vervolgens opnieuw zoals hieronder beschreven.

Voltooide taak met een fout op itemniveau#

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
}

De status completed betekent dat het verwerkingsproces van de batch is afgerond; niet dat elk product succesvol is verwerkt. Een fout bij één product stopt de verwerking van andere producten in dezelfde batch niet.