Obter Status de Importação#

O endpoint de status retorna o trabalho de importação atual ou mais recente da loja.

http

GET https://sdkapi.ideal.house/product-import/products/status?shopId=<SHOP_ID>

Parâmetros de Consulta#

Campo	Tipo	Obrigatório	Restrições	Descrição
`shopId`	string	Sim	Máximo 64 caracteres	Shop ID usado quando o lote foi submetido.

Exemplo cURL#

bash

curl --request GET \
  'https://sdkapi.ideal.house/product-import/products/status?shopId=shop_123' \
  --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
  --header 'X-Client-Secret: <YOUR_CLIENT_SECRET>'

Campos de Resposta#

Campo	Tipo	Descrição
`jobId`	string	Identificador do trabalho de importação.
`shopId`	string	Loja associada ao trabalho.
`status`	string	Um dos valores `pending`, `running`, `completed` ou `failed`.
`totalCount`	number	Número total de produtos submetidos.
`processedCount`	number	Número de produtos processados até o momento.
`successCount`	number	Número de produtos criados ou atualizados com sucesso.
`failedCount`	number	Número de produtos que falharam durante o processamento em nível de item.
`failures`	array	Falhas em nível de item. Vazio quando não houver falhas em nível de item.
`createdAt`	string	Hora de criação do trabalho no formato ISO 8601.
`startedAt`	string or null	Hora de início do processamento no formato ISO 8601.
`updatedAt`	string	Hora da última atualização do trabalho no formato ISO 8601.
`completedAt`	string or null	Hora final no formato ISO 8601.
`error`	string or null	Erro em nível de trabalho. Normalmente preenchido apenas quando `status` é `failed`.

processedCount é igual a successCount + failedCount.

successCount confirma que o produto foi criado ou atualizado no catálogo. Isso não significa necessariamente que o processamento da imagem foi bem-sucedido ou que o produto está imediatamente disponível para exibição.

Cada objeto em failures contém:

Campo	Tipo	Descrição
`index`	number	Posição baseada em zero do produto no array original `products`.
`sku`	string	SKU do produto com falha.
`message`	string	Descrição da falha. Não construa lógica de aplicativo que dependa do texto exato da mensagem.

Status dos Trabalhos#

Status	Significado	Ação recomendada
`pending`	A solicitação foi aceita e está aguardando para começar.	Continue fazendo polling.
`running`	Produtos estão sendo processados.	Continue fazendo polling e use os campos de contagem para exibir o progresso.
`completed`	O lote terminou o processamento. Alguns produtos ainda podem ter falhado.	Verifique `failedCount` e `failures`.
`failed`	Um erro em nível de trabalho impediu que o lote fosse concluído normalmente.	Revise `error`, então tente novamente conforme descrito abaixo.

Trabalho Concluído com Falha em Nível de Item#

json

{
  "jobId": "1930000000000000000",
  "shopId": "shop_123",
  "status": "completed",
  "totalCount": 2,
  "processedCount": 2,
  "successCount": 1,
  "failedCount": 1,
  "failures": [
    {
      "index": 1,
      "sku": "SKU-10002",
      "message": "Unable to import the remote image"
    }
  ],
  "createdAt": "2026-07-21T06:30:00.000Z",
  "startedAt": "2026-07-21T06:30:00.010Z",
  "updatedAt": "2026-07-21T06:30:08.000Z",
  "completedAt": "2026-07-21T06:30:08.000Z",
  "error": null
}

Um status completed significa que o fluxo de trabalho do lote foi finalizado; não significa que todos os produtos tiveram sucesso. Falhas em nível de item não impedem outros produtos no mesmo lote.