Ideal House Product Import API#

Use la Product Import API para importar, listar y eliminar lógicamente productos en el catálogo de su Ideal House. Las importaciones por lotes aceptan entre 1 y 500 productos y se procesan de forma asíncrona. Las operaciones de listado y eliminación se procesan de forma síncrona.

URL base#

text

https://sdkapi.ideal.house

Use HTTPS para todas las solicitudes. Los cuerpos de solicitud y respuesta JSON están codificados en UTF-8.

Antes de comenzar#

Ideal House proporcionará los siguientes valores durante el proceso de incorporación:

Un Shop ID
Un Client ID
Un Client Secret

El Client ID y el Client Secret son credenciales del lado del servidor. Nunca exponga el Client Secret en código del navegador, aplicaciones móviles, repositorios públicos, registros u otros entornos del lado del cliente.

Autenticación#

Incluya estos encabezados en cada solicitud:

http

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

Para solicitudes con cuerpo JSON, incluya también:

http

Content-Type: application/json

El shopId en la solicitud debe coincidir con la tienda asociada a las credenciales. Un error de coincidencia devuelve 403 Forbidden.

Resumen de la API#

Método	Ruta	Propósito
`POST`	`/product-import/products`	Enviar un lote de importación de productos asíncrono.
`GET`	`/product-import/products/status`	Obtener el trabajo de importación actual o más reciente.
`GET`	`/product-import/products`	Listar los productos actuales de la tienda.
`DELETE`	`/product-import/products`	Eliminar lógicamente un producto por Product ID o SKU.

Flujo de importación por lotes#

Envíe un lote de productos con POST /product-import/products.
Guarde el jobId devuelto en la respuesta 202 Accepted.
Consulte GET /product-import/products/status cada 2 a 5 segundos.
Detenga las consultas cuando el estado sea completed o failed.
Si el trabajo está completed, examine failedCount y failures para errores a nivel de elemento.

Solo puede haber un trabajo de importación activo para una tienda a la vez.