Ideal House Product Import API#

Verwenden Sie Product Import API, um Produkte in Ihren Ideal House-Katalog zu importieren, aufzulisten und logisch zu löschen. Importpakete enthalten 1 bis 500 Produkte und werden asynchron verarbeitet. Das Auflisten und Löschen erfolgt synchron.

Basis-URL#

text

https://sdkapi.ideal.house

Verwenden Sie HTTPS für alle Anfragen. JSON-Anfrage- und Antworttexte sind als UTF-8 kodiert.

Bevor Sie beginnen#

Ideal House stellt beim Onboarding die folgenden Werte bereit:

Shop ID
Client ID
Client Secret

Client ID und Client Secret sind serverseitige Zugangsdaten. Legen Sie Client Secret niemals im Browsercode, in mobilen Anwendungen, öffentlichen Repositorys, Protokollen oder anderen clientseitigen Umgebungen offen.

Authentifizierung#

Fügen Sie diese Header in jede Anfrage ein:

http

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

Geben Sie bei Anfragen mit einem JSON-Text außerdem Folgendes an:

http

Content-Type: application/json

Die shopId in der Anfrage muss mit dem Shop übereinstimmen, der mit den Zugangsdaten verknüpft ist. Bei einer Abweichung wird 403 Forbidden zurückgegeben.

API-Zusammenfassung#

Methode	Pfad	Zweck
`POST`	`/product-import/products`	Senden Sie einen asynchronen Produktimportbatch.
`GET`	`/product-import/products/status`	Rufen Sie den aktuellen oder aktuellsten Importauftrag ab.
`GET`	`/product-import/products`	Listen Sie die aktuellen Produkte des Shops auf.
`DELETE`	`/product-import/products`	Löschen Sie ein Produkt logisch nach Produkt-ID oder SKU.

Batch-Importablauf#

Senden Sie eine Produktcharge mit POST /product-import/products.
Speichern Sie die in der Antwort 202 Accepted zurückgegebene jobId.
Fragen Sie GET /product-import/products/status alle 2 bis 5 Sekunden ab.
Beenden Sie die regelmäßige Abfrage, sobald der Status completed oder failed lautet.
Prüfen Sie bei einem Auftrag mit dem Status completed die Felder failedCount und failures auf Fehler bei einzelnen Produkten.

Für einen Shop kann jeweils nur ein Importjob aktiv sein.