Ideal House
Przejdź do treści

Uzyskaj status importu#

Punkt końcowy stanu zwraca bieżące lub najnowsze zadanie importu dla sklepu.

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

Parametry zapytania#

PoleTypWymaganeOgraniczeniaOpis
shopIdstringTakMaksymalnie 64 znakiShop ID użyty podczas przesyłania partii.

Przykład 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>'

Pola odpowiedzi#

PoleTypOpis
jobIdstringIdentyfikator zadania importu.
shopIdstringSklep powiązany z zadaniem.
statusstringJedna z wartości: pending, running, completed lub failed.
totalCountnumberŁączna liczba przesłanych produktów.
processedCountnumberLiczba produktów przetworzonych do tej pory.
successCountnumberLiczba produktów pomyślnie utworzonych lub zaktualizowanych.
failedCountnumberLiczba produktów, których przetwarzanie zakończyło się błędem na poziomie pojedynczego produktu.
failuresarrayBłędy na poziomie elementu. Puste, jeśli nie wystąpiły żadne błędy na poziomie elementu.
createdAtstringCzas utworzenia zadania w formacie ISO 8601.
startedAtstring or nullCzas rozpoczęcia przetwarzania w formacie ISO 8601.
updatedAtstringCzas ostatniej aktualizacji zadania w formacie ISO 8601.
completedAtstring or nullCzas zakończenia zadania w formacie ISO 8601.
errorstring or nullBłąd na poziomie zadania. Pole jest zwykle wypełnione tylko wtedy, gdy status ma wartość failed.

processedCount równa się successCount + failedCount.

successCount potwierdza utworzenie lub zaktualizowanie produktu w katalogu. Nie musi to oznaczać, że przetwarzanie obrazu się powiodło ani że produkt jest od razu gotowy do wyświetlenia.

Każdy obiekt w failures zawiera:

PoleTypOpis
indexnumberPozycja produktu w pierwotnej tablicy products, liczona od zera.
skustringSKU produktu, którego przetwarzanie zakończyło się błędem.
messagestringOpis awarii. Nie buduj logiki aplikacji zależnej od dokładnego tekstu komunikatu.

Statusy zadania#

StanZnaczenieZalecane działanie
pendingŻądanie zostało przyjęte i oczekuje na rozpoczęcie.Kontynuuj okresowe odpytywanie o status.
runningProdukty są przetwarzane.Kontynuuj odpytywanie o status i używaj pól liczników do wyświetlania postępu.
completedPrzetwarzanie partii zostało zakończone. Przetwarzanie niektórych produktów mogło zakończyć się błędem.Sprawdź failedCount i failures.
failedBłąd na poziomie zadania uniemożliwił normalne ukończenie partii.Sprawdź error, a następnie ponów próbę zgodnie z opisem poniżej.

Zakończone zadanie z błędem pojedynczego produktu#

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
}

Status completed oznacza zakończenie przetwarzania partii; nie oznacza, że wszystkie produkty zostały przetworzone pomyślnie. Błąd pojedynczego produktu nie zatrzymuje przetwarzania pozostałych produktów w tej samej partii.