Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 3.44 KB

SearchPagedCollection.md

File metadata and controls

18 lines (15 loc) · 3.44 KB

# SearchPagedCollection

Properties

Name Type Description Notes
auto_corrections \OpenAPI\EbayBrowseClient\Model\AutoCorrections [optional]
href string The URI of the current page of results. <br><br>The following example of the <b> search</b> method returns items 1 thru 5 from the list of items found. <br><br><code>https://api.ebay.com/buy/v1/item_summary/search?q&#x3D;shirt&amp;limit&#x3D;5&amp;offset&#x3D;0&lt;/code>. [optional]
item_summaries \OpenAPI\EbayBrowseClient\Model\ItemSummary[] An array of the items on this page. The items are sorted according to the sorting method specified in the request. [optional]
limit int The value of the <b>limit</b> parameter submitted in the request, which is the maximum number of items to return on a page, from the result set. A result set is the complete set of items returned by the method. [optional]
next string The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. <br><br>The following example of the <b> search</b> method returns items 5 thru 10 from the list of items found.<br> <br><code>https://api.ebay.com/buy/v1/item_summary/search?query&#x3D;t-shirts&amp;limit&#x3D;5&amp;offset&#x3D;10 </code> [optional]
offset int This value indicates the <b>offset</b> used for current page of items being returned. Assume the initial request used an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>3</code>. Then in the first page of results, this value would be <code>0</code>, and items 1-3 are returned. For the second page, this value is <code>3</code> and so on. [optional]
prev string The URI for the previous page of results. This is returned if there is a previous page of results from the result set. <br><br>The following example of the <b> search</b> method returns items 1 thru 5 from the list of items found, which would be the first set of items returned.<br> <br><code>https://api.ebay.com/buy/v1/item_summary/search?query&#x3D;t-shirts&amp;limit&#x3D;5&amp;offset&#x3D;0&lt;/code> [optional]
refinement \OpenAPI\EbayBrowseClient\Model\Refinement [optional]
total int The total number of items that match the input criteria.<br><br><span class=&quot;tablenote&quot;><b>Note:</b> <code>total</code> is just an indicator of the number of listings for a given query. It could vary based on the number of listings with variations included in the result. It is strongly recommended that <code>total</code> not be used in pagination use cases. Instead, use <a href=&quot;/api-docs/buy/browse/resources/item_summary/methods/search#response.next &quot;> next</a> to determine the results on the next page.</span> [optional]
warnings \OpenAPI\EbayBrowseClient\Model\Error[] The container with all the warnings for the request. [optional]

[Back to Model list] [Back to API list] [Back to README]