Ideal House
Passa al contenuto

Ideal House Product Import API#

Usare Product Import API per importare, elencare ed eliminare logicamente i prodotti nel catalogo Ideal House. Le importazioni in blocco accettano da 1 a 500 prodotti e vengono elaborate in modo asincrono. Le operazioni di elenco ed eliminazione vengono elaborate in modo sincrono.

URL di base#

text
https://sdkapi.ideal.house

Utilizza HTTPS per tutte le richieste. I corpi delle richieste e delle risposte JSON sono codificati come UTF-8.

Prima di iniziare#

Ideal House fornirà i seguenti valori durante la configurazione iniziale:

  • Shop ID
  • Client ID
  • Client Secret

Client ID e Client Secret sono credenziali lato server. Non esporre mai Client Secret nel codice del browser, nelle applicazioni mobili, nei repository pubblici, nei log o in altri ambienti lato client.

Autenticazione#

Includi queste intestazioni in ogni richiesta:

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

Per le richieste con un corpo JSON, includere anche:

http
Content-Type: application/json

Il shopId nella richiesta deve corrispondere al negozio associato alle credenziali. In caso di mancata corrispondenza viene restituito 403 Forbidden.

Riepilogo dell'API#

MetodoPercorsoScopo
POST/product-import/productsInvia un batch di importazione di prodotti asincrono.
GET/product-import/products/statusOttieni il processo di importazione corrente o più recente.
GET/product-import/productsElenca i prodotti attuali del negozio.
DELETE/product-import/productsElimina logicamente un prodotto in base all'ID prodotto o allo SKU.

Flusso di importazione batch#

  1. Invia un lotto di prodotto con POST /product-import/products.
  2. Salvare il jobId restituito nella risposta 202 Accepted.
  3. Interrogare GET /product-import/products/status ogni 2-5 secondi.
  4. Interrompere le interrogazioni periodiche quando lo stato diventa completed o failed.
  5. Se l’attività è completed, esaminare failedCount e failures per individuare errori relativi a singoli prodotti.

Per un negozio può essere attivo un solo lavoro di importazione alla volta.