NAME
eBay::API::XML::Call::GetSearchResultsExpress::GetSearchResultsExpressResponseType
DESCRIPTION
The GetSearchResultsExpress response contains the listings that match the query or ID specified in the request, related eBay catalog product information, and a histogram showing the the quantity (count) of matching items in Express departments, aisles, and product types. The results may be limited by filters that were specified in the request.
SYNOPSIS
INHERITANCE
eBay::API::XML::Call::GetSearchResultsExpress::GetSearchResultsExpressResponseType inherits from the eBay::API::XML::ResponseDataType class
Subroutines:
setEntriesPerPage()
Indicates the number of item and product results per page that you originally requested (not the number of items or products that were returned). To determine how many items or products were actually returned, count the number of Item nodes in ItemArray (if any) and the number of Product nodes in ProductArray (if any).
Max: 200 Min: 1
# Argument: 'xs:int'
getEntriesPerPage()
Returned: Always
# Returns: 'xs:int'setHasMoreEntries()
If true, there are additional item and/or product results (on higher- numbered pages) that match the query. To retrieve them, call GetSearchResultsExpress again and increment the page number or specify a higher value for EntriesPerPage in the request.
# Argument: 'xs:boolean'
isHasMoreEntries()
Returned: Always
# Returns: 'xs:boolean'setHistogram()
Indicates the quantity of items and catalog products that fall into departments, aisles, and/or product types that match the criteria in the request. The sort order is controlled by the value of HistogramSort in the request. Only returned when matching data is found and HistogramDetails is Coarse (the default) or Fine.<br> <br> When HistogramDetails==Coarse and no DepartmentName, AisleName, or ProductTypeName is specified in the request, Express only returns histogram details for departments. In this particular case, Express returns no histogram details when no departments match the request. This could occur when Express only finds matching results in stand-alone product types or stand-alone aisles (because they aren't grouped into departments).
# Argument: 'ns:DomainHistogramType'
getHistogram()
Returned: Conditionally
# Returns: 'ns:DomainHistogramType'setItemArray()
Contains a list of items on Express that match all the criteria specified in the request. The sort order is controlled by the value of ItemSort in the request. Only returned when matching data is found and ItemDetails is Coarse (the default) or Fine.<br> <br> If the same seller has listed multiple items with the same title and costs, only one of those items is returned by default. This is treated as a consolidated (deduped) search result item that represents the seller's other, identical items. If you want to retrieve all duplicates for an item, pass the seller's user ID in the SellerID field in the request. Use the results to identify items with duplicate titles and costs.<br> <br> Items can belong to multiple departments, aisles, or product types at any given time, and this information is not stored or returned in the item data. To determine which items are currently available in a given domain, specify the DepartmentName, AisleName, or ProductTypeName in the request.
# Argument: 'ns:ItemArrayType'
getItemArray()
Returned: Conditionally
# Returns: 'ns:ItemArrayType'setPageNumber()
Indicates the page of data returned by the current call.
Max: Min: 1
# Argument: 'xs:int'
getPageNumber()
Returned: Always
# Returns: 'xs:int'setProductArray()
Contains a list of eBay catalog products have been used to pre-fill listings that match the criteria specified in the request. The sort order is controlled by the value of ProductSort in the request. Only returned when matching data is found and ProductDetails is Coarse (the default) or Fine. To determine which products are currently available in a given domain, specify the DepartmentName, AisleName, or ProductTypeName in the request.
# Argument: 'ns:ProductArrayType'
getProductArray()
Returned: Conditionally
# Returns: 'ns:ProductArrayType'