🪪Consultar por documento

Consulta de Estabelecimento por Documento

Para realizar a busca de um estabelecimento utilizando um documento específico, é necessário efetuar uma solicitação através do método POST. Essa solicitação pode ser executada utilizando-se de dados em formato JSON ou por meio de multipart/form-data, a escolha depende das especificidades e do formato dos dados que serão enviados, podendo incluir, se necessário, arquivos em formato binário.

URL para Envio da Solicitação:

https://api.zsystems.com.br/estabelecimentos/por_documento/{documento}

Cabeçalhos Necessários para a Requisição:

  • Content-Type: Deverá ser definido como multipart/form-data ou application/json, adaptando-se ao método de envio selecionado.

  • Authorization: É necessário incluir um 'Token API', antecedido pelo termo Bearer, para garantir a autenticação e autorização da solicitação.

Parâmetros Necessários para a Consulta:

Id

Tipo

Descrição

documento

Número do documento do estabelecimento a ser consultado

Exemplo de requisição:

{   }

Exemplo de resultado:

{
  "success": true,
  "estabelecimento": {
    "id": 12696,
    "tipo_estabelecimento_id": 1,
    "status_estabelecimento_id": 1,
    "logo_id": null,
    "nome_fantasia": "Teste doc",
    "razao_social": "",
    "ativo": 0,
    "arquivo": null,
    "tipo_estabelecimento": {
      "id": 1,
      "titulo": "Pessoa Física"
    },
    "estabelecimentos_contatos": [
      {
        "id": 32804,
        "tipo_contato_id": 3,
        "contato": "ks.bonini@gmail.com"
      }
    ],
    "estabelecimentos_documentos": [
      {
        "id": 56413,
        "tipo_documento_id": 2,
        "documento": "35856667875"
      }
    ],
    "status_estabelecimento": {
      "id": 1,
      "titulo": "Aguardando Aprovação"
    }
  }
}

Last updated