API de Oferta V1 - Deprecated

Recursos:

Esta versão da API de Ofertas será descontinuada em 15/09/2019.

Saiba mais sobre os novos recursos da API v2.

Busca de Ofertas

GET /service/v2/topOffers/{program}/{app-token}/BR/

A aba Top Ofertas retorna os produtos mais procurados no Buscapé/Lomadee, o que é possível graças à nossa tecnologia exclusiva de curadoria.

URL

Produção	http://bws.buscape.com.br
Sandbox	http://sandbox.buscape.com

HEADERS

Gerar URL Modelo Básico

App-Token

SourceId

Program

REQUEST

PARÂMETROS

Nome	Tipo		Descrição
app-token	PathVariable	Obrigatório	Token de autenticação. Para gera-lo é necessário criar um cadastro e uma aplicação.
categoryId	QueryString	Opcional	ID da categoria
results	QueryString	Opcional	Número de resultados
page	QueryString	Opcional	Número da página
format	QueryString	Opcional	json\|xml
sellerId	QueryString	Opcional	ID da Loja
sourceId	QueryString	Obrigatório	ID que identifica sua origem Lomadee.
program	PathVariable	Obrigatório	O parâmetro "program" indica o modo de comissionamento que você deseja utilizar. Para comissionamento e ofertas válidas para DPC utilize o valor "buscape" e para comissionamento e ofertas válidas para CPA utilize o valor "lomadee".

RESPONSE

Status Code: 200

Retorna informações das ofertas mais buscadas do buscapé.

BODY

Ver Modelo | Ver Atributos

GET /service/findOfferList/{program}/{app-token}/BR/

Aqui você encontra listas com informações detalhadas de produtos existentes no Buscapé e na Lomadee. Apenas a oferta possui o link do tipo "offer", que deve ser utilizado para redirecionar usuários de sua aplicação para o site do anunciante. (necessário).

URL

Produção	http://bws.buscape.com.br
Sandbox	http://sandbox.buscape.com

HEADERS

Gerar URL Modelo Básico

App-Token

SourceId

Program

REQUEST

PARÂMETROS

Nome	Tipo		Descrição
app-token	PathVariable	Obrigatório	Token de autenticação. Para gera-lo é necessário criar um cadastro e uma aplicação.
keyword	QueryString	Opcional	Palavra-Chave
categoryId	QueryString	Opcional	ID da categoria
productId	QueryString	Opcional	ID do produto
barcode	QueryString	Opcional	Código de barras
latitude	QueryString	Opcional	Latitude do local onde deseja buscar ofertas (ex. -23.508313)
longitude	QueryString	Opcional	Longitude do local onde deseja buscar ofertas (ex. -46.64247)
radius	QueryString	Opcional	Raio de abrangência do local onde deseja buscar ofertas em metros (ex 5000)
results	QueryString	Opcional	Número de resultados por página
page	QueryString	Opcional	Número da página
priceMin	QueryString	Opcional	Preço mínimo das ofertas
priceMax	QueryString	Opcional	Preço máximo das ofertas
sort	QueryString	Opcional	price\|dprice (Ordenação por preço) - rate\|drate (Ordenação por avaliação)
medal	QueryString	Opcional	all\|diamond\|gold\|silver\|bronze (Filtro de ofertas por medalha Ebit da loja)
format	QueryString	Opcional	json\|xml
sourceId	QueryString	Obrigatório	ID que identifica sua origem Lomadee.
offerId	QueryString	Opcional	ID da oferta no Buscapé
allowedSellers	QueryString	Opcional	Lista de IDs de lojas separados por , (ex. 65,79)
program	PathVariable	Obrigatório	O parâmetro "program" indica o modo de comissionamento que você deseja utilizar. Para comissionamento e ofertas válidas para DPC utilize o valor "buscape" e para comissionamento e ofertas válidas para CPA utilize o valor "lomadee".

RESPONSE

Status Code: 200

Busca de ofertas de acordo com os filtros enviados.

BODY

Ver Modelo | Ver Atributos

