API för publika importer

APIHjälp och dokumentation

Skicka ett paket med marknadsdata från ert system och läs valideringsrapporten. Importguiden beskriver uppladdning av CSV och XLSX.

Förbered åtkomst

Skapa en leverantörsnyckel i Inställningar → Utvecklare. Inskick kräver api:write; statusläsning kräver api:read eller api:write. Skicka nyckeln som bearer-token eller med X-API-Key. Abonnemanget måste ge api.access. Kontrollera era tilldelade rättigheter i stället för att utgå från abonnemangets namn.

Gör en provkörning

Använd Content-Type: application/x-ndjson. Varje rad är en kontraktspost med fältet entity. Tabellerna omfattar companies, brands, products, product_identifiers, offers, assortment_mappings och suppressions. En valfri, enstaka manifest-rad anger version och antal.

API-referensen anger aktuella scheman. Referenser måste kunna lösas inom paketet eller den befintliga källans namnrymd. Servern låser källans namnrymd till ert konto.

Exemplet använder en platshållarnyckel och er egen paketfil:

curl -X POST "https://api.test.stockisto.com/api/public/v1/imports?mode=dry-run" \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/x-ndjson" \
  --data-binary @your-bundle.ndjson

Ersätt sk_... och your-bundle.ndjson lokalt. Lägg inte riktiga nycklar eller kunduppgifter i kodarkiv.

Ett godkänt inskick svarar 202 med importId, status, mode och statusUrl. Spara statusUrl; valideringen fortsätter asynkront.

Läs resultatet

GET /api/public/v1/imports/{importId}

Använd en nyckel för samma konto. En okänd import, en annan kunds import eller en uppladdning från admin ger 404.

FältBetydelse
importIdImport-id
createdAtSkapad tid
statuspending, processing, completed, pending-review, rolledBack, failed
modedry-run eller apply
totalRows / validRows / errorRowsAntal från valideringen
reportValideringsdetaljer när de är klara
quotaExceededOm tillämpningen överskred importradskvoten
quotaKvotuppgifter eller null

En slutförd provkörning har en rapport och ändrar inga aktiva rader. Läs avvisningarna i report, bland annat broken_json, unsupported_country och dangling_fk. Avvisade och accepterade rader kan förekomma tillsammans; kontrollera antalen även när körningen är klar.

Skicka för granskning

Rätta paketet och skicka det igen med mode=apply. Det förbereder en ändringsmängd för en Stockisto-operatör. pending-review gäller tills operatören tillämpar den; completed betyder att tillämpningen är klar.

Om quotaExceeded är sant ligger ändringsmängden kvar. Läs quota, lös gränsen och låt operatören tillämpa ändringarna igen. Provkörningar och avvisade ändringsmängder förbrukar ingen importradskvot. Godkända rader gör det. Varje API-anrop förbrukar också API-anropskvot.

Efter tillämpningen skickas import.completed med import-id och radantal till webhook-prenumeranter som konfigurerats i Utvecklare. Behåll verifieringen av webhook-signaturen.

Åtgärda ett avvisat anrop

HTTPÅtgärd
400Kontrollera läge, icke-tom kropp och läsbar NDJSON
401Kontrollera API-nyckeln
402Kontrollera abonnemangets api.access
403Använd en leverantörsnyckel med rätt behörighet
404Kontrollera id och konto
413Dela kroppen så att den ryms inom 10 MB
429Vänta tills gränsen återställs och följ Retry-After

Utelämnat läge väljer dry-run. Importen publicerar inte locatorn. Kontrollera publiceringen separat på Publicera.