Skip to main content

​
Endpoint

POST https://api.tiny.com.br/api2/contatos.pesquisa.php
Serviço destinado a fazer consulta de cadastros (clientes, fornecedores, vendedores, etc.)

​
Parâmetros

ParâmetroTipoTamanhoOcorrênciaDescrição
tokenstring-obrigatórioChave gerada para identificar sua empresa
pesquisastring-obrigatórioNome ou código (ou parte) do contato a consultar
formatostring-obrigatórioFormato do retorno. Use json
cpf_cnpjstring18opcionalCPF ou CNPJ do contato a consultar
idVendedorint15opcionalNúmero de identificação do vendedor na Olist
nomeVendedorstring-opcionalNome do vendedor na Olist (1)
situacaostring15opcionalSituação do contato: “Ativo” ou “Excluido” (2)
paginaint-opcionalNúmero da página (padrão: 1, 100 registros por página)
dataCriacaostring19opcionalData de criação no formato dd/mm/aaaa hh:mm:ss
dataMinimaAtualizacaostring19opcionalData mínima de atualização no formato dd/mm/aaaa hh:mm:ss
(1) O parâmetro nomeVendedor é desconsiderado se idVendedor for informado. Se o vendedor não for localizado, a consulta não retorna registros. (2) Sem situacao especificada, todas as situações são consideradas.

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retorno.status_processamentoint-obrigatórioCódigo de status do processamento
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-condicionalCódigo do erro conforme tabela da API (3)
retorno.errosarray-condicionalLista de erros ocorridos (3)
retorno.erros[].errostring-condicionalDescrição do erro
retorno.paginaint-obrigatórioNúmero da página retornada
retorno.numero_paginasint-obrigatórioQuantidade total de páginas
retorno.contatosarray-condicionalLista de contatos encontrados (4)
contatos[].contato.idint-condicionalIdentificação do contato na Olist
contatos[].contato.codigostring30condicionalCódigo do contato
contatos[].contato.nomestring50condicionalRazão social ou nome
contatos[].contato.fantasiastring60condicionalNome fantasia
contatos[].contato.tipo_pessoastring1condicionalF (Física), J (Jurídica), E (Estrangeiro)
contatos[].contato.cpf_cnpjstring18condicionalCPF ou CNPJ
contatos[].contato.enderecostring50condicionalLogradouro
contatos[].contato.numerostring10condicionalNúmero do endereço
contatos[].contato.complementostring50condicionalComplemento do endereço
contatos[].contato.bairrostring30condicionalBairro
contatos[].contato.cepstring10condicionalCEP
contatos[].contato.cidadestring30condicionalNome da cidade
contatos[].contato.ufstring30condicionalUnidade Federativa
contatos[].contato.emailstring50condicionalEndereço eletrônico
contatos[].contato.fonestring30condicionalTelefone
contatos[].contato.id_lista_precoint-condicionalIdentificação da lista de preço
contatos[].contato.id_vendedorint15condicionalIdentificação do vendedor
contatos[].contato.nome_vendedorstring15condicionalNome do vendedor
contatos[].contato.situacaostring15condicional”Ativo” ou “Excluido”
contatos[].contato.data_criacaostring19condicionalData de criação no formato dd/mm/aaaa hh:mm:ss
(3) Retornado quando status = “Erro” (4) Retornado quando status = “OK” e há registros encontrados

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/contatos.pesquisa.php \
  -d "token=SEU_TOKEN&formato=json&pesquisa=teste&pagina=1"

$url = 'https://api.tiny.com.br/api2/contatos.pesquisa.php';
$token = 'SEU_TOKEN';
$pesquisa = 'nome do contato';
$formato = 'json';
$data = "token=$token&pesquisa=$pesquisa&formato=$formato";

// Fazer requisição POST
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$resultado = json_decode($response, true);

​
Exemplo de retorno

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "pagina": "1",
    "numero_paginas": "1",
    "contatos": [
      {
        "contato": {
          "id": 46829055,
          "codigo": "123",
          "nome": "Contato Teste",
          "tipo_pessoa": "F",
          "fantasia": "Teste",
          "cpf_cnpj": "00000000000",
          "endereco": "Rua Teste",
          "numero": "123",
          "complemento": "sala 1",
          "bairro": "Centro",
          "cep": "95700-000",
          "cidade": "Bento Gonçalves",
          "uf": "RS",
          "email": "teste@teste.com.br",
          "situacao": "Ativo",
          "id_vendedor": "123456",
          "nome_vendedor": "Vendedor Teste",
          "data_criacao": "01/01/2020 10:00:00"
        }
      },
      {
        "contato": {
          "id": 46829059,
          "codigo": "125",
          "nome": "Contato Teste 2",
          "tipo_pessoa": "F",
          "fantasia": "Teste 2",
          "cpf_cnpj": "00000000001",
          "endereco": "Rua Teste",
          "numero": "123",
          "complemento": "sala 1",
          "bairro": "Centro",
          "cep": "95700-000",
          "cidade": "Bento Gonçalves",
          "uf": "RS",
          "email": "teste2@teste.com.br",
          "situacao": "Ativo",
          "id_vendedor": "",
          "nome_vendedor": "",
          "data_criacao": ""
        }
      }
    ]
  }
}

​
Erro - Token inválido

{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {
        "erro": "token invalido"
      }
    ]
  }
}

​
Erro - Nenhum resultado

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 20,
    "erros": [
      {
        "erro": "A Consulta não retornou registros"
      }
    ]
  }
}

​
Observações

  • Por padrão, 100 registros são listados por página
  • Use o parâmetro pagina para navegar entre os resultados
  • Consulte a tabela de cidades para valores válidos
  • Consulte a tabela de códigos de erro para interpretação dos erros