Nome	Descrição
offer[]	Lista de ofertas.
offer[]>offer>seller>thumbnail>url	URL do logo da loja.
offer[]>offer>seller>rating>ebitrating>ratingnew	Nome da medalha E-bit da loja.
offer[]>offer>seller>rating>ebitrating>numcomments	Número de comentários no E-bit.
offer[]>offer>seller>rating>useraveragerating>rating	Nota média dos usuários sobre a loja. (Formato 0.0)
offer[]>offer>seller>rating>useraveragerating>numcomments	Número de comentários dos usuários sobre a loja.
offer[]>offer>seller>links[]	Links da loja.
offer[]>offer>seller>links[]>link>type	Tipo de link da loja. Manter "seller".
offer[]>offer>seller>links[]>link>url	Link da loja.
offer[]>offer>seller>sellername	Nome da loja.
offer[]>offer>seller>id	ID da loja.
offer[]>offer>seller>contacts[]	Lista de contatos da loja.
offer[]>offer>seller>contacts[]>contact>label	Tipo de contato. (Ex: Atendimento)
offer[]>offer>seller>contacts[]>contact>value	Valor do contato. (Ex: 4001-1010)
offer[]>offer>thumbnail>url	URL da imagem da oferta.
offer[]>offer>offername	Nome da oferta.
offer[]>offer>price>value	Preço da oferta. (Formato 0.0)
offer[]>offer>links[]	Lista de links da oferta.
offer[]>offer>links[]>link>type	Tipo do link. Manter "offer".
offer[]>offer>links[]>link>url	URL da oferta.
offer[]>offer>offershortname	Nome encurtado da oferta.
offer[]>offer>id	ID da oferta.
offer[]>offer>categoryId	ID da categoria da oferta.
totalresultssellers	Total de lojas encontradas para essa busca.
details	Detalhes da requisição.
totalpages	Total de páginas.
page	Página atual.
totalresultsavailable	Total de ofertas disponíveis para essa busca.
totalresultsreturned	Total de ofertas retornadas nessa páginas.
category	Dados da categoria.

Busca de Produtos

GET /service/v2/topProducts/{program}/{app-token}/BR/

Este são os melhores produtos do Buscapé e Lomadee para você, processados e filtrados por uma tecnologia exclusiva nossa.

URL

Produção	http://bws.buscape.com.br
Sandbox	http://sandbox.buscape.com

HEADERS

Gerar URL Modelo Básico

App-Token

SourceId

Program

REQUEST

PARÂMETROS

Nome	Tipo		Descrição
app-token	PathVariable	Obrigatório	Token de autenticação. Para gera-lo é necessário criar um cadastro e uma aplicação.
categoryId	QueryString	Opcional	ID da categoria
results	QueryString	Opcional	Número de resultados
page	QueryString	Opcional	Número da página
format	QueryString	Opcional	Formato de resposta: json ou xml
sourceId	QueryString	Obrigatório	ID que identifica sua origem Lomadee.
program	PathVariable	Obrigatório	O parâmetro "program" indica o modo de comissionamento que você deseja utilizar. Para comissionamento e ofertas válidas para DPC utilize o valor "buscape" e para comissionamento e ofertas válidas para CPA utilize o valor "lomadee".

RESPONSE

Status Code: 200

Retorna as informações dos produtos mais buscados do Buscapé

BODY

Ver Modelo | Ver Atributos

