Home > Home > Documentation > List of offers

List of offers

Search all offers of a particular product, filtering for evaluation of the store, price or popularity.

How it works?

Funcionamento da lista de ofertas

On this page:
  1. Application sends a request stating the final category ID or Product ID, as well as one or more keywords or category ID more keywords.
  2. Service receives the request and search the list of offers in the cod.
  3. Service returns a list of offers in the XML format for application.

Service URLs

Search by category ID.

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

Search by product ID.

http://sandbox.buscape.com/service/findOfferList/<application_id>/?productId=<productId>

Search by barcode.

http://sandbox.buscape.com/service/findOfferList/<application_id>/?barcode=<barcode>

Search by keyword.

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

Search by category ID and password.

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

Parameters

Parameters Type Description
categoryId Int Category ID
productId Int Product ID
barcode String Barcode Product
keyword String Keywords

See all categories used to make requests to the API of cod.

Filters

Parameters type Description
results Int Number of results
page Int Page number
priceMin Float Minimum price
priceMax Float Maximum price
sort String Ordination
  • price/dprice: Sorting by price
  • rate/drate: Sort by Rating User
  • seller/dseller: Ordered by store
  • installment/dinstallment: Sorting by price plot
  • numberofinstallments/dnumberofinstallments: Ordered by number of plots
  • trustedStore: Ordered by label recognized company in Buscapé
medal String Filters offers and products from a certain medal in eBit
  • all
  • diamond
  • gold
  • silver
  • bronze

Response formats

The standard response format is XML.

If you want to use the JSON response format, add the format = json

Sample Request

http://sandbox.buscape.com/service/findOfferList/<application_id>/?productId=100337

Document XSD (XML Schema)

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

Response fields

Result

Fields Type Description
details ResultDetails Request details
category CategoryType Data from the current category
totalResultsAvailable Int Total items available
totalResultsReturned Int Total Items Returned
totalPages Int Total pages
page Int Current Page Number
match String Returns the type of search keyword (s)
  • allResearch perfect, all keyword (s) found
  • any: Research part-some keyword (s) found
  • none: Search Not Found

ResultDetails

Fields type Description
applicationID String Aplication ID
date String Date / Time of request
elapsedTime Long Execution time of the request in milliseconds
status String Status Response
code Int Response code
message String Reply message

CategoryType

Fields type Description
id Int Category ID
parentCategoryId Int Parent Category ID
isFinal Boolean TRUE if it’s a final category
name String Category name
links LinksType Links list
  • category: URL of the category in Buscapé
  • XML: URL of the search service offering or product category by ID
thumbnail ThumbnailType Category image

ProductType

Fields type Description
id Int Product ID
categoryId Int Category ID
totalSellers Int Total companies with offers for this product
productName String Product name
priceMin String Minimum price
priceMax String Maximum price
links LinkType Product Links
  • XML: URL of the search service offerings by product ID
  • product: URL of the product in Buscapé
  • specification: URL specification of the product in Buscapé
thumbnail ThumbnailType Product Image
rating RatingType Product Evaluation
specification SpecificationType Product details

OfferType

Fields type Description
id Int Offer ID
categoryId Int Category ID
offerName String Offer name
links LinksType Offer Link
  • offer: URL of the offer in Buscapé
thumbnail ThumbnailType Offer Image
price PriceOfferType Details of the offer price
seller SellerType Details of the seller

PriceOfferType

Fields type Description
value String Offer price
parcel ParcelType Plot

ParcelType

Fileds type Description
value String Price of share
number Int Number of plots
interest Double Interest Rate

SellerType

Fields type Description
id Int Seller ID
isTrustedStore Boolean If true, reports that the store has a recognized seal of company
sellerName String Seller name
extra String More information store
thumbnail ThumbnailType Soon the seller
links LinksType Store Links
  • seller: URL store
contacts ContactsType Contact List
rating RatingType Seller evaluation

CouponType

Fields type Description
id int Coupon ID
description String Coupon Description
type String Coupon Type
  • Toast
  • Discount
  • Free Shipping
  • Selling Time
link String Coupon Link

ContactsType

Fields type Description
contact ContactType Contact List

ContactType

Fields type Description
label String Description of contact
value String Value of contact

LinksType

Fields type Description
link LinkType Link

LinkType

Fields type Description
type String Type of link:
url String Link adress

ThumbnailType

Fields type Description
url String Image adress

RatingType

