eBay · Schema

EventItemSearchResponse

The result set for the event item search.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
eventItems	array	A list of event items that match the search criteria.
href	string	The relative path to the current set of results.
limit	integer	The maximum number of items, from the current result set, returned on a single page. Default: `20`
next	string	The relative path to the next set of results.
offset	integer	The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to
prev	string	The relative path to the previous set of results.
total	integer	The total number of matches for the specified search criteria.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EventItemSearchResponse",
  "title": "EventItemSearchResponse",
  "type": "object",
  "properties": {
    "eventItems": {
      "type": "array",
      "description": "A list of event items that match the search criteria.",
      "items": {
        "$ref": "#/components/schemas/EventItem"
      }
    },
    "href": {
      "type": "string",
      "description": "The relative path to the current set of results."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of items, from the current result set, returned on a single page.<br /><br /><b>Default:</b> <code>20</code>",
      "format": "int32"
    },
    "next": {
      "type": "string",
      "description": "The relative path to the next set of results."
    },
    "offset": {
      "type": "integer",
      "description": "The number of items that will be skipped in the result set. This is used with the <b>limit</b> field to control the pagination of the output.<br /><br />For example, if the <b>offset</b> is set to <code>0</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 1 through 10 from the list of items returned. If the <b>offset</b> is set to <code>10</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 11 through 20 from the list of items returned.<br /><br /><b>Default:</b> <code>0</code>",
      "format": "int32"
    },
    "prev": {
      "type": "string",
      "description": "The relative path to the previous set of results."
    },
    "total": {
      "type": "integer",
      "description": "The total number of matches for the specified search criteria.",
      "format": "int32"
    }
  },
  "description": "The result set for the event item search."
}