Nome	Descrição
product[]	Lista de produtos.
product[]>productName	Nome do produto.
product[]>productShortName	Nome encurtado do produto.
product[]>categoryName	Nome da categoria do produto.
product[]>links>link[]	Lista de links dos tipos descritos.
product[]>links>link[]>url	URL do link de acordo com o tipo de conteúdo do atributo "type".
product[]>product>links>link[]>type	Existem três casos: "product" Tipo do link quando a URL aponta para a página do produto no site Buscapé. "specification" Tipo do link quando a URL aponta para a página de especificação técnica no site Buscapé. "xml" Tipo do link quando a URL aponta para a lista de ofertas deste produto.
product[]>product>thumbnail>formats[]	Lista de formatos de thumbnail possíveis. (Ex: 200x200)
product[]>product>thumbnail>formats[]>width	Largura da imagem.
product[]>product>thumbnail>formats[]>url	URL da imagem.
product[]>product>thumbnail>formats[]>height	Altura da imagem.
product[]>product>thumbnail>width	Largura padrão.
product[]>product>thumbnail>url	URL da imagem padrão.
product[]>product>thumbnail>height	Altura padrão.
product[]>product>rating>useraveragerating>rating	Nota da média.
product[]>product>rating>useraveragerating>links[]	Lista de links para API de avaliação de usuários.
product[]>product>rating>useraveragerating>links[]>link>type	Tipo da API. Manter "XML".
product[]>product>rating>useraveragerating>links[]>link>url	URL da API.
product[]>product>rating>useraveragerating>numComments	Número de comentários.
product[]>product>specification>item[]	Lista da especificação de cada item.
product[]>product>specification>item[]>item>label	Nome da especificação.
product[]>product>specification>item[]>item>value[]	Lista de valores.
product[]>product>specification>links[]	Links para API de especificação técnica.
product[]>product>specification>links[]>type	TIpo da API. Manter "XML".
product[]>product>specification>links[]>url	URL da API.
product[]>product>totalSellers	Total de lojas que vendem esse produto.
product[]>categoryId	ID da categoria.
product[]>id	ID do produto.
product[]>product>numOffers	Total de ofertas para esse produto.
totalresultsavailable	Total de ofertas disponíveis para essa busca.
totalresultsreturned	Total de ofertas retornadas nessa páginas.
totalpages	Total de páginas.
page	Página atual.
details	Detalhes da requisição.

GET /service/findProductList/{program}/{app-token}/BR/

Aqui você encontra listas com informações detalhadas de produtos existentes no Buscapé e na Lomadee. É possível aplicar filtros para que se adequem a sua divulgação.

URL

Produção	http://bws.buscape.com.br
Sandbox	http://sandbox.buscape.com

HEADERS

Gerar URL Modelo Básico

App-Token

SourceId

Program

REQUEST

PARÂMETROS

Nome	Tipo		Descrição
app-token	PathVariable	Obrigatório	Token de autenticação. Para gera-lo é necessário criar um cadastro e uma aplicação.
categoryId	QueryString	Opcional	ID da categoria
keyword	QueryString	Opcional	Palavra-chave
results	QueryString	Opcional	Número de resultados
page	QueryString	Opcional	Número da página
priceMin	QueryString	Opcional	Preço mínimo (Ex. 100.0)
priceMax	QueryString	Opcional	Preço máximo (Ex. 100.0)
sort	QueryString	Opcional	price\|dprice (Ordenação por preço) - rate\|drate (Ordenação por avaliação)
format	QueryString	Opcional	Formato de resposta: json ou xml
specId	QueryString	Opcional	Entenda como funciona o SpecId neste tutorial: http://developer.lomadee.com.br/
sourceId	QueryString	Opcional	ID que identifica sua origem Lomadee.
program	PathVariable	Obrigatório	O parâmetro "program" indica o modo de comissionamento que você deseja utilizar. Para comissionamento e ofertas válidas para DPC utilize o valor "buscape" e para comissionamento e ofertas válidas para CPA utilize o valor "lomadee".

RESPONSE

Status Code: 200

Retorna informações sobre os produtos de acordo com os filtros aplicados.

BODY

Ver Modelo | Ver Atributos

{
    "product": [
        {
            "product": {
                "thumbnail": {
                    "formats": [
                        {
                            "formats": {
                                "width": 0,
                                "url": "",
                                "height": 0
                            }
                        }
                    ],
                    "width": 0,
                    "url": "",
                    "height": 0
                },
                "pricemax": "",
                "rating": {
                    "useraveragerating": {
                        "rating": "0.0",
                        "links": [
                            {
                                "link": {
                                    "type": "xml",
                                    "url": ""
                                }
                            }
                        ],
                        "numcomments": 0
                    }
                },
                "specification": {
                    "item": [
                        {
                            "item": {
                                "label": "",
                                "value": [
                                    ""
                                ]
                            }
                        }
                    ],
                    "links": [
                        {
                            "link": {
                                "type": "",
                                "url": ""
                            }
                        }
                    ]
                },
                "productshortname": "",
                "pricemin": "0.0",
                "numoffers": 0,
                "totalsellers": 0,
                "productname": "",
                "links": [
                    {
                        "link": {
                            "type": "",
                            "url": ""
                        }
                    }
                ],
                "id": 0,
                "categoryid": 0
            }
        }
    ],
    "match": "",
    "details": {},
    "totalpages": 0,
    "page": 0,
    "totalresultsreturned": 0,
    "totalresultsavailable": 0,
    "category": {}
}

