Ideal House Product Import API#

Use a Product Import API para importar, listar e excluir logicamente produtos no catálogo da sua Ideal House. As imports em lote aceitam de 1 a 500 produtos e são processadas de forma assíncrona. As operações de listagem e deleção são processadas de forma síncrona.

URL base#

text

https://sdkapi.ideal.house

Use HTTPS para todas as requisições. Os corpos JSON de requisição e resposta são codificados como UTF-8.

Antes de começar#

A Ideal House fornecerá os seguintes valores durante o onboarding:

Um Shop ID
Um Client ID
Um Client Secret

O Client ID e o Client Secret são credenciais do lado do servidor. Nunca exponha o Client Secret em código de navegador, aplicativos móveis, repositórios públicos, logs ou outros ambientes client-side.

Autenticação#

Inclua estes headers em todas as requisições:

http

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

Para requisições com corpo JSON, inclua também:

http

Content-Type: application/json

O shopId na requisição deve corresponder à shop associada às credenciais. Um mismatch retorna 403 Forbidden.

Resumo da API#

Método	Caminho	Finalidade
`POST`	`/product-import/products`	Enviar um lote de importação de produto de forma assíncrona.
`GET`	`/product-import/products/status`	Obter o job de import atual ou mais recente.
`GET`	`/product-import/products`	Listar os produtos atuais da shop.
`DELETE`	`/product-import/products`	Excluir logicamente um produto por Product ID ou SKU.

Fluxo de Importação em Lote#

Envie um lote de produtos com POST /product-import/products.
Salve o jobId retornado na resposta 202 Accepted.
Poll GET /product-import/products/status a cada 2 a 5 segundos.
Pare de poll quando o status tornar-se completed ou failed.
Se o job estiver completed, inspecione failedCount e failures para erros em nível de item.

Apenas um job de import pode estar ativo para uma shop por vez.