Skip to main content

​
Endpoint

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

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação do assunto do CRM
formatostringobrigatórioFormato do retorno (json)

​
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” (1)
retorno.erros[]list-condicionalLista dos erros encontrados [0..n] (1)
retorno.erros[].errostring-condicionalDescrição do erro (1)
retorno.assuntoobject-condicionalDados do assunto (2)
retorno.assunto.idint-condicionalNúmero de identificação do assunto
retorno.assunto.texto_assuntostring-condicionalTexto do assunto do CRM
retorno.assunto.proxima_acaostring-condicionalPróxima ação do assunto
retorno.assunto.estagio_assuntostring1condicionalCódigo do estágio do assunto (3)
retorno.assunto.situacao_assuntostring1condicionalConforme tabela de Situações do Assunto
retorno.assunto.status_negociacaostring1condicionalConforme tabela de Status de Negociação
retorno.assunto.clienteobject-condicionalDados do cliente
retorno.assunto.cliente.id_clienteint-condicionalIdentificação do cliente
retorno.assunto.cliente.codigostring30condicionalCódigo do cliente
retorno.assunto.cliente.nomestring30condicionalNome do cliente
retorno.assunto.cliente.nome_fantasiastring60condicionalNome fantasia
retorno.assunto.cliente.tipo_pessoastring1condicionalF/J/E (Física/Jurídica/Estrangeiro)
retorno.assunto.cliente.cpf_cnpjstring18condicionalCPF ou CNPJ do cliente
retorno.assunto.cliente.iestring18condicionalInscrição estadual
retorno.assunto.cliente.rgstring10condicionalRG do cliente
retorno.assunto.cliente.enderecostring50condicionalEndereço
retorno.assunto.cliente.numerostring10condicionalNúmero do endereço
retorno.assunto.cliente.complementostring50condicionalComplemento do endereço
retorno.assunto.cliente.bairrostring30condicionalBairro
retorno.assunto.cliente.cepstring10condicionalCEP
retorno.assunto.cliente.cidadestring30condicionalConforme Tabela de Cidades
retorno.assunto.cliente.ufstring30condicionalUF do cliente
retorno.assunto.cliente.paisstring50condicionalConforme Tabela de Países
retorno.assunto.cliente.fonestring40condicionalTelefone
retorno.assunto.cliente.estagio_clientestring50condicionalCódigo do estágio do cliente
retorno.assunto.acoes[]list-condicionalLista de ações do assunto
retorno.assunto.acoes[].acao.id_acaoint-condicionalIdentificação da ação
retorno.assunto.acoes[].acao.descricao_acaostring-condicionalDescrição da ação
retorno.assunto.acoes[].acao.tipo_data_acaostring1condicionalConforme tabela de Tipos de data
retorno.assunto.acoes[].acao.data_acaodate20condicionalData da ação (dd/mm/yyyy) (4)
retorno.assunto.acoes[].acao.situacao_acaostring-condicionalConforme tabela de Situações da ação
(1) Erros e código de erro aparecem apenas quando status for “Erro”
(2) Dados do assunto aparecem apenas quando status for “OK”
(3) Códigos de estágio são configuráveis conforme conta Olist (obter via “Lista de estágios de assuntos do CRM”)
(4) Campo data_acao terá valor apenas se tipo_data_acao = “D”, formato: dd/mm/yyyy

​
Exemplo de chamada

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

​
Exemplos de retorno

​
Erro - Token inválido

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

​
Erro - Consulta 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",
    "assunto": {
      "id": 123456,
      "cliente": {
        "id_cliente": "1234",
        "codigo": "1235",
        "nome": "Contato Teste 2",
        "nome_fantasia": "Fantasia Contato Teste 2",
        "tipo_pessoa": "F",
        "cpf_cnpj": "22755777850",
        "ie": "",
        "rg": "1234567890",
        "endereco": "Rua Teste",
        "numero": "123",
        "complemento": "sala 2",
        "bairro": "Teste",
        "cep": "95700000",
        "cidade": "Bento Gonçalves",
        "uf": "RS",
        "fone": "5412345678",
        "estagio_cliente": "C"
      },
      "texto_assunto": "Teste",
      "proxima_acao": "ligar",
      "estagio_assunto": "2",
      "situacao_assunto": "A",
      "status_negociacao": "0",
      "acoes": [
        {
          "acao": {
            "id_acao": "15555",
            "descricao_acao": "Realizar contato",
            "tipo_data_acao": "Q",
            "situacao_acao": "1"
          }
        },
        {
          "acao": {
            "id_acao": "15556",
            "descricao_acao": "Ligar",
            "tipo_data_acao": "D",
            "data_acao": "2015/01/01",
            "situacao_acao": "0"
          }
        }
      ]
    }
  }
}