Obter Importação

GET https://.account-name.krzlabs.io/api/v1/imports/:id

Realiza a leitura de uma importação.

---

Path Params

id string required

ID do import.

---

Responses

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	Optional	Searchable
catalog_id	ObjectId	ID do catálogo relacionado.	not required	false
category_id	ObjectId	ID da categoria relacionada.	not required	false
status	enum	Status da importação.	required	false
file_name	string	Nome do arquivo importado.	not required	true
file_key	string	Chave do arquivo no armazenamento.	not required	false
file_header_row	number	Linha do cabeçalho no arquivo.	not required	false
file_worksheet_id	string	ID da worksheet do arquivo.	not required	false
file_worksheet_name	string	Nome da worksheet do arquivo.	not required	false
columns_count	number	Quantidade de colunas.	not required	false
rows_count	number	Quantidade de linhas.	not required	false
proccess_count	number	Linhas processadas.	not required	false
commit_count	number	Registros comitados.	not required	false
errors_count	number	Quantidade de erros.	not required	false
created_by_name	string	Nome do usuário criador.	required	false
worksheets	array(object)	Worksheets do arquivo. requer duas keys: id: string - required name: string - required	not required	false
headers	array(object)	Cabeçalhos do arquivo. requer duas keys: colmn: string - required. label: string - required	not required	false
mapped_headers	object	Mapeamento dos cabeçalhos.	not required	false
logs	array(string)	Logs da importação.	not required	false
template +	object	Template associado à importação.	not required	false
from_template_id	ObjectId	ID do template de origem.	not required	false

Exemplo em JSON

{
  "catalog_id": "64f1b3d4e5d987654321cdef",
  "category_id": "64f1c4e6e5d567890abcd111",
  "status": "IN_PROGRESS",
  "file_name": "import_products.xlsx",
  "file_key": "import_2025_01",
  "file_header_row": 1,
  "file_worksheet_id": "ws_12345",
  "file_worksheet_name": "Produtos",
  "columns_count": 12,
  "rows_count": 250,
  "proccess_count": 200,
  "commit_count": 180,
  "errors_count": 20,
  "created_by_name": "Mateus Martins",
  "worksheets": [
    {
      "id": "ws_12345",
      "name": "Produtos"
    },
    {
      "id": "ws_67890",
      "name": "Categorias"
    }
  ],
  "headers": [
    {
      "column": "A",
      "label": "Código do Produto"
    },
    {
      "column": "B",
      "label": "Nome"
    }
  ],
  "mapped_headers": {
    "A": "product_code",
    "B": "product_name",
    "C": "price"
  },
  "logs": [
    "Iniciando importação...",
    "200 linhas processadas com sucesso",
    "20 erros encontrados"
  ],
  "template": {
    "name": "Template Importação Padrão",
    "enabled": true,
    "created_at": "2025-08-20T10:00:00Z",
    "deleted": false,
    "deleted_at": null,
    "deleted_by": null
  },
  "from_template_id": "64f1d5f8e5d135790abcdef9"
}

Resposta de erro

400

Bad Request

Field	Type	Description
code	Number	Código da resposta http
kind	String	Tipo de mensagem
name	String	Nome da exceção lançada pela plataforma
title	String	Titulo do erro lançado pela plataforma
message	String	Mensagem indicando o probloma ocorrido
solution	String	Mensagem indicando uma possível solução para o problema