Nome	Descrição
product[]	Lista de produtos.
product[]>product>thumbnail>formats[]	Lista de formatos de thumbnail possíveis. (Ex: 200x200)
product[]>product>thumbnail>formats[]>width	Largura da imagem.
product[]>product>thumbnail>formats[]>url	URL da imagem.
product[]>product>thumbnail>formats[]>height	Altura da imagem.
product[]>product>thumbnail>width	Largura padrão.
product[]>product>thumbnail>url	URL da imagem padrão.
product[]>product>thumbnail>height	Altura padrão.
product[]>product>pricemax	Preço máximo do produto.
product[]>product>rating>useraveragerating>rating	Nota da média.
product[]>product>rating>useraveragerating>links[]	Lista de links para API de avaliação de usuários.
product[]>product>rating>useraveragerating>links[]>link>type	Tipo da API. Manter "XML".
product[]>product>rating>useraveragerating>links[]>link>url	URL da API.
product[]>product>rating>useraveragerating>numComments	Número de comentários.
product[]>product>specification>item[]	Lista da especificação de cada item.
product[]>product>specification>item[]>item>label	Nome da especificação.
product[]>product>specification>item[]>item>value[]	Lista de valores.
product[]>product>specification>links[]	Links para API de especificação técnica.
product[]>product>specification>links[]>type	TIpo da API. Manter "XML".
product[]>product>specification>links[]>url	URL da API.
product[]>product>productShortName	Nome encurtado do produto.
product[]>product>priceMin	Preço mínimo (Formato "0.00").
product[]>product>numOffers	Número de ofertas.
product[]>product>totalSellers	Número de lojas.
product[]>product>productName	Nome completo do produto.
product[]>product>links[]	Links do produto.
product[]>product>links[]>link>type	Existem três casos: "product" Tipo do link quando a URL aponta para a página do produto no site Buscapé. "specification" Tipo do link quando a URL aponta para a página de especificação técnica no site Buscapé. "xml" Tipo do link quando a URL aponta para a lista de ofertas deste produto.
product[]>product>links[]>link>url	URL que aponta para a página do produto, página da especificação, ou lista de ofertas do produto, de acordo com o atributo "type".
product[]>product>id	ID do produto.
product[]>product>categoryId	ID da categoria do produto.
match	Nível de acerto da busca realizada.
details	Detalhes da requisição.
totalpages	Total de páginas encontradas.
page	Página atual.
totalResultsReturned	Total de resultados retornados.
totalResultsAvailable	Total de resultados disponíveis.
category	Dados da categoria desse produto.

Busca de Categorias

GET /service/v2/topCategories/{program}/{app-token}/BR/

Aqui você encontra as melhores categorias do Buscapé e Lomadee para divulgar em seus canais de conteúdo.

URL

Produção	http://bws.buscape.com.br
Sandbox	http://sandbox.buscape.com

HEADERS

Gerar URL Modelo Básico

App-Token

SourceId

Program

REQUEST

PARÂMETROS

Nome	Tipo		Descrição
token	PathVariable	Obrigatório	Token de autenticação. Para gera-lo é necessário criar um cadastro e uma aplicação.
results	QueryString	Opcional	Número de resultados desejados
page	QueryString	Opcional	Número da página desejada
format	QueryString	Opcional	Formato de resposta: json ou xml (default)
sourceId	QueryString	Obrigatório	ID que identifica sua origem Lomadee.
program	PathVariable	Obrigatório	O parâmetro "program" indica o modo de comissionamento que você deseja utilizar. Para comissionamento e ofertas válidas para DPC utilize o valor "buscape" e para comissionamento e ofertas válidas para CPA utilize o valor "lomadee".

RESPONSE

Status Code: 200

Retorna informações das categorias mais buscadas do buscapé.

BODY

Ver Modelo | Ver Atributos

