eBay Trading APIVersion 1275
 

GetUserDisputesResponseType ( AbstractResponseType )

The base response type for the GetUserDisputes, a call that retrieves a list of cases that the user is involved in as a buyer or seller.

Note: The GetUserDisputes call is deprecated and is scheduled for decommission on January 31, 2023. The alternative API to search for cancellation requests is the Search Cancellations method of the Post-Order API .

Call that uses GetUserDisputesResponseType:

Fields



DisputeArray ( DisputeArrayType ) [0..1]
The array of disputes that match the input criteria in the request. It will be returned as empty if no disputes match the input criteria.
See the Field Index to learn which calls use DisputeArray.

DisputeFilterCount ( DisputeFilterCountType ) [0..*]
This container will be returned for the different types/categories of disputes. The TotalAvailable field will indicate how many disputes of that type/category (identified in the corresponding DisputeFilterType field) match the input criteria.
See the Field Index to learn which calls use DisputeFilterCount.

EndingDisputeID ( DisputeIDType (string) ) [0..1]
The index of the last dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns an EndingDisputeID value of 199 (since a zero-based index is used) and the second page returns an EndingDisputeID value of 227.
See the Field Index to learn which calls use EndingDisputeID.

ItemsPerPage ( int ) [0..1]
The maximum number of records that will be displayed per page of data. This value will always be 200 since the EntriesPerPage value defaults to and can only be set to 200.
See the Field Index to learn which calls use ItemsPerPage.

PageNumber ( int ) [0..1]
The page number of the result set that is currently being viewed. Keep in mind that the GetUserDisputes call uses a zero-based index for pagination, so the first page of data in the result set will actually have a value of lt;code>0.
See the Field Index to learn which calls use PageNumber.

PaginationResult ( PaginationResultType ) [0..1]
The result of the pagination, including the total number of virtual pages in the result set and the total number of records returned.
See the Field Index to learn which calls use PaginationResult.

StartingDisputeID ( DisputeIDType (string) ) [0..1]
The index of the first dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns a StartingDisputeID value of 0 (since a zero-based index is used) and the second page returns a StartingDisputeID value of 200.
See the Field Index to learn which calls use StartingDisputeID.