eBay · Schema

SearchPagedCollection

The type that defines the fields for a paginated result set. The response consists of 0 or more sequenced pages where each page has 0 or more items.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
autoCorrections	object	The auto-corrected inputs.
href	string	The URI of the current page of results. The following example of the search method returns items 1 thru 5 from the list of items found. https://api.ebay.com/buy/v1/item_summary/searc
itemSummaries	array	An array of the items on this page. The items are sorted according to the sorting method specified in the request.
limit	integer	The value of the `limit` 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 returne
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. The following example of the search method returns i
offset	integer	This value indicates the `offset` used for current page of items being returned. Assume the initial request used an `offset` of `0` and a `limit` of `3`
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. The following example of the search method returns items 1 thru 5 f
refinement	object	The container for all the search refinements.
total	integer	The total number of items that match the input criteria. Note: `total` is just an indicator of the number of listings for a given query. It could vary
warnings	array	The container with all the warnings for the request.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchPagedCollection",
  "title": "SearchPagedCollection",
  "type": "object",
  "properties": {
    "autoCorrections": {
      "description": "The auto-corrected inputs.",
      "$ref": "#/components/schemas/AutoCorrections"
    },
    "href": {
      "type": "string",
      "description": "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.<pre>https://api.ebay.com/buy/v1/item_summary/search?q=shirt&limit=5&offset=0</pre>."
    },
    "itemSummaries": {
      "type": "array",
      "description": "An array of the items on this page. The items are sorted according to the sorting method specified in the request.",
      "items": {
        "$ref": "#/components/schemas/ItemSummary"
      }
    },
    "limit": {
      "type": "integer",
      "description": "The value of the <code>limit</code> 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.",
      "format": "int32"
    },
    "next": {
      "type": "string",
      "description": "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.<pre>https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=10</pre>"
    },
    "offset": {
      "type": "integer",
      "description": "This value indicates the <code>offset</code> used for current page of items being returned. Assume the initial request used an <code>offset</code> of <code>0</code> and a <code>limit</code> 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.",
      "format": "int32"
    },
    "prev": {
      "type": "string",
      "description": "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.<pre>https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=0</pre>"
    },
    "refinement": {
      "description": "The container for all the search refinements.",
      "$ref": "#/components/schemas/Refinement"
    },
    "total": {
      "type": "integer",
      "description": "The total number of items that match the input criteria.<br><br><span class=\"tablenote\"><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=\"/api-docs/buy/browse/resources/item_summary/methods/search#response.next \">next</a> to determine the results on the next page.</span>",
      "format": "int32"
    },
    "warnings": {
      "type": "array",
      "description": "The container with all the warnings for the request.",
      "items": {
        "$ref": "#/components/schemas/Error"
      }
    }
  },
  "description": "The type that defines the fields for a paginated result set. The response consists of 0 or more sequenced <i>pages</i> where each page has 0 or more items."
}