Nome	Descrição
subcategory>thumbnail>url	URL da imagem da categoria.
subcategory>links>link[]	Lista de links da categoria.
subcategory>links>link[]>type	Existem três casos: "list_product" Tipo do link que aponta para a API da lista de produtos da categoria. "list_offer" Tipo do link que aponta para a API da lista de ofertas da categoria. "buscape" Tipo do link que aponta para a página da categoria no site Buscapé.
subcategory>links>link[]>url	URL para a página de acordo com o conteúdo do atributo type.
subcategory>name	Nome da categoria.
subcategory>parentCategoryId	ID da categoria pai.
subcategory>id	ID da categoria.
subcategory>isFinal	Flag que identifica se a categoria é final.
subcategory>hasOffer	Flag que identifica se a categoria possui ofertas.
subcategory>hasProduct	Flag que identifica se a categoria possui produtos.
totalResultsAvailable	Total de resultados disponíveis.
totalResultsReturned	Total de resultados retornados nesta página.
totalPages	Total de páginas disponíveis.
page	Página atual.
details	Detalhes da requisição.

GET /service/findCategoryList/{program}/{app-token}/BR/

Essa lista possui informações detalhadas de categorias de produtos existentes no Buscapé e na Lomadee. O sistema de categorias funciona como uma árvore, possuindo várias categorias filhas, sendo que a mãe de todas é uma categoria 0.

URL

Produção	http://bws.buscape.com.br
Sandbox	http://sandbox.buscape.com

HEADERS

Gerar URL Modelo Básico

App-Token

SourceId

Program

REQUEST

PARÂMETROS

Nome	Tipo		Descrição
app-token	PathVariable	Obrigatório	Token de autenticação. Para gera-lo é necessário criar um cadastro e uma aplicação.
categoryId	QueryString	Opcional	ID da categoria
keyword	QueryString	Opcional	Palavra-chave
results	QueryString	Opcional	Número de resultados
page	QueryString	Opcional	Número da página
format	QueryString	Opcional	Formato de resposta: json ou xml
sourceId	QueryString	Obrigatório	ID que identifica sua origem Lomadee.
program	PathVariable	Obrigatório	O parâmetro "program" indica o modo de comissionamento que você deseja utilizar. Para comissionamento e ofertas válidas para DPC utilize o valor "buscape" e para comissionamento e ofertas válidas para CPA utilize o valor "lomadee".

RESPONSE

Status Code: 200

Busca informações das categorias de acordo com filtros utilizados.

BODY

Ver Modelo | Ver Atributos

Nome	Descrição
details	Detalhes da requisição.
totalResultsAvailable	Total de resultados disponíveis.
subcategory[]>subcategory>thumbnail>url	URL da imagem da categoria.
subcategory[]>subcategory>parentCategoryId	ID da categoria pai.
subcategory[]>subcategory>isFinal	Flag que identifica se a categoria é final.
subcategory[]>subcategory>name	Nome da categoria.
subcategory[]>subcategory>links[]	Lista de links da categoria.
subcategory[]>subcategory>links[]>link>type	Existem dois casos: "category" Tipo do link que aponta para a página da categoria no site Buscapé. "xml" Tipo do link quando a URL aponta para a lista de produtos dessa categoria na API.
subcategory[]>subcategory>links[]>link>url	URL para a página de acordo com o conteúdo do atributo type.
subcategory[]>subcategory>id	ID da categoria.
totalResultsReturned	Total de resultados retornados nesta página.

Busca de Lojas

GET /service/sellers/lomadee/{app-token}/BR

A API Lista de Lojas retorna todas as lojas ativas na Lomadee de uma forma que facilite o processo de divulgação.

URL

Produção	http://bws.buscape.com.br
Sandbox	http://sandbox.buscape.com

HEADERS

Gerar URL Modelo Básico

App-Token

SourceId

REQUEST

PARÂMETROS

Nome	Tipo		Descrição
app-token	PathVariable	Obrigatório	Token de autenticação. Para gera-lo é necessário criar um cadastro e uma aplicação.
format	QueryString	Opcional	json\|xml
sourceId	QueryString	Obrigatório	ID que identifica sua origem Lomadee.

RESPONSE

Status Code: 200

Retorna a lista de lojas ativas na Lomadee. Apenas no formato JSON.

BODY

Ver Modelo | Ver Atributos

