Integração de imóveis

VimoFeed 1.1

Publique e atualize seu catálogo na Vimo por qualquer URL HTTPS. O endereço é livre; o conteúdo do XML deve seguir este contrato.

Baixar XML de exemplo Ver exemplo completo

A URL não possui um formato fixo.

Ela pode conter caminhos e tokens próprios do CRM. Deve responder por HTTPS, permanecer acessível para a Vimo e retornar um XML válido de até 20 MB.

Contrato

Estrutura e campos

O documento começa com <VimoFeed version="1.1">. Cada imóvel usa um externalId único e permanente.

Campo	Obrigatório para publicar	Descrição
`Listing@externalId`	Sim	Identificador único e permanente do anúncio no sistema de origem.
`ReferenceCode`	Sim	Código comercial exibido pela imobiliária. Pode se repetir quando o mesmo imóvel possui anúncios distintos, como venda e locação.
`Purpose`	Sim	Finalidade do anúncio.
`PropertyType`	Sim	Tipo do imóvel.
`Status`	Sim	Situação atual no sistema de origem.
`AdType`	Sim no 1.1	Posição comercial do anúncio: normal, destaque ou destaque na Home.
`Title`	Sim	Título com pelo menos 20 caracteres.
`Description`	Sim	Descrição com pelo menos 100 caracteres.
`Price`	Sim	Valor decimal; moeda padrão BRL.
`Location`	Sim	Estado, cidade e bairro são obrigatórios.
`Details`	Conforme o tipo	Áreas, quartos, suítes, banheiros e vagas.
`Features`	Não	Diferenciais identificados por slug.
`Contact/Name`	Sim	Nome do responsável pelo atendimento.
`Contact/Phone`	Sim	Telefone principal para contato. Não é presumido como WhatsApp.
`Contact/WhatsApp`	Não	Destino exclusivo do botão de WhatsApp, com DDD ou código do país.
`Contact/LogoURL`	Não	URL HTTPS pública do logo da imobiliária anunciante.
`Media/Image`	Sim	No mínimo três URLs públicas de imagens.

Identidade técnica e código comercial são diferentes.

A Vimo atualiza cada anúncio exclusivamente por externalId. Se o mesmo imóvel estiver à venda e para locação, os dois anúncios podem compartilhar o mesmo ReferenceCode, mas precisam usar externalId diferentes e permanentes, por exemplo 6444-V e 6444-L.

Posicionamento comercial

Tipos de anúncio

Cada imóvel do VimoFeed 1.1 deve informar AdType. O valor controla a prioridade do imóvel no portal e deve ser atualizado pelo CRM sempre que a imobiliária alterar a posição contratada.

`normal`

Publicação comum, respeitando a ordenação padrão do catálogo.

`featured`

Destaque com prioridade sobre anúncios normais nos resultados de busca.

`home_featured`

Destaque prioritário na Home e também nos resultados de busca.

<Status>available</Status>
<AdType>home_featured</AdType>

Plano Vimo TIMOB: até 5 anúncios featured e até 3 anúncios home_featured simultaneamente. Se o XML solicitar uma posição acima da cota disponível, o imóvel continua publicado como normal. Feeds legados 1.0 sem AdType também são tratados como normal.

Identidade e atendimento

WhatsApp e logo do anunciante

O telefone comum e o WhatsApp são campos diferentes. A Vimo só exibe o botão “Chamar no WhatsApp” quando Contact/WhatsApp possui um número válido. O logo aparece junto ao nome da imobiliária na área de contato do anúncio.

<Contact>
    <Name>Juliana Lima</Name>
    <Phone>(11) 3333-4444</Phone>
    <WhatsApp>5511999999999</WhatsApp>
    <LogoURL>https://imobiliaria.com.br/logo.png</LogoURL>
</Contact>

Em WhatsApp, recomendamos o formato internacional somente com números: 55 + DDD + número. Em LogoURL, use preferencialmente PNG ou WebP com fundo transparente. Feeds 1.0 continuam aceitos, mas esses novos dados de identidade pertencem ao contrato 1.1.

Texto formatado

Formatação da descrição

Para preservar parágrafos, listas, negrito e quebras de linha, recomendamos enviar Description format="html" com o conteúdo dentro de CDATA. A CDATA protege os caracteres do HTML durante a leitura do XML.

<Description format="html"><![CDATA[
<p>Primeiro parágrafo da descrição.</p>
<p><strong>Destaques do imóvel:</strong></p>
<ul>
    <li>Varanda</li>
    <li>Duas vagas de garagem</li>
</ul>
<p>Entre em contato para agendar uma visita.</p>
]]></Description>

Tags aceitas: p, br, strong, b, em, i, ul, ol e li. Atributos, scripts, estilos e outras tags são removidos pela Vimo. Texto simples também é aceito, desde que as quebras de linha reais sejam mantidas no XML.

Enumerações

Valores aceitos

Envie os códigos exatamente como aparecem abaixo, em letras minúsculas.

Finalidades

saleVenda
rentLocação
seasonalTemporada

Situações

availableDisponível para publicação
reservedReservado
soldVendido
rentedAlugado
inactiveInativo

Tipos de imóvel

apartmentApartamento
houseCasa
condominium_houseCasa em condomínio
townhouseSobrado
studioStudio
kitnetKitnet
loftLoft
flatFlat
penthouseCobertura
duplexDuplex
triplexTriplex
landTerreno
commercial_roomSala comercial
officeEscritório
storeLoja
warehouseGalpão
commercial_buildingPrédio comercial
rural_propertyImóvel rural
small_farmChácara
ranchSítio
farmFazenda

Catálogo

Diferenciais reconhecidos

Use o valor da coluna “slug”. Valores desconhecidos não impedem a importação: serão preservados nas informações adicionais do anúncio.

Lazer

piscinaPiscina
churrasqueiraChurrasqueira
area-gourmetÁrea gourmet
espaco-verde-parqueEspaço verde / parque
quadra-de-esportesQuadra de esportes
quadra-de-tenisQuadra de tênis
sala-de-jogosSala de jogos
sala-de-massagemSala de massagem
saunaSauna

Condomínio

elevadorElevador
portaria-24hPortaria 24h
playgroundPlayground

Estrutura

mobiliadoMobiliado
ar-condicionadoAr-condicionado
sacadaSacada
area-de-servicoÁrea de serviço
varandaVaranda
lareiraLareira
garagem-estacionamentoGaragem de estacionamento
lavanderiaLavanderia
aquecimento-a-gasAquecimento a gás
home-officeHome office
armazemArmazém
portao-automaticoPortão automático
box-blindexBox blindex
armarios-planejadosArmários planejados
cozinha-americanaCozinha americana
ediculaEdícula

Condições

aceita-petsAceita pets

Localização

perto-transporte-publicoPerto de transporte público
perto-shopping-centersPerto de shopping centers
perto-estradas-avenidasPerto de estradas / avenidas
perto-das-escolasPerto das escolas
perto-de-hospitaisPerto de hospitais
proximo-a-praiaPróximo à praia
lado-praiaLado praia
lado-morroLado morro
rua-asfaltadaRua asfaltada

Vista

vista-para-o-marVista para o mar
vista-montanhaVista para a montanha

Tecnologia

casa-inteligenteCasa inteligente
televisao-a-caboTelevisão a cabo
conexao-com-internetConexão com a internet

Externo

gramadoGramado
area-de-jardimÁrea de jardim
cascalhoCascalho
patio-cercadoPátio cercado
corredor-lateralCorredor lateral
quintalQuintal

Segurança

acesso-controladoAcesso controlado
sistema-de-alarmeSistema de alarme

Terreno

terreno-muradoTerreno murado
agua-encanadaÁgua encanada
energia-eletricaEnergia elétrica
esgotoEsgoto

Comercial

pe-direito-altoPé-direito alto
energia-trifasicaEnergia trifásica
docaDoca
entrada-para-caminhaoEntrada para caminhão

Sincronização

Como as atualizações funcionam

Novo código

Um novo externalId cria o imóvel.

Código existente

Os dados e as imagens do anúncio são atualizados.

Código ausente

Pode ser desativado se essa opção estiver habilitada e a leitura terminar sem erros.

Dados incompletos

O imóvel é salvo como rascunho, sem ser descartado.

Exemplo

Arquivo completo

Baixar arquivo

<?xml version="1.0" encoding="UTF-8"?>
<VimoFeed version="1.1">
    <Listings>
        <Listing externalId="ABC-123">
            <ReferenceCode>AP-1024</ReferenceCode>
            <Purpose>sale</Purpose>
            <PropertyType>apartment</PropertyType>
            <Status>available</Status>
            <AdType>home_featured</AdType>
            <Title>Apartamento com três quartos no Centro</Title>
            <Description format="html"><![CDATA[
                <p>Apartamento bem localizado, com ambientes iluminados e excelente estrutura condominial.</p>
                <p><strong>Destaques do imóvel:</strong></p>
                <ul>
                    <li>Varanda com boa iluminação natural</li>
                    <li>Duas vagas de garagem</li>
                    <li>Área de lazer completa</li>
                </ul>
                <p>Entre em contato para agendar uma visita.</p>
            ]]></Description>
            <Price currency="BRL">750000.00</Price>
            <Location>
                <PostalCode>01000-000</PostalCode>
                <State>SP</State>
                <City>São Paulo</City>
                <Neighborhood>Centro</Neighborhood>
                <Address>Rua das Flores</Address>
                <Number>100</Number>
            </Location>
            <Details>
                <PrivateArea unit="m2">110.00</PrivateArea>
                <TotalArea unit="m2">140.00</TotalArea>
                <LandArea unit="m2"></LandArea>
                <Bedrooms>3</Bedrooms>
                <Suites>1</Suites>
                <Bathrooms>2</Bathrooms>
                <ParkingSpaces>2</ParkingSpaces>
                <CondoFee>650.00</CondoFee>
                <PropertyTax>180.00</PropertyTax>
            </Details>
            <Features>
                <Feature slug="piscina">Piscina</Feature>
                <Feature slug="elevador">Elevador</Feature>
                <Additional>Sol da manhã e ventilação natural.</Additional>
            </Features>
            <Contact>
                <Name>Juliana Lima</Name>
                <Phone>(11) 3333-4444</Phone>
                <WhatsApp>5511999999999</WhatsApp>
                <LogoURL>https://imobiliaria.com.br/logo.png</LogoURL>
            </Contact>
            <Media>
                <Image main="true">https://imobiliaria.com.br/fotos/abc-123-1.jpg</Image>
                <Image>https://imobiliaria.com.br/fotos/abc-123-2.jpg</Image>
                <Image>https://imobiliaria.com.br/fotos/abc-123-3.jpg</Image>
            </Media>
        </Listing>
    </Listings>
</VimoFeed>