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#
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:
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>
Voor verzoeken met een JSON-body moet u ook het volgende vermelden:
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#
| Methode | Pad | Doel |
|---|---|---|
POST | /product-import/products | Dien een asynchrone productimportbatch in. |
GET | /product-import/products/status | Haal de huidige of meest recente importtaak op. |
GET | /product-import/products | Vraag de huidige producten van de winkel op. |
DELETE | /product-import/products | Verwijder één product logisch op basis van product-ID of SKU. |
Verloop van een batchimport#
- Dien een productbatch in met
POST /product-import/products. - Sla de
jobIdop die in het antwoord202 Acceptedwordt geretourneerd. - Vraag
GET /product-import/products/statuselke 2 tot 5 seconden op. - Stop met het opvragen van de status zodra deze
completedoffailedwordt. - Als de taak
completedis, controleert ufailedCountenfailuresop fouten bij afzonderlijke producten.
Er kan slechts één importtaak tegelijk actief zijn voor een winkel.