eBay · Schema

SalesHistoryPagedCollection

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
href	string	The URI of the current page of results from the result set. The following example returns items 1 thru 5 from the list of items found. `https://api.ebay.com/buy/marketplace_in`
itemSales	array	The type that defines the fields for a paginated result set of the sold items. The response consists of 0 or more sequenced result sets where each result sets has 0 or more items.
limit	integer	The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.
next	string	The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. Max length: 2048
offset	integer	The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.
prev	string	The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. Max length: 2048
refinement	object	The container for all the search refinements.
total	integer	The total number of items retrieved in the result set. If no items are found, this field is returned with a value of `0`. Note: `total`

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SalesHistoryPagedCollection",
  "title": "SalesHistoryPagedCollection",
  "type": "object",
  "properties": {
    "href": {
      "type": "string",
      "description": "The URI of the current page of results from the result set.  <br><br><b> The following example returns items 1 thru 5 from the list of items found. </b><br><code>https://api.ebay.com/buy/marketplace_insights/v1_beta/item_sales/search?q=shirt&&limit=5&offset=0</code>"
    },
    "itemSales": {
      "type": "array",
      "description": "The type that defines the fields for a paginated result set of the sold items. The response consists of 0 or more sequenced <em> result sets</em> where each result sets has 0 or more items.<br><br><span class=\"tablenote\"><b> Note:</b> For items with multiple quantities that might result in multiple transactions, and items with the <code>SELLER_DEFINED_VARIATIONS</code> group type that might result in multiple transactions, only one deduped transaction is returned in the search results.</span>",
      "items": {
        "$ref": "#/components/schemas/ItemSales"
      }
    },
    "limit": {
      "type": "integer",
      "description": "The number of items returned on a single page from the result set. This value can be set in the request with the <b>limit</b> query parameter.",
      "format": "int32"
    },
    "next": {
      "type": "string",
      "description": "The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. <br><br><b>Max length</b>: 2048"
    },
    "offset": {
      "type": "integer",
      "description": "The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the <b>offset</b> query parameter.",
      "format": "int32"
    },
    "prev": {
      "type": "string",
      "description": "The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. <br><br><b>Max length</b>: 2048"
    },
    "refinement": {
      "description": "The container for all the search refinements.",
      "$ref": "#/components/schemas/Refinement"
    },
    "total": {
      "type": "integer",
      "description": "The total number of items retrieved in the result set.<br><br>If no items are found, this field is returned with a value of <code>0</code>.<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/marketplace-insights/resources/item_sales/methods/search#response.next \"> next</a> to determine the results on the next page.</span>",
      "format": "int32"
    }
  }
}