📋Lista de estabelecimentos

Consulta à Lista de Estabelecimentos

Para realizar uma consulta à lista de estabelecimentos comerciais, seja para pessoas físicas ou jurídicas, é necessário efetuar uma solicitação utilizando o método POST. Esta operação pode ser conduzida tanto com dados formatados em JSON quanto por meio de multipart/form-data, adaptando-se à natureza e estrutura dos dados que precisam ser enviados, o que pode incluir arquivos binários, se aplicável.

URL para Envio da Consulta:

https://api.zsystems.com.br/estabelecimentos/filhos

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

  • Content-Type: Deve ser especificado como multipart/form-data ou application/json, dependendo da forma como os dados serão submetidos.

  • Authorization: Necessita da inclusão de um 'Token API', acompanhado do prefixo Bearer, para assegurar a autenticação e autorização da solicitação.

Detalhes dos Parâmetros para Consulta:

Id

Tipo

Descrição

page

Número de páginas

limit

Define a quantidade de estabelecimentos a serem exibidos por página

omni

Campo utilizado como ferramenta de pesquisa

parentId

Identifica a qual estabelecimento está vinculado

Exemplo de requisição:

{
page: 0
limit: 2
filters: {"omni":"","parentId":null}
}

Exemplo de resultado :

{
  "success": true,
  "paginas": 174,
  "quantidade": 348,
  "estabelecimentos": [
    {
      "id": 9831,
      "tipo_estabelecimento_id": 1,
      "status_estabelecimento_id": 1,
      "endereco_id": 14811,
      "logo_id": 45779,
      "razao_social": "",
      "nome_fantasia": "095.219.250-00",
      "ativo": 0,
      "identificacao_fatura": "095.219.250-00",
      "data_nascimento": "1989-12-06T08:00:00.000Z",
      "mcc": 27,
      "created": "2020-05-22T15:14:01.000Z",
      "modified": "2020-08-14T21:00:16.000Z",
      "removed": null,
      "plano_venda_id": null,
      "tipo_estabelecimento": {
        "id": 1,
        "titulo": "Pessoa Física",
        "created": "2019-01-11T20:38:52.000Z",
        "modified": "2019-01-11T20:38:52.000Z",
        "removed": null
      },
      "status_estabelecimento": {
        "id": 1,
        "titulo": "Aguardando Aprovação",
        "created": "2019-07-22T20:24:19.000Z",
        "modified": "2019-07-22T20:24:19.000Z",
        "removed": null
      },
      "estabelecimentos_documentos": [
        {
          "id": 39389,
          "estabelecimento_id": 9831,
          "tipo_documento_id": 2,
          "arquivo_id": null,
          "documento": "09521925000",
          "created": "2020-05-22T15:14:01.000Z",
          "modified": "2020-05-22T15:14:01.000Z",
          "removed": null
        }
      ],
      "estabelecimentos_contatos": [
        {
          "id": 25154,
          "estabelecimento_id": 9831,
          "tipo_contato_id": 2,
          "nome": "095.219.250-00",
          "contato": "15615616165",
          "created": "2020-05-22T15:14:01.000Z",
          "modified": "2020-05-22T15:14:01.000Z",
          "removed": null
        },
        {
          "id": 25155,
          "estabelecimento_id": 9831,
          "tipo_contato_id": 3,
          "nome": "095.219.250-00",
          "contato": "095.219.250-00@gmail.com",
          "created": "2020-05-22T15:14:01.000Z",
          "modified": "2020-08-14T17:36:23.000Z",
          "removed": null
        }
      ],
      "plano_venda": null,
      "documento": "09521925000",
      "email": "095.219.250-00@gmail.com",
      "status": "Aguardando Aprovação",
      "repMaster": null,
      "plano": null
    },
    {
      "id": 10564,
      "tipo_estabelecimento_id": 1,
      "status_estabelecimento_id": 1,
      "endereco_id": 19943,
      "logo_id": null,
      "razao_social": "",
      "nome_fantasia": "099.991.360-36",
      "ativo": 0,
      "identificacao_fatura": "099.991.360-36",
      "data_nascimento": "1989-12-06T08:00:00.000Z",
      "mcc": 5,
      "created": "2020-06-09T21:13:49.000Z",
      "modified": "2020-06-10T00:20:08.000Z",
      "removed": null,
      "plano_venda_id": null,
      "tipo_estabelecimento": {
        "id": 1,
        "titulo": "Pessoa Física",
        "created": "2019-01-11T20:38:52.000Z",
        "modified": "2019-01-11T20:38:52.000Z",
        "removed": null
      },
      "status_estabelecimento": {
        "id": 1,
        "titulo": "Aguardando Aprovação",
        "created": "2019-07-22T20:24:19.000Z",
        "modified": "2019-07-22T20:24:19.000Z",
        "removed": null
      },
      "estabelecimentos_documentos": [
        {
          "id": 43202,
          "estabelecimento_id": 10564,
          "tipo_documento_id": 2,
          "arquivo_id": null,
          "documento": "09999136036",
          "created": "2020-06-09T21:13:49.000Z",
          "modified": "2020-06-09T21:13:49.000Z",
          "removed": null
        }
      ],
      "estabelecimentos_contatos": [
        {
          "id": 27645,
          "estabelecimento_id": 10564,
          "tipo_contato_id": 2,
          "nome": "099.991.360-36",
          "contato": "09999136036",
          "created": "2020-06-09T21:13:49.000Z",
          "modified": "2020-06-09T21:13:49.000Z",
          "removed": null
        },
        {
          "id": 27646,
          "estabelecimento_id": 10564,
          "tipo_contato_id": 3,
          "nome": "099.991.360-36",
          "contato": "099.991.360-36@gmail.com",
          "created": "2020-06-09T21:13:49.000Z",
          "modified": "2020-06-09T21:13:49.000Z",
          "removed": null
        }
      ],
      "plano_venda": null,
      "documento": "09999136036",
      "email": "099.991.360-36@gmail.com",
      "status": "Aguardando Aprovação",
      "repMaster": "Representante",
      "plano": null
    }
  ]
}

Last updated