Fechar lotes e validar a prévia

POST

/v1/catalogos/ingestoes/{id}/validar

curl --request POST \
  --url https://api.cotejar.com.br/v1/catalogos/ingestoes/example/validar \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --data '{ "ultima_sequencia": 0 }'

• 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}$/

Parâmetros de cabeçalho

idempotency-key

obrigatório

string

>= 16 caracteres <= 200 caracteres /^\S+$/

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

ultima_sequencia

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

>= 1 <= 10000

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}$/

estado

obrigatório

Qualquer um de:

string

string

Valor permitido: precisa_revisao

string

string

Valor permitido: pronta_para_aplicar

hash_previa

obrigatório

Resumo SHA-256 em hexadecimal minúsculo.

string

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

totais

obrigatório

object

lotes

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

>= 1 <= 10000

produtos

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

>= 1 <= 50000

incompletos

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

<= 50000

atributos

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

guardas

obrigatório

Array<string>

Exemplo

{
  "estado": "precisa_revisao",
  "totais": {
    "lotes": 0,
    "produtos": 0,
    "incompletos": 0,
    "atributos": 0
  }
}

400

Resposta HTTP 400.

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"
  }
}

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"
  }
}

408

Resposta HTTP 408.

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"
  }
}

409

Resposta HTTP 409.

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"
  }
}

413

Resposta HTTP 413.

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"
  }
}

415

Resposta HTTP 415.

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"
  }
}