eBay Trading APIVersion 1267
 

GetUserDisputesRequestType ( AbstractRequestType )

The base request type for the GetUserDisputes call. This call is used to retrieve a list of Unpaid Item cases that the user is involved in as a buyer or seller.

Call that uses GetUserDisputesRequestType:

Fields



DisputeFilterType ( DisputeFilterTypeCodeType ) [0..1]
An inclusive filter that isolates the returned disputes to a certain type such as Unpaid Item cases.
See the Field Index to learn which calls use DisputeFilterType.

DisputeSortType ( DisputeSortTypeCodeType ) [0..1]
One of the values defined in DisputeSortTypeCodeType is used here to control the order of cases that are returned.
See the Field Index to learn which calls use DisputeSortType.

ModTimeFrom ( dateTime ) [0..1]
A filter that retrieves cases whose DisputeModifiedTime is later than or equal to this value. Specify the time value in GMT. For more precise control of the date range filter, it is a good practice to also specify ModTimeTo. Otherwise, the end of the date range is the present time. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned.
See the Field Index to learn which calls use ModTimeFrom.

ModTimeTo ( dateTime ) [0..1]
A filter that retrieves cases whose DisputeModifiedTime is earlier than or equal to this value. Specify the time value in GMT. For more precise control of the date range filter, it is a good practice to also specify ModTimeFrom. Otherwise, all available cases modified prior to the ModTimeTo value are returned. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned.
See the Field Index to learn which calls use ModTimeTo.

Pagination ( PaginationType ) [0..1]
This container is used to set the number of records to retrieve per page of data and also what page of data you want to view. If there are multiple pages of data in the result set, the user would have to make subsequent calls while upticking the PageNumber by 1 each time to view additional pages.

Note: PaginationType is a type used by multiple Trading API calls, and the minimum, maximum, and default values for EntriesPerPage can vary depending on the call. For GetUserDisputes, the EntriesPerPage value will always default to 200, regardless of the value that is input by the user. For PageNumber, some Trading API calls use 0 for the first page of data in the result set, and some calls use 1 for the first page of data in the result set. For GetUserDisputes, 0 is used for the first page and it will default to 0 if the PageNumber is not included.

Technically, you can run a GetUserDisputes call without using the Pagination container at all (and default values will be used), but a warning message will be triggered if you don't use this container.
See the Field Index to learn which calls use Pagination.