Consultar matriz e filiais da empresa

GET

/v1/estabelecimentos

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

• Produção

Inclui ativos e arquivados por padrão. catalogo_id identifica somente o catálogo ativo; é nulo quando não houver.

Autorizações

• bearerAuth

Parâmetros

Parâmetros de consulta

limite

Padrão 50; máximo 200 e orçamento de bytes por página.

string

/^(?:[1-9]|[1-9][0-9]|1[0-9]{2}|200)$/

apos_id

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

id_externo

Referência externa exata, incluindo espaços e maiúsculas.

string

>= 1 caractere <= 256 caracteres

estado

string

Valores permitidos: ativo arquivado

cnpj

CNPJ completo, sem pontuação; dígitos verificadores conferidos.

string

/^[A-Z0-9]{12}[0-9]{2}$/

Respostas

200

Response for status 200

Tipo de mídiaapplication/json

object

itens

obrigatório

Array<object>

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

proximo_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

Exemplo

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

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