Obter Documentos de Importação

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

Realiza a leitura de documentos de 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
import_id	ObjectId	ID do import.	required	false
type	enum	Tipo do documento. requer uma das keys: 'product' = 'product', 'service' = 'service', 'kit' = 'kit', 'sku' = 'sku'	required	false
status	enum	Status do documento. requer uma das keys: "validating" = "validating", "validated" = "validated", "importing" = "importing", "imported" = "imported"	not required	false
automation_status	enum	Status da automação. requer uma das keys: "pending" = "pending", "automating" = "automating", "automated" = "automated"	not required	false
row	array	Linhas do documento.	required	false
errors	object	Erros do documento.	not required	false
data +	date	Data de criação.	not required	false
filters	object	Filtros do documento. requer uma key: attributes: object - not required	not required	false

Exemplo em JSON

{
   "page": 1,
    "skip": 0,
    "limit": 10,
    "sort": {
        "campo": "asc"
    },
    "pages": 5,
    "total": 50,
    "next": true,
    "previous": "2",
    "nextUrl": "https://api.exemplo.com?page=2",
    "previousUrl": false,
    "filters": {
        "status": "ativo"
    },
    "data": [{
        "import_id": "64f1b3d4e5d987654321cdef",
        "code": "PRD-001",
        "type": "PHYSICAL", 
        "status": "validated",
        "automation_status": "PENDING",
        "row": 12,
        "errors": {
        "message": "Invalid category reference",
        "field": "categories"
    },
    "data": {
        "name": "Tênis Esportivo",
        "description": "Tênis confortável para corrida",
        "enabled": true,
        "code": "TENIS123",
        "brand_id": "64f1c4e6e5d567890abcd111",
        "categories": "64f1c4e6e5d567890abcd222",
        "image": "https://exemplo.com/imagem.jpg",
        "attributes": {
        "color": "Azul",
        "size": "42",
        "material": "Tecido"
        },
        "attributes_options_snapshot": {
        "color": ["Azul", "Preto", "Branco"],
        "size": ["40", "41", "42", "43"]
        }
    },
    "filters": {
        "attributes": {
        "gender": "masculino",
        "season": "verão"
        }
  }
    }]
}

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