Finding API class

The Finding API enables developers to access eBay's next generation search capabilities. The Finding API enables developers to search for items using eBay's next generation Finding Platform. Buying applications can build search and browse experiences using the powerful search and search refinement capabilities offered by the Finding APIs.

Usage

use eBay::API::Simple::Finding;

my $api = eBay::API::Simple::Finding->new( {
   appid   => 'YOUR_APPID',
} );

$api->execute( 'findItemsByKeywords', { keywords => 'Perl' } );

if ( $api->has_error() ) {
   die "Call Failed:" . $api->errors_as_string();
}

my $dom  = $api->response_dom();
my $hash = $api->response_hash();

Usage With YAML

Place a YAML file in your home or /etc/ directory and reference that filename when constructing the object. The default YAML filename is "ebay.yaml". If you use this name it will automatically get picked up.

my $api = eBay::API::Simple::Finding->new( {
   config_file => 'myebay.yaml',
} );

Sandbox Usage

my $api = eBay::API::Simple::Finding->new( {
   domain  => 'svcs.sandbox.ebay.com',
   appid   => 'YOUR_APPID',
} );

Public Methods

Finding(**kwargs)

Keyword arguments to Finding() constructor

domain        -- API endpoint (default: svcs.ebay.com)
config_file   -- YAML defaults (default: ebay.yaml)
debug         -- debugging enabled (default: False)
warnings      -- warnings enabled (default: False)
uri           -- API endpoint uri (default: /services/search/FindingService/v1)
appid         -- eBay application id
siteid        -- eBay country site id (default: EBAY-US)
compatibility -- version number (default: 1.0.0)
https         -- execute of https (default: False)
proxy_host    -- proxy hostname
proxy_port    -- proxy port number
timeout       -- HTTP request timeout (default: 20)
parallel      -- ebaysdk parallel object
response_encoding -- API encoding (default: XML)
request_encoding  -- API encoding (default: XML)

execute(verb, data)

Execute the HTTP request.

$api->execute('findItemsAdvanced', {'keywords': 'Perl'})

error()

Returns a string of the HTTP call errors

if ( $api->error() ) {
    print "has errors: " . $api->error()
}

response_dom()

Return a DOM object of the HTTP response content.

response_hash()

Return a dictionary of the HTTP response content.

response_content()

Returns the string content from HTTP response call.

response_code()

Returns the HTTP response code.

response_status()

Returns the HTTP response status

API Use Cases

• Affiliate Tracking
• Controlling the Way Search Results are Returned
• Refining a Search with Aspect and Domain Filters
• Refining a Search with Item Filters
• Retrieving Histogram Metadata
• Searching and Browsing by Category
• Searching by Keywords
• Searching by Product

see more

More Examples

see samples