> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.erp.olist.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pesquisar Vendedores

> Serviço destinado a fazer consulta de vendedores.

## Endpoint

```
POST https://api.tiny.com.br/api2/vendedores.pesquisa.php
```

## Parâmetros

| Parâmetro | Tipo   | Ocorrência  | Descrição                                          |
| --------- | ------ | ----------- | -------------------------------------------------- |
| token     | string | obrigatório | Identificador da empresa                           |
| pesquisa  | string | obrigatório | Nome ou código do vendedor                         |
| formato   | string | obrigatório | Formato de retorno (json)                          |
| pagina    | int    | opcional    | Número da página (padrão: 1, 100 registros/página) |

## Retorno

| Campo                                       | Tipo   | Ocorrência  | Descrição                  |
| ------------------------------------------- | ------ | ----------- | -------------------------- |
| retorno.status\_processamento               | int    | obrigatório | Indicador de processamento |
| retorno.status                              | string | obrigatório | "OK" ou "Erro"             |
| retorno.pagina                              | int    | obrigatório | Número da página           |
| retorno.numero\_paginas                     | int    | obrigatório | Total de páginas           |
| retorno.vendedores\[].vendedor.id           | int    | condicional | ID do vendedor             |
| retorno.vendedores\[].vendedor.codigo       | string | condicional | Código do vendedor         |
| retorno.vendedores\[].vendedor.nome         | string | condicional | Nome do vendedor           |
| retorno.vendedores\[].vendedor.fantasia     | string | condicional | Nome fantasia              |
| retorno.vendedores\[].vendedor.tipo\_pessoa | string | condicional | Tipo de pessoa             |
| retorno.vendedores\[].vendedor.cpf\_cnpj    | string | condicional | CPF/CNPJ                   |
| retorno.vendedores\[].vendedor.email        | string | condicional | E-mail                     |
| retorno.vendedores\[].vendedor.endereco     | string | condicional | Endereço                   |
| retorno.vendedores\[].vendedor.numero       | string | condicional | Número                     |
| retorno.vendedores\[].vendedor.complemento  | string | condicional | Complemento                |
| retorno.vendedores\[].vendedor.bairro       | string | condicional | Bairro                     |
| retorno.vendedores\[].vendedor.cep          | string | condicional | CEP                        |
| retorno.vendedores\[].vendedor.cidade       | string | condicional | Cidade                     |
| retorno.vendedores\[].vendedor.uf           | string | condicional | UF                         |
| retorno.vendedores\[].vendedor.situacao     | string | condicional | Situação                   |

## Exemplo de chamada

```php theme={null}
$url = 'https://api.tiny.com.br/api2/vendedores.pesquisa.php';
$data = "token=API_KEY&pesquisa=xxxxx&formato=JSON";
```

## Exemplos de retorno

### Sucesso

```json theme={null}
{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "pagina": "1",
    "numero_paginas": "1",
    "vendedores": [
      {
        "vendedor": {
          "id": 46829055,
          "codigo": 123,
          "nome": "Vendedor Teste",
          "cpf_cnpj": "00000000000",
          "cidade": "Bento Gonçalves",
          "uf": "RS",
          "situacao": "Ativo"
        }
      }
    ]
  }
}
```

### Erro

```json theme={null}
{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [{"erro": "token invalido"}]
  }
}
```