Ideal House
Naar inhoud gaan

Ideal House Product Import API#

Gebruik de Product Import API om producten in uw Ideal House-catalogus te importeren, op te vragen en logisch te verwijderen. Een batchimport accepteert 1 tot 500 producten en wordt asynchroon verwerkt. Het opvragen en verwijderen van producten gebeurt synchroon.

Basis-URL#

text
https://sdkapi.ideal.house

Gebruik HTTPS voor alle verzoeken. De JSON-inhoud van verzoeken en antwoorden wordt gecodeerd als UTF-8.

Voordat u begint#

Ideal House verstrekt tijdens het aansluitproces de volgende waarden:

  • Shop ID
  • Client ID
  • Client Secret

Client ID en Client Secret zijn toegangsgegevens voor gebruik op de server. Maak Client Secret nooit openbaar in browsercode, mobiele applicaties, openbare repositories, logboeken of andere omgevingen aan de clientzijde.

Authenticatie#

Voeg deze headers toe bij elk verzoek:

http
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>

Voor verzoeken met een JSON-body moet u ook het volgende vermelden:

http
Content-Type: application/json

De shopId in het verzoek moet overeenkomen met de winkel die aan de toegangsgegevens is gekoppeld. Bij een afwijking retourneert de API 403 Forbidden.

API-samenvatting#

MethodePadDoel
POST/product-import/productsDien een asynchrone productimportbatch in.
GET/product-import/products/statusHaal de huidige of meest recente importtaak op.
GET/product-import/productsVraag de huidige producten van de winkel op.
DELETE/product-import/productsVerwijder één product logisch op basis van product-ID of SKU.

Verloop van een batchimport#

  1. Dien een productbatch in met POST /product-import/products.
  2. Sla de jobId op die in het antwoord 202 Accepted wordt geretourneerd.
  3. Vraag GET /product-import/products/status elke 2 tot 5 seconden op.
  4. Stop met het opvragen van de status zodra deze completed of failed wordt.
  5. Als de taak completed is, controleert u failedCount en failures op fouten bij afzonderlijke producten.

Er kan slechts één importtaak tegelijk actief zijn voor een winkel.