eBay · Schema

CharitySearchResponse

A single set of search results, with information for accessing other sets.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
charityOrgs array The list of charitable organizations that match the search criteria.
href string The relative path to the current set of results.
limit integer The number of items, from the result set, returned in a single page.

Valid Values: 1-100

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 search criteria.
View JSON Schema on GitHub

JSON Schema

ebay-charitysearchresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CharitySearchResponse",
  "title": "CharitySearchResponse",
  "type": "object",
  "properties": {
    "charityOrgs": {
      "type": "array",
      "description": "The list of charitable organizations that match the search criteria.",
      "items": {
        "$ref": "#/components/schemas/CharityOrg"
      }
    },
    "href": {
      "type": "string",
      "description": "The relative path to the current set of results."
    },
    "limit": {
      "type": "integer",
      "description": "The number of items, from the result set, returned in a single page.<br /><br /><b>Valid Values:</b> <code>1-100</code><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>Valid Values:</b> <code>0-10,000</code><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 search criteria.",
      "format": "int32"
    }
  },
  "description": "A single set of search results, with information for accessing other sets."
}