Fields type Description
userAverageRating UserRatingType User rating

UserRatingType

Fields type Description
numComments Int Comments Number
rating String Average grade of the users
link LinkType Link evaluation
  • XML: URL of the service user by evaluating the product ID
specification SpecificationType Evaluation of product items

EBitRatingType

Fields type Description
numComments Int Number of Comments
rating String Note of EBIT
  • diamond
  • Gold
  • Silver
  • Bronze
link LinkType Link evaluation

SpecificationType

Fields type Description
item ItemListType List of specification items
links LinkType Links
label String List of specification items

ItemListType

Fields type Description
label String Item name
value String Item Value

Example Response

Find products with same ID 100337 (Playstation).

http://sandbox.buscape.com/service/findOfferList/<application_id>/?productId=100337
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    
    

        564771466d477a4458664d3d
        1.0.0.0
        http://bws-apps.buscape.com/mobile/update
        2010-10-19T11:05:05.346
        53
        success
        0
        success
    

    
        
        
            
            
        
        Console de Videogame
    
    
        Sony PlayStation 3 80GB
        Sony PlayStation 3 80GB
        
        1049.90
        1298.00
        
            
            
            
        
        
        
            
                133
                8.4
                
                    
                
                
                    
                        9.0
                    
                    
                        9.8
                    
                    
                        6.2
                    
                    
                        6.2
                    
                    
                        9.4
                    
                    
                        9.4
                    
                    
                        9.0
                    
                
            
        
        
            
                
            
            
                Blu-Ray
                CD
                DVD
            
            
                1920 x 1080 Pixels
            
            
                4
            
            
                Sim
            
            
                Bluetooth
                USB
                Wi-Fi
            
            
                256 Mb
            
            

                1 Joystick
                Cabo AV
            
        
        
            
                
                    Sony
                
                
                    PlayStation 3 80GB
                
            
            
                
                    Não
                
                
                    1 Joystick
                    Cabo AV
                
            
            
                
                    256 Mb
                
            
            
                
                    NVidia RSX
                
                
                    550 MHz
                
                
                    1920 x 1080 Pixels
                
            
            
                
                    Blu-Ray
                    CD
                    DVD
                
            
            
                
                    64
                
                
                    Cell Broadband Engine
                
                
                    3.20 GHz
                
            
            
                
                    4
                
                
                    HDMI
                
                
                    Sim
                
                
                    Bluetooth
                    USB
                    Wi-Fi
                
            
            
                
                    325 mm
                
                
                    98 mm
                
                
                    274 mm
                
                
                    5 Kg
                
            
        
    
    
        PLAYSTATION 3 C / HD 80GB
        
            
        
        
        
            
            1071.00
            
                119.00
                10
                1.96
            
        
        
            Starhouse Mega Store
            
            
                
            
            Vende pela Internet
            
                
            
            
                
                    49
                    8.0
                
            
        
    
    
        Sony PlayStation 3 80GB blue ray
        
            
        
        
        
            
            1298.00
            
                76.44
                18
                0.62
            
        
        
            infozonasul
            
                
            
            Vende pela Internet
            
                
            
            
                
                    0
                    0.0
                
            
        
    
    
        Playstation 3 80gb Blu - ray Player Bluetooth 1 Controle - OEM
        
            
        
        
        
            
            1049.90
        
        
            Horda Digital
            
            
                
            
            Vende pela Internet
            
                
            
            
                
                    20
                    8.0
                
                
                    20
                    bronze
                
            
        
    
    
        Console PlayStation 3 HD 80GB
        
            
        
        
        
            
            1290.00
        
        
            Giga Games
            
                
            
            Vende pela Internet
            
                
            
            
                
                    2
                    9.0

Errors

As seen in ResultDetails, the response may return error codes.

Important information

CategoryId parameter should always be the ID of a category final.

Some categories have no final deal, just products. In this case the XML response will return an empty list of offerings. Not to lose the bond of consultation, the service will provide the URL of products ready for consultation, reporting the same category ID.

Notice to developers

If your application runs on a server, you must inform the webservices Buscapé IP user accessing your server. The IP of the user should be informed by the parameter clientIp. If your application runs directly on the end user's machine, such as mobile applications or javascript is not necessary to inform the user's IP. If, for example, the IP of the user who accessed your server is 200200200200, the call should be made thus:

http://sandbox.buscape.com/service/findOfferList/<application_id>/?productId=<productId>&clientIp=200.200.200.200
Top