eBay::API::XML::Call::GetProductSearchResults - eBay::API::XML::Call::GetProductSearchResults documentation


eBay-API documentation Contained in the eBay-API distribution.

Index


Code Index:

NAME

Top

eBay::API::XML::Call::GetProductSearchResults

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetProductSearchResults inherits from the eBay::API::XML::BaseCall class

Subroutines:

Top

setProductSearch()

Specifies the keywords or attributes that make up the product query, with pagination instructions. ProductSearch is a required input. To search for multiple different products at the same time (i.e., to perform a batch search), pass in multiple ProductSearch properties.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductSearch Title: Searching for Pre-filled Item Information

  RequiredInput: Yes
#    Argument: reference to an array  
                      of 'ns:ProductSearchType'

getDataElementSets()

Container for one or more DataElement fields containing supplemental helpful data. A DataElement field is an HTML snippet that specifies hints for the user, help links, help graphics, and other supplemental information that varies per characteristic set. Usage of this information is optional and may require you to inspect the information to determine how it can be applied in an application. Also returned with warnings when no matches are found.

  Returned: Always
#    Returns: reference to an array  
                      of 'ns:DataElementSetType'

getProductSearchResult()

Contains the attributes and product details that match the attributes or query keywords passed in the request. Always returned when product search results are found.

  Returned: Always
#    Returns: reference to an array  
                      of 'ns:ProductSearchResultType'


eBay-API documentation Contained in the eBay-API distribution.
#!/usr/bin/perl

package eBay::API::XML::Call::GetProductSearchResults;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. GetProductSearchResults.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  

use eBay::API::XML::BaseCall;
our @ISA = ("eBay::API::XML::BaseCall");

use eBay::API::XML::Call::GetProductSearchResults::GetProductSearchResultsRequestType;
use eBay::API::XML::Call::GetProductSearchResults::GetProductSearchResultsResponseType;


sub getApiCallName {
   return 'GetProductSearchResults';
}
sub getRequestDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetProductSearchResults::GetProductSearchResultsRequestType';
}
sub getResponseDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetProductSearchResults::GetProductSearchResultsResponseType';
}

#
# input properties
#

       
sub setProductSearch {
   my $self   = shift;
   my $pProductSearch = shift;
   $self->getRequestDataType()->setProductSearch($pProductSearch);
}



#
# output properties
#

       
sub getDataElementSets {
   my $self = shift;
   return $self->getResponseDataType()->getDataElementSets();
}

       
sub getProductSearchResult {
   my $self = shift;
   return $self->getResponseDataType()->getProductSearchResult();
}





1;