Trocar produtos selecionados ou vigiar todos

PATCH

/v1/empresa/vigilancia

curl --request PATCH \
  --url https://api.cotejar.com.br/v1/empresa/vigilancia \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: pedido-exemplo-00000001' \
  --header 'if-match: example' \
  --data '{ "modo": "selecao", "adicionar": [ "example" ], "remover": [ "example" ] }'

• Produção

Exige vigilancia:gerenciar, Idempotency-Key e If-Match. Até 200 inclusões/retiradas por pedido. Modo todos exige capacidade para todo o catálogo. Não executa análise nem altera cobrança; excesso recusa a troca inteira.

Autorizações

• bearerAuth

Parâmetros

Parâmetros de cabeçalho

idempotency-key

obrigatório

Gere uma chave por pedido e preserve-a somente nas repetições desse mesmo pedido.

string

>= 16 caracteres <= 128 caracteres /^[A-Za-z0-9._:-]+$/

Exemplo

pedido-exemplo-00000001

if-match

obrigatório

ETag completo da consulta do recurso, incluindo aspas.

string

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

modo

obrigatório

string

Valores permitidos: selecao todos

adicionar

Array<string>

<= 200 itens

remover

Array<string>

<= 200 itens

Respostas

200

Response for status 200

Tipo de mídiaapplication/json

object

cadastrados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

selecionados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

elegiveis

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

vagas

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

cobertura

obrigatório

string

Valores permitidos: indisponivel sem_selecao parcial integral capacidade_excedida

exige_selecao

obrigatório

boolean

modo

obrigatório

string

Valores permitidos: selecao todos

versao

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

capacidade

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

direito_ativo

obrigatório

boolean

Exemplo

{
  "cadastrados": 0,
  "selecionados": 0,
  "elegiveis": 0,
  "vagas": 0,
  "cobertura": "indisponivel",
  "modo": "selecao",
  "versao": 0,
  "capacidade": 0
}

Cabeçalhos

ETag

string

Versão opaca do recurso, incluindo aspas. Preserve o valor completo ao enviar If-Match.

400

Response for status 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

Response for status 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

Response for status 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

Response for status 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

Response for status 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

Response for status 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"
  }
}

412

Response for status 412

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

Response for status 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

Response for status 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

Response for status 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"
  }
}

428

Response for status 428

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

Response for status 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

Response for status 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"
  }
}