brandon14/ebay-sdk-php

View on GitHub
src/Buy/Browse/V1/docs/Model/SearchPagedCollection.md

Summary

Maintainability
Test Coverage
# # SearchPagedCollection

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auto_corrections** | [**\TNT\Ebay\Buy\Browse\V1\Model\AutoCorrections**](AutoCorrections.md) |  | [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=shirt&limit=5&offset=0</code>. | [optional]
**item_summaries** | [**\TNT\Ebay\Buy\Browse\V1\Model\ItemSummary[]**](ItemSummary.md) | 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=t-shirts&limit=5&offset=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=t-shirts&limit=5&offset=0</code> | [optional]
**refinement** | [**\TNT\Ebay\Buy\Browse\V1\Model\Refinement**](Refinement.md) |  | [optional]
**total** | **int** | The total number of items that match the input criteria. | [optional]
**warnings** | [**\TNT\Ebay\Buy\Browse\V1\Model\Error[]**](Error.md) | The container with all the warnings for the request. | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)