NAME

eBay::API::XML::Call::GetProducts

DESCRIPTION

SYNOPSIS

INHERITANCE

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

Subroutines:

setAffiliateTrackingDetails()

See the <a href="https://www.ebaypartnernetwork.com/" target="_blank">eBay Partner Network</a>. eBay uses the specified details to build a View Item URL string in the response that includes your affiliate tracking information in the correct format. When a user clicks through the URL to eBay and performs certain tasks, you may get a commission (see the URL above). Only applicable when IncludeItemArray is specified (because the View Item URL is only returned in item information, not in product information).

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AffiliateTrackingConcepts Title: Affiliate Tracking Concepts

  RequiredInput: No
#    Argument: 'ns:AffiliateTrackingDetailsType'

setIncludeBuyingGuideDetails()

If true, the response includes up to 5 buying guides (if any) for the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords.

  RequiredInput: No
  Default: false
#    Argument: 'xs:boolean'

setIncludeHistogram()

If true, the response includes a histogram that lists the number of matching products found and the domains in which they were found. (A domain is like a high-level category.) Including the histogram can affect the call's performance. You may see significantly slower response times when many matching products are found.

  RequiredInput: No
  Default: false
#    Argument: 'xs:boolean'

setIncludeItemArray()

If true, the response includes items (if any) that match the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords.

  RequiredInput: No
  Default: false
#    Argument: 'xs:boolean'

setIncludeReviewDetails()

If true, the response includes up to 20 reviews (if any) for the product specified in ExternalProductID or ProductReferenceID. The reviews are sorted by most helpful (most votes) first. When you include review details, please note that response times may be longer than 60 seconds. Not applicable with QueryKeywords.

  RequiredInput: No
  Default: false
#    Argument: 'xs:boolean'

setProductSearch()

Contains the fields that form the search query. You can query against keywords, an eBay product reference ID (not to be confused with an eBay product ID), or external product ID (like an ISBN).

  RequiredInput: Yes
#    Argument: 'ns:ProductSearchType'

setProductSort()

Sorts the list of products returned. This is mostly only useful with QueryKeywords. (When you use ExternalProductID or ProductReferenceID, eBay usually only returns one product.)

  RequiredInput: No
#    Argument: 'ns:ProductSortCodeType'

getApproximatePages()

The total number of pages that can be returned, given the same query and filters in the request. As GetProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request).

  Returned: Always
#    Returns: 'xs:int'

getBuyingGuideDetails()

Contains information for up to 5 buying guides that match the query. Only returned when you set IncludeBuyingGuideDetails to true. Buying guides provide useful information about shopping in a particular domain, like Digital Cameras. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. If no buying guides are associated with the product, this only returns a link to the buying guide hub (the main Guides page).

  Returned: Conditionally
#    Returns: 'ns:BuyingGuideDetailsType'

getCharacteristicsSetProductHistogram()

A histogram that lists the number of matching products found and the domains in which they were found. A <i>domain</i> is essentially a set of categories that share certain common features (as determined by eBay). Each domain has its own name and ID.

  Returned: Always
#    Returns: 'ns:CharacteristicsSetProductHistogramType'

isHasMore()

If true, more pages of results are available. That is, PageNumber is less than ApproximatePages.

  Returned: Always
#    Returns: 'xs:boolean'

getItemArray()

A list of items (if any) that match the product identified in ExternalProductID or ProductReferenceID in the request. Only returned when you set IncludeItemArray to true. The items are sorted by end time (ending soonest), and this order is not configurable in the request. Up to 200 items can be returned. All items are returned on the first page (page 1). Not returned when you use QueryKeywords.<br> <br> If ItemCount is greater than 200, use GetSearchResults if you want to retrieve more matching items.<br> <br> <span class="tablenote"><b>Note:</b> GetSearchResults doesn't currently support ProductReferenceID queries. So, you can use ExternalProductID (if present) as input to GetSearchResults. Otherwise, see Product.DetailsURL for a workaround to determine a ProductID value to use with GetSearchResults.</span>

  Returned: Conditionally
#    Returns: 'ns:ItemArrayType'

getPageNumber()

The number of the page of data returned. If many products are found and multiple pages of results are available, use this in combination with ApproximatePages and HasMore to decide which page to retrieve next. As GetProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request).

  Returned: Always
#    Returns: 'xs:int'

getProduct()

An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. When you use QueryKeywords in the request, GetProducts returns a maximum of 20 products per page. When you use ExternalProductID or ProductReferenceID in the request, GetProducts usually only returns 1 product. (If more than one product matches the same ExternalProductID, GetProducts will return all of those products. As of the time of this writing, we expect this to be a rare case.)

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

getTotalProducts()

The total number of matching products found. (If more than 2000 products are found, the call fails with an error.)

  Returned: Always
#    Returns: 'xs:int'