Nome	Descrição
totalSellers	Total de lojas.
seller[]	Lista de lojas.
seller[]>id	ID da loja.
seller[]>name	Nome da loja.
seller[]>thumbnail	URL do logo da loja.
seller[]>links[]	Links da loja.
seller[]>links[]>type	Existem um caso: "link_to_offerlist" Tipo do link que aponta para a API de ofertas dessa loja.
seller[]>links[]>url	URL para a página de acordo com o conteúdo do atributo type.
details	Detalhes da requisição.

GET /service/viewSellerDetails/{app-token}/

É possível visualizar informações detalhadas de um anunciante da Lomadee.

URL

Produção	http://bws.buscape.com.br
Sandbox	http://sandbox.buscape.com

HEADERS

Gerar URL Modelo Básico

App-Token

SourceId

REQUEST

PARÂMETROS

Nome	Tipo		Descrição
app-token	PathVariable	Obrigatório	Token de autenticação. Para gera-lo é necessário criar um cadastro e uma aplicação.
sellerId	QueryString	Opcional	ID da loja
format	QueryString	Opcional	json\|xml
sourceId	QueryString	Obrigatório	ID que identifica sua origem Lomadee.

RESPONSE

Status Code: 200

Retorna informações sobre os produtos de acordo com os filtros aplicados.

BODY

Ver Modelo | Ver Atributos

Nome	Descrição
seller>addresses[]	Lista de endereços da loja.
seller>addresses[]>address>fone	Telefone da loja.
seller>addresses[]>address>postalArea	Rua da loja.
seller>addresses[]>address>city	Cidade da loja.
seller>addresses[]>address>postalCode	CEP da loja.
seller>addresses[]>address>name	Nome da sede da loja.
seller>addresses[]>address>state	Estado da loja.
seller>addresses[]>address>complement	Complemento da loja.
seller>addresses[]>address>map>latitude	Localização (latitude) da loja.
seller>addresses[]>address>map>longitude	Localização (longitude) da loja.
seller>rating>ebitrating>ratingnew	Nome da medalha E-bit da loja.
seller>rating>ebitrating>numcomments	Número de comentários no E-bit.
seller>rating>useraveragerating>rating	Nota média dos usuários sobre a loja (Utilize o formato "0.0").
seller>rating>useraveragerating>numcomments	Número de comentários dos usuários sobre a loja.
seller>links[]	Lista de links da loja.
seller>links[]>type	Tipo do link. Manter "seller".
seller>links[]>url	URL da loja.
seller>sellerName	Nome da loja.
seller>id	ID da loja.
seller>contacts[]	Lista de contatos da loja.
seller>contacts[]>contact>label	Nome do contato. (Ex: SAC)
seller>contacts[]>contact>value	Valor do contato. (Ex: 11 4004-1616)
details	Detalhes da requisição.

Nome	Descrição
offer[]	Lista de ofertas.
offer[]>offerName	Nome da oferta.
offer[]>categoryName	Nome da categoria da oferta.
offer[]>links>link[]	Lista de links da oferta.
offer[]>links>link[]>type	Tipo do link. Manter "offer".
offer[]>links>link[]>url	URL da oferta.
offer[]>thumbnail>url	URL da imagem da oferta.
offer[]>priceValue	Valor da oferta (Preço por: ). (Formato 0.0)
offer[]>priceFromValue	Preço da oferta (Preço de: ). (Formato 0.0)
offer[]>discountPercentage	Porcentagem de desconto.
offer[]>seller>sellerName	Nome da loja.
offer[]>seller>thumbnail>url	URL do logo da loja.
offer[]>seller>rating>useraveragerating>rating	Nota média dos usuários sobre a loja. (Formato 0.0)
offer[]>seller>rating>useraveragerating>numcomments	Número de comentários dos usuários sobre a loja.
offer[]>seller>rating>ebitrating>ratingnew	Nome da medalha E-bit da loja.
offer[]>seller>rating>ebitrating>numcomments	Número de comentários no E-bit.
offer[]>seller>id	ID da loja.
offer[]>categoryId	ID da categoria.
offer[]>id	ID da oferta.
offer[]>productId	ID do produto.
totalresultsavailable	Total de ofertas disponíveis para essa busca.
totalresultsreturned	Total de ofertas retornadas nessa páginas.
totalpages	Total de páginas.
page	Página atual.
details	Detalhes da requisição.