eBay · Schema

DisputeSummaryResponse

This type defines the base response payload of the getPaymentDisputeSummaries method. Each payment dispute that matches the input criteria is returned under the paymentDisputeSummaries array.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
href	string	The URI of the getPaymentDisputeSummaries call request that produced the current page of the result set.
limit	integer	This value shows the maximum number of payment disputes that will appear on one page of the result set. The limit value can be passed in as a query parameter in the request, or if it
next	string	The getPaymentDisputeSummaries call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 11 thru 20 from the collection of pa
offset	integer	This integer value indicates the number of payment disputes skipped before listing the first payment dispute from the result set. The offset value can be passed in as a query paramete
paymentDisputeSummaries	array	Each payment dispute that matches the input criteria is returned under this array. If no payment disputes are found, an empty array is returned.
prev	string	The getPaymentDisputeSummaries call URI to use if you wish to view the previous page of the result set. For example, the following URI returns records 1 thru 10 from the collection of
total	integer	This integer value is the total number of payment disputes that matched the input criteria. If the total number of entries exceeds the value that was set for limit in the request payl

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DisputeSummaryResponse",
  "title": "DisputeSummaryResponse",
  "type": "object",
  "properties": {
    "href": {
      "type": "string",
      "description": "The URI of the <strong>getPaymentDisputeSummaries</strong> call request that produced the current page of the result set."
    },
    "limit": {
      "type": "integer",
      "description": "This value shows the maximum number of payment disputes that will appear on one page of the result set. The <strong>limit</strong> value can be passed in as a query parameter in the request, or if it is not used, it defaults to <code>200</code>. If the value in the <strong>total</strong> field exceeds this <strong>limit</strong> value, there are multiple pages in the current result set.<br><br><b>Min</b>: 1; <b>Max</b>: 200; <b>Default</b>: 200",
      "format": "int32"
    },
    "next": {
      "type": "string",
      "description": "The <strong>getPaymentDisputeSummaries</strong> call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 11 thru 20 from the collection of payment disputes:<br><br><code>path/payment_dispute_summary?limit=10&offset=10</code><br><br>This field is only returned if there is a next page of results to view based on the current input criteria."
    },
    "offset": {
      "type": "integer",
      "description": "This integer value indicates the number of payment disputes skipped before listing the first payment dispute from the result set. The <strong>offset</strong> value can be passed in as a query parameter in the request, or if it is not used, it defaults to <code>0</code> and the first payment dispute of the result set is shown at the top of the response.",
      "format": "int32"
    },
    "paymentDisputeSummaries": {
      "type": "array",
      "description": "Each payment dispute that matches the input criteria is returned under this array. If no payment disputes are found, an empty array is returned.",
      "items": {
        "$ref": "#/components/schemas/PaymentDisputeSummary"
      }
    },
    "prev": {
      "type": "string",
      "description": "The <strong>getPaymentDisputeSummaries</strong> call URI to use if you wish to view the previous page of the result set. For example, the following URI returns records 1 thru 10 from the collection of payment disputes:<br><br><code>path/payment_dispute_summary?limit=10&offset=0</code><br><br>This field is only returned if there is a previous page of results to view based on the current input criteria."
    },
    "total": {
      "type": "integer",
      "description": "This integer value is the total number of payment disputes that matched the input criteria. If the total number of entries exceeds the value that was set for <strong>limit</strong> in the request payload, you will have to make multiple API calls to see all pages of the results set. This field is returned even if it is <code>0</code>.",
      "format": "int32"
    }
  },
  "description": "This type defines the base response payload of the <strong>getPaymentDisputeSummaries</strong> method. Each payment dispute that matches the input criteria is returned under the <strong>paymentDisputeSummaries</strong> array."
}