Home > API & Documentação > Lista de Produtos

Lista de Produtos

Nesta página

Busca produtos por uma ou mais palavras-chaves ou ID da categoria.

Como funciona?

  1. Aplicação efetua uma requisição informando o ID da categoria final, palavras-chaves ou ambos.
  2. Serviço recebe a requisição e busca a lista de produtos no Buscapé.
  3. Serviço retorna a lista de produtos no formato XML para aplicação.

Funcionamento da lista de produtos

Formatos de URL aceitos

Busca por ID da categoria.

http://sandbox.buscape.com/service/findProductList/<application_id>/?categoryId=categoryId

Busca por palavra-chave.

http://sandbox.buscape.com/service/findProductList/<application_id>/?keyword=keyword

Busca por ID da categoria e palavra-chave.

http://sandbox.buscape.com/service/findProductList/<application_id>/?categoryId=categoryId&keyword=keyword

Parâmetros

Parâmetros Tipo Descrição
categoryId Int ID da categoria
keyword String Palavras-chaves

Consulte todas as categorias usadas para efetuar requisições na API do Buscapé.

Filtros

Parâmetros Tipo Descrição
results Int Número de resultados
page Int Número da página
priceMin Float Preço Mínimo
priceMax Float Preço Máximo
sort String Ordenação
  • price/dprice: Ordenação por preço
  • rate/drate: Ordenação por avaliação de usuários
  • seller/dseller: Ordenação por loja
  • installment/dinstallment: Ordenação por preço da parcela
  • numberofinstallments/dnumberofinstallments: Ordenação por número de parcelas
  • trustedStore: Ordenação por selo de empresa reconhecida no Buscapé
medal String Filtra ofertas e produtos a partir de uma determinada medalha do eBit
  • all
  • diamond
  • gold
  • silver
  • bronze

Busca por coordenadas

Clique e veja como é feita a busca por coordenadas.

Formatos de resposta

O formato padrão de resposta é XML.

Caso queira utilizar o formato de resposta JSON, adicione o parâmetro format=json

Exemplos de requisição

http://sandbox.buscape.com/service/findProductList/<application_id>/?categoryId=77
http://sandbox.buscape.com/service/findProductList/<application_id>/?keyword=celular
http://sandbox.buscape.com/service/findProductList/<application_id>/?categoryId=77&keyword=motorola

XSD Document (XML SCHEMAS)

http://developer.buscape.com/xsd/buscape.xsd

Campos de resposta

Result

Campos Tipo Descrição
details ResultDetails Detalhes da requisição
category CategoryType Dados da categoria atual
totalResultsAvailable Int Total de itens disponíveis
totalResultsReturned Int Total de itens retornados
totalPages Int Total de páginas
page Int Número da página atual
match String Retorna o tipo de pesquisa por palavra(s)-chave(s)
  • all: Pesquisa perfeita, toda(s) palavra(s)-chave(s) encontrada(s)
  • any: Pesquisa parcial, alguma(s) palavra(s)-chave(s) encontrada(s)
  • none: Pesquisa não encontrada

ResultDetails

Campos Tipo Descrição
applicationID String ID da aplicação
date String Data/Hora da requisição com timezone
elapsedTime Long Tempo de execução da requisição em milisegundos
status String Status da resposta
code Int Código da resposta
message String Mensagem da resposta

CategoryType

Campos Tipo Descrição
id Int ID da categoria
parentCategoryId Int ID da categoria pai
isFinal Boolean TRUE caso seja uma categoria final
name String Nome da categoria
links LinksType Lista de links
  • category: URL da categoria no Buscapé
  • XML: URL do serviço de busca de ofertas ou produtos pelo ID da categoria
thumbnail ThumbnailType Imagem da categoria

ProductType

Campos Tipo Descrição
id Int ID do produto
categoryId Int ID da categoria
totalSellers Int Total de empresas com ofertas para este produto
productName String Nome do produto
priceMin String Preço Mínimo
priceMax String Preço Máximo
links LinkType Links do produto
  • XML: URL do serviço de busca de ofertas pelo ID do produto
  • product: URL do produto no Buscapé
  • specification: URL da especificação do produto no Buscapé
thumbnail ThumbnailType Imagem do produto
rating RatingType Avaliação do produto
specification SpecificationType Detalhes do produto

LinksType

Campos Tipo Descrição
link LinkType Link

LinkType

Campos Tipo Descrição
type String Tipo do Link:
url String Endereço do link

ThumbnailType

Campos Tipo Descrição
url String Endereço imagem

RatingType

Campos Tipo Descrição
userAverageRating UserRatingType Avaliação dos usuários

UserRatingType

Campos Tipo Descrição
numComments Int Número de comentários
rating String Média das notas dos usuários
link LinkType Link da avaliação
  • XML: URL do serviço de avalição dos usuário pelo ID do produto
specification SpecificationType Avaliação por itens do produto

SpecificationType

Campos Tipo Descrição
item ItemListType Lista de itens da especificação
links LinkType Links
label String Descrição da especificação

ItemListType

Campos Tipo Descrição
label String Nome do Item
value String Valor do item

Exemplo de resposta

Buscar lista de produtos da categoria 77 (celular).

http://sandbox.buscape.com/service/findProductList/<application_id>/?categoryId=77
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <Result xmlns="urn:buscape" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" match="all" page="1" totalPages="39" totalResultsReturned="16" totalResultsAvailable="619" xsi:schemaLocation="http://developer.buscape.com/xsd/buscape.xsd">
                    <details>
                        <applicationID>564771466d477a4458664d3d</applicationID>
                        <applicationVersion>1.0.0.0</applicationVersion>
                        <applicationPath>http://bws-apps.buscape.com/mobile/update</applicationPath>
                        <date>2010-10-19T10:16:50.529-03:00</date>
                        <elapsedTime>12</elapsedTime>
                        <status>success</status>
                        <code>0</code>
                        <message>success</message>
                    </details>
                    <category hasOffer="false" isFinal="true" parentCategoryId="6420" id="77">
                        <thumbnail url="http://imagem2.buscape.com.br/bp5/categorias/77.jpg"/>
                        <links>
                            <link type="category" url="http://compare.buscape.com.br/celular-e-smartphone.html?mdsrc=9262544"/>
                            <link type="xml" url="http://sandbox.buscape.com/service/findProductList/564771466d477a4458664d3d/?categoryId=77&sourceId=9262544"/>
                        </links>
                        <name>Celular e Smartphone</name>
                    </category>
                    <product id="235052" categoryId="77" totalSellers="2" fullDescription="false">
                        <productName>LG GT350 Cookie Messenger GSM Desbloqueado</productName>
                        <productShortName>LG GT350 Cookie Messenger Desbloqueado</productShortName>
                        <currency abbreviation="BRL"/>
                        <priceMin>399.00</priceMin>
                        <priceMax>399.00</priceMax>
                        <links>
                            <link type="product" url="http://compare.buscape.com.br/lg-gt350-cookie-messenger-gsm-desbloqueado.html?mdsrc=9262544"/>
                            <link type="specification" url="http://compare.buscape.com.br/prod_ficha?idu=235052"/>
                            <link type="xml" url="http://sandbox.buscape.com/service/findOfferList/564771466d477a4458664d3d/?productId=235052&sourceId=9262544"/>
                        </links>
                        <thumbnail url="http://imagem2.buscape.com.br/thumbs/ensopado/77/190x190_235052_1.jpg"/>
                        <rating>
                            <userAverageRating>
                                <numComments>36</numComments>
                                <rating>8.4</rating>
                                <links>
                                    <link type="xml" url="http://sandbox.buscape.com/service/viewUserRatings/564771466d477a4458664d3d/?productId=235052&sourceId=9262544"/>
                                </links>
                            </userAverageRating>
                        </rating>
                        <specification>
                            <links>
                                <link type="xml" url="http://sandbox.buscape.com/service/viewProductDetails/564771466d477a4458664d3d/?productId=235052&sourceId=9262544"/>
                            </links>
                            <item label="Câmera">
                                <value>3.15 MP</value>
                            </item>
                            <item label="Funções Extras">
                                <value>Grava Video</value>
                                <value>Gravador de Voz</value>
                                <value>Java</value>
                                <value>MP3 Player</value>
                                <value>Rádio</value>
                                <value>Reproduz Video</value>
                                <value>Viva Voz</value>
                            </item>
                            <item label="Slots de Expansão">
                                <value>MicroSD</value>
                            </item>
                            <item label="Tipos de Conexão">
                                <value>Bluetooth</value>
                                <value>EDGE</value>
                                <value>GPRS</value>
                                <value>Micro-USB</value>
                                <value>WAP</value>
                            </item>
                        </specification>
                    </product>
                    <product id="251579" categoryId="77" totalSellers="18" fullDescription="false">
                        <productName>Samsung B7300 Omnia Lite GSM Desbloqueado</productName>
                        <productShortName>Samsung B7300 Omnia Lite Desbloqueado</productShortName>
                        <currency abbreviation="BRL"/>
                        <priceMin>799.99</priceMin>
                        <priceMax>1459.90</priceMax>
                        <links>
                            <link type="product" url="http://compare.buscape.com.br/samsung-b7300-omnia-lite-gsm-desbloqueado.html?mdsrc=9262544"/>
                            <link type="specification" url="http://compare.buscape.com.br/prod_ficha?idu=251579"/>
                            <link type="xml" url="http://sandbox.buscape.com/service/findOfferList/564771466d477a4458664d3d/?productId=251579&sourceId=9262544"/>
                        </links>
                        <thumbnail url="http://imagem2.buscape.com.br/thumbs/ensopado/77/190x190_251579_1.jpg"/>
                        <rating>
                            <userAverageRating>
                                <numComments>3</numComments>
                                <rating>10.0</rating>
                                <links>
                                    <link type="xml" url="http://sandbox.buscape.com/service/viewUserRatings/564771466d477a4458664d3d/?productId=251579&sourceId=9262544"/>
                                </links>
                            </userAverageRating>
                        </rating>
                        <specification>
                            <links>
                                <link type="xml" url="http://sandbox.buscape.com/service/viewProductDetails/564771466d477a4458664d3d/?productId=251579&sourceId=9262544"/>
                            </links>
                            <item label="Câmera">
                                <value>3.15 MP</value>
                            </item>
                            <item label="Funções Extras">
                                <value>Grava Video</value>
                                <value>Gravador de Voz</value>
                                <value>Java</value>
                                <value>Media Player</value>
                                <value>MP3 Player</value>
                                <value>Rádio</value>
                                <value>Reproduz Video</value>
                                <value>Videoconferência</value>
                                <value>Visualizador de Documentos</value>
                                <value>Viva Voz</value>
                            </item>
                            <item label="3G">
                                <value>Sim</value>
                            </item>
                            <item label="Slots de Expansão">
                                <value>MicroSD</value>
                            </item>
                            <item label="Tipos de Conexão">
                                <value>Bluetooth</value>
                                <value>EDGE</value>
                                <value>GPRS</value>
                                <value>Micro-USB</value>
                                <value>Wi-Fi</value>
                            </item>
                        </specification>
                    </product>
                </Result>

Erros

Conforme visualizado em ResultDetails, a resposta pode retornar códigos de erros.

Informações importantes

O parâmetro categoryId deve ser sempre o ID de uma categoria final.

Algumas categorias finais não possuem produtos, apenas ofertas. Neste caso a resposta do XML terá sua lista de produtos vazia. Para não perder o vínculo da consulta, o serviço disponibilizará a URL pronta para consulta das ofertas, informando o mesmo ID da categoria.

Aviso aos desenvolvedores

Caso o seu aplicativo seja executado em um servidor, é necessário informar aos webservices do Buscapé o IP do usuário que acessa o seu servidor. O IP do usuário deve ser informado através do parâmetro clientIp. Caso o seu aplicativo seja executado diretamente na máquina do usuário final, como aplicações mobile ou javascript, não é necessário informar o IP do usuário. Se, por exemplo, o IP do usuário que acessou o seu servidor seja 200.200.200.200, a chamada deveria ser feita assim:

http://sandbox.buscape.com/service/findProductList/<application_id>/?categoryId=categoryId&keyword=keyword&clientIp=200.200.200.200

Caso o aplicativo, sistema ou site utilize cache, o mesmo deverá ser de, no máximo, uma hora para produtos e categorias. No caso de ofertas, como o clique é validado através do IP do usuário e pela hora do clique, o cache não pode existir pois, se dois IP's acessam o mesmo link de oferta, o clique é invalidado.

Topo