Skip to main content

Endpoint

POST https://api.tiny.com.br/api2/contato.obter.php
Serviço destinado a consultar um Contato específico dentro do sistema Olist.

Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação do contato na Olist
formatostringobrigatórioFormato do retorno. Use json

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 (1)
retorno.errosarray-condicionalLista de erros ocorridos (1)
retorno.erros[].errostring-condicionalDescrição do erro
retorno.contatoobject-condicionalDados completos do contato (2)
contato.idint-condicionalIdentificação do contato na Olist
contato.codigostring30condicionalCódigo do contato
contato.nomestring50condicionalNome ou razão social
contato.fantasiastring60condicionalNome fantasia
contato.tipo_pessoastring1condicionalF (Física), J (Jurídica), E (Estrangeiro)
contato.cpf_cnpjstring18condicionalCPF ou CNPJ
contato.iestring18condicionalInscrição estadual
contato.rgstring10condicionalRG
contato.imstring18condicionalInscrição municipal
contato.enderecostring50condicionalLogradouro
contato.numerostring10condicionalNúmero do endereço
contato.complementostring50condicionalComplemento
contato.bairrostring30condicionalBairro
contato.cepstring10condicionalCEP
contato.cidadestring30condicionalCidade
contato.ufstring30condicionalUF
contato.paisstring50condicionalPaís
contato.endereco_cobrancastring50condicionalEndereço de cobrança
contato.numero_cobrancastring10condicionalNúmero endereço cobrança
contato.complemento_cobrancastring50condicionalComplemento endereço cobrança
contato.bairro_cobrancastring30condicionalBairro de cobrança
contato.cep_cobrancastring10condicionalCEP de cobrança
contato.cidade_cobrancastring30condicionalCidade de cobrança
contato.uf_cobrancastring30condicionalUF de cobrança
contato.contatosstring100condicionalPessoas de contato
contato.fonestring40condicionalTelefone
contato.faxstring40condicionalFax
contato.celularstring40condicionalTelefone celular
contato.emailstring50condicionalE-mail
contato.email_nfestring50condicionalE-mail para NFe
contato.sitestring40condicionalWebsite
contato.crtstring1condicionalCódigo de regime tributário
contato.estadoCivilint-condicionalCódigo do estado civil
contato.profissaostring50condicionalProfissão
contato.sexostring10condicional”masculino” ou “feminino”
contato.data_nascimentostring10condicionalData de nascimento (dd/mm/aaaa)
contato.naturalidadestring40condicionalNaturalidade
contato.nome_paistring100condicionalNome do pai
contato.cpf_paistring18condicionalCPF do pai
contato.nome_maestring100condicionalNome da mãe
contato.cpf_maestring18condicionalCPF da mãe
contato.limite_creditodecimal-condicionalLimite de crédito
contato.situacaostring1condicionalA (Ativo), E (Excluído), I (Inativo), S (Sem movimento)
contato.obsstring200condicionalObservações gerais
contato.id_lista_precoint-condicionalID da lista de preço
contato.id_vendedorint-condicionalID do vendedor associado
contato.nome_vendedorstring50condicionalNome do vendedor associado
contato.data_criacaostring19condicionalData de criação (dd/mm/aaaa hh:mm:ss)
contato.data_atualizacaostring19obrigatórioData da última atualização (dd/mm/aaaa hh:mm:ss)
contato.tipos_contatoarray-condicionalLista de tipos do contato
tipos_contato[].tipostring-condicionalTipo do contato (Cliente, Fornecedor, etc.)
contato.pessoas_contatoarray-condicionalLista de pessoas de contato
(1) Retornado quando status = “Erro” (2) Retornado quando status = “OK”

Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/contato.obter.php \
  -d "token=SEU_TOKEN&formato=json&id=68790116"
$url = 'https://api.tiny.com.br/api2/contato.obter.php';
$token = 'SEU_TOKEN';
$id = 68790116;
$formato = 'json';
$data = "token=$token&id=$id&formato=$formato";

$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",
    "contato": {
      "id": "68790116",
      "codigo": "",
      "nome": "Contato Teste 3",
      "fantasia": "",
      "tipo_pessoa": "F",
      "cpf_cnpj": "814.134.138-38",
      "ie": "",
      "rg": "",
      "im": null,
      "endereco": "Rua Teste",
      "numero": "123",
      "complemento": "sala 2",
      "bairro": "Teste",
      "cep": "95.700-000",
      "cidade": "Bento Gonçalves",
      "uf": "RS",
      "pais": "",
      "endereco_cobranca": "",
      "numero_cobranca": "",
      "complemento_cobranca": "",
      "bairro_cobranca": "",
      "cep_cobranca": "",
      "cidade_cobranca": "",
      "uf_cobranca": " ",
      "contatos": "Pessoa Teste",
      "fone": "(54) 3055-3808",
      "fax": "",
      "celular": "",
      "email": "teste@teste.com.br",
      "email_nfe": "",
      "site": "",
      "crt": "0",
      "estadoCivil": "0",
      "profissao": "",
      "sexo": "",
      "data_nascimento": "",
      "naturalidade": "",
      "nome_pai": "",
      "cpf_pai": "",
      "nome_mae": "",
      "cpf_mae": "",
      "limite_credito": 0,
      "situacao": "A",
      "obs": "",
      "data_atualizacao": "21/03/2020 15:14:03",
      "tipos_contato": [
        {
          "tipo": "Cliente"
        },
        {
          "tipo": "Fornecedor"
        }
      ]
    }
  }
}

Erro - Token inválido

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

Erro - Contato não encontrado

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 32,
    "erros": [
      {
        "erro": "Contato não localizado"
      }
    ]
  }
}

Observações

  • O ID do contato pode ser obtido através do endpoint de pesquisa de contatos
  • Campos de pessoa física (estado civil, profissão, etc.) são retornados apenas para contatos do tipo “F”
  • Consulte a tabela de códigos de erro para interpretação dos erros