Pular para o conteúdo
CotejarCotejarCotejar para desenvolvedores

Criar catálogo para estabelecimento existente

POST
/v1/catalogos
curl --request POST \
  --url https://api.cotejar.com.br/v1/catalogos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: pedido-exemplo-00000001' \
  --data '{ "estabelecimento_id": "0198d000-0000-7000-8000-000000000001", "nome": "Catálogo da filial", "id_externo": "filial-01" }'

Exige catalogo:gerenciar. Um catálogo ativo por estabelecimento. Não cria filial nem seleciona produtos.

Autorizações

Seção intitulada “Autorizações”

Parâmetros

Seção intitulada “Parâmetros”

Parâmetros de cabeçalho

Seção intitulada “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

Corpo da requisiçãoobrigatório

Seção intitulada “Corpo da requisiçãoobrigatório”
Tipo de mídiaapplication/json
object
nome
obrigatório
string
>= 1 caractere <= 120 caracteres
id_externo
string
aceita nulo >= 1 caractere <= 256 caracteres
estabelecimento_id
obrigatório
string formato: uuid
Exemplo
{
  "estabelecimento_id": "0198d000-0000-7000-8000-000000000001",
  "nome": "Catálogo da filial",
  "id_externo": "filial-01"
}

Respostas

Seção intitulada “Respostas”

201

Seção intitulada “201”

Response for status 201

Tipo de mídiaapplication/json
object
id
obrigatório

Exemplo sintético; substitua pelo UUID obtido na consulta do seu recurso.

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}$/
id_externo
obrigatório
Qualquer um de:
string
estabelecimento_id
obrigatório

Exemplo sintético; substitua pelo UUID obtido na consulta do seu recurso.

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}$/
cnpj_estabelecimento
obrigatório
string
nome
obrigatório
string
estado
obrigatório
string
Valores permitidos: ativo excluido
versao
obrigatório
Qualquer um de:
string formato: integer
0
produtos
obrigatório
Qualquer um de:
string formato: integer
0
criado_em
obrigatório
string formato: date-time
atualizado_em
obrigatório
string formato: date-time
excluido_em
obrigatório
Qualquer um de:
string formato: date-time
Exemplo
{
  "id": "0198d000-0000-7000-8000-000000000001",
  "estabelecimento_id": "0198d000-0000-7000-8000-000000000001",
  "estado": "ativo",
  "versao": 0,
  "produtos": 0
}

Cabeçalhos

Seção intitulada “Cabeçalhos”
ETag
string

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

Location
string

Caminho da consulta do recurso criado ou da operação aceita. Aceite não comprova conclusão.

400

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

401

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

403

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

404

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

408

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

409

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

412

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

413

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

415

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

422

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

428

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

429

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

503

Seção intitulada “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
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}