Skip to main content

​
Endpoint

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

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json)
pesquisastringopcionalCampo de pesquisa (busca por nome do cliente, assunto ou ação) (1)
estagioClientestringopcionalEstágio do cliente no CRM (1)
estagioAssuntostringopcionalEstágio do assunto no CRM (1)
situacaoAssuntostringopcionalSituação do assunto no CRM (1)
filtroPorstringopcionalOpção de filtro por período (1)
dataInicialstringopcionalData inicial no formato dd/mm/yyyy
dataFinalstringopcionalData final no formato dd/mm/yyyy
idVendedorstringopcionalNúmero de identificação do vendedor (1)
nomeVendedorstringopcionalNome do vendedor na Olist (1)
paginaintopcionalNúmero da página
(1) Ao menos um dos parâmetros (pesquisa, estagioCliente, estagioAssunto, situacaoAssunto, filtroPor, idVendedor, nomeVendedor) deve ser informado.

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-condicionalConforme tabela “Códigos de erro”
retorno.erros[]list-condicionalLista dos erros encontrados [0..n]
retorno.erros[].errostring-condicionalDescrição do erro
retorno.paginaint-obrigatórioNúmero da página retornada
retorno.numero_paginasint-obrigatórioNúmero total de páginas
retorno.assuntos[]list-condicionalLista de resultados da pesquisa
retorno.assuntos[].assunto.idint-condicionalID do assunto na Olist
retorno.assuntos[].assunto.clientestring50condicionalNome do cliente
retorno.assuntos[].assunto.estagio_clientestring50condicionalEstágio do cliente no CRM
retorno.assuntos[].assunto.texto_assuntostring-condicionalTexto do assunto
retorno.assuntos[].assunto.proxima_acaostring-condicionalPróxima ação do assunto
retorno.assuntos[].assunto.tipo_data_acaostring1condicionalTipo de data da ação
retorno.assuntos[].assunto.data_acaodate20condicionalData da ação (dd/mm/yyyy) (2)
retorno.assuntos[].assunto.estagio_assuntostring1condicionalEstágio do assunto
retorno.assuntos[].assunto.situacao_assuntostring1condicionalSituação do assunto
(2) Campo data_acao contém valor apenas quando tipo_data_acao é “D” (formato dd/mm/yyyy)

​
Observações

  • O parâmetro nomeVendedor é desconsiderado se idVendedor for informado
  • Se o vendedor não for localizado, a consulta não retorna registros
  • Caso filtroPor não contenha valores “C” ou “P”, os parâmetros dataInicial e dataFinal serão ignorados
  • Por padrão, são listados 100 registros por página
  • Se pagina não for informado, o valor padrão é 1

​
Exemplo de chamada

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

​
Exemplos de retorno

​
Erro - Token inválido

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

​
Erro - Sem resultados

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

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "pagina": "1",
    "numero_paginas": "1",
    "assuntos": [
      {
        "assunto": {
          "id": 123456,
          "cliente": "Cliente Teste",
          "estagio_cliente": "C",
          "texto_assunto": "Teste",
          "proxima_acao": "Ligar",
          "tipo_data_acao": "D",
          "data_acao": "10/01/2015",
          "estagio_assunto": "2",
          "situacao_assunto": "A"
        }
      },
      {
        "assunto": {
          "id": 123456,
          "cliente": "Cliente Teste",
          "estagio_cliente": "C",
          "texto_assunto": "Teste",
          "proxima_acao": "Ligar",
          "tipo_data_acao": "Q",
          "data_acao": "",
          "estagio_assunto": "2",
          "situacao_assunto": "A"
        }
      }
    ]
  }
}