Consultar identidade e versão de um estabelecimento

GET

/v1/estabelecimentos/{id}

curl --request GET \
  --url https://api.cotejar.com.br/v1/estabelecimentos/0198d000-0000-7000-8000-000000000001 \
  --header 'Authorization: Bearer <token>'

• Produção

Autorizações

• bearerAuth

Parâmetros

Parâmetros de caminho

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

Exemplo

0198d000-0000-7000-8000-000000000001

Respostas

200

Response for status 200

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

cnpj

obrigatório

string

nome

obrigatório

string

estado

obrigatório

string

Valores permitidos: ativo arquivado

versao

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

catalogo_id

obrigatório

Qualquer um de:

string

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

null

null

id_externo

obrigatório

Qualquer um de:

string

string

null

null

Exemplo

{
  "id": "0198d000-0000-7000-8000-000000000001",
  "estado": "ativo",
  "versao": 0,
  "catalogo_id": "0198d000-0000-7000-8000-000000000001"
}

Cabeçalhos

ETag

string

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

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

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

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