Consultar ingestão e prévia

GET

/v1/catalogos/ingestoes/{id}

curl --request GET \
  --url https://api.cotejar.com.br/v1/catalogos/ingestoes/example \
  --header 'Authorization: Bearer <token>'

• Produção

Autorizações

• bearerAuth

Parâmetros

Parâmetros de caminho

id

obrigatório

Identificador UUID da ingestão.

string

/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/

Respostas

200

Resposta HTTP 200.

Tipo de mídiaapplication/json

object

ingestao_id

obrigatório

Identificador UUID da ingestão.

string

/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/

catalogo_id

Identificador UUID da ingestão.

string

/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/

versao_catalogo

Qualquer um de:

string

string formato: integer

0

integer

integer

>= 1

operacao

Qualquer um de:

string

string

Valor permitido: mesclar

string

string

Valor permitido: substituicao_catalogo

canal

obrigatório

string

estado

obrigatório

Qualquer um de:

string

string

Valor permitido: recebida

string

string

Valor permitido: recebendo_lotes

string

string

Valor permitido: validando

string

string

Valor permitido: extraindo

string

string

Valor permitido: classificando

string

string

Valor permitido: normalizada

string

string

Valor permitido: precisa_revisao

string

string

Valor permitido: pronta_para_aplicar

string

string

Valor permitido: aplicando

string

string

Valor permitido: aplicada

string

string

Valor permitido: cancelada

string

string

Valor permitido: recusada_formato

string

string

Valor permitido: recusada_conteudo

string

string

Valor permitido: falhou_extracao

string

string

Valor permitido: falhou_modelo

string

string

Valor permitido: falhou_validacao

string

string

Valor permitido: falhou_aplicacao

hash_previa

obrigatório

Qualquer um de:

string

Resumo SHA-256 em hexadecimal minúsculo.

string

/^[0-9a-f]{64}$/

null

null

progresso_aplicacao

object

fase

obrigatório

Qualquer um de:

string

string

Valor permitido: preparando

string

string

Valor permitido: conferindo

string

string

Valor permitido: concluida

string

string

Valor permitido: interrompida

itens_preparados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

itens_previstos

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

codigo_falha

obrigatório

Qualquer um de:

string

string

null

null

classificacao

obrigatório

Qualquer um de:

string

string

null

null

totais

obrigatório

object

linhas

obrigatório

Qualquer um de:

unknown

Qualquer um de:

string

string formato: integer

0

integer

integer

null

null

produtos

obrigatório

Qualquer um de:

unknown

Qualquer um de:

string

string formato: integer

0

integer

integer

null

null

incompletos

obrigatório

Qualquer um de:

unknown

Qualquer um de:

string

string formato: integer

0

integer

integer

null

null

recusados

obrigatório

Qualquer um de:

unknown

Qualquer um de:

string

string formato: integer

0

integer

integer

null

null

atributos

obrigatório

Qualquer um de:

unknown

Qualquer um de:

string

string formato: integer

0

integer

integer

null

null

guardas

obrigatório

Array<string>

itens

obrigatório

Array<object>

object

id_temporario

obrigatório

string

codigo_cliente

obrigatório

Qualquer um de:

string

string

null

null

descricao_cliente

obrigatório

Qualquer um de:

string

string

null

null

ncm

obrigatório

Qualquer um de:

string

string

null

null

posicao

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

>= 1

erros

obrigatório

Array<string>

criado_em

obrigatório

string formato: date-time

atualizado_em

obrigatório

string formato: date-time

aplicada_em

obrigatório

Qualquer um de:

string

string formato: date-time

null

null

Exemplo

{
  "versao_catalogo": 0,
  "operacao": "mesclar",
  "estado": "recebida",
  "progresso_aplicacao": {
    "fase": "preparando",
    "itens_preparados": 0,
    "itens_previstos": 0
  },
  "totais": {
    "linhas": 0,
    "produtos": 0,
    "incompletos": 0,
    "recusados": 0,
    "atributos": 0
  },
  "itens": [
    {
      "posicao": 0
    }
  ]
}

401

Resposta HTTP 401.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

403

Resposta HTTP 403.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

404

Resposta HTTP 404.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

422

Resposta HTTP 422.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

429

Resposta HTTP 429.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

503

Resposta HTTP 503.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}