Trading_GetUserDisputesRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_GetUserDisputesRequestType.h Trading_GetUserDisputesRequestType.m |
Overview
Requests a list of disputes the requester is involved in as buyer or seller.
eBay Buyer Protection Item Not Received and Significantly Not As Described cases
are not returned with this call. To retrieve eBay Buyer Protection cases, the
getUserCases call of the Resolution Case Management API must be used instead.
@ingroup EBayAPIInterface
Tasks
-
disputeFilterType
An inclusive filter that isolates the returned disputes to a certain
property
type such as Item Not Received or Unpaid Item disputes. eBay Buyer
Protection cases are not retrieved with this call, even if the
ItemNotReceivedDisputes filter is included in the request. -
disputeSortType
The value and sequence to use to sort the returned disputes.
property -
modTimeFrom
A filter that retrieves disputes whose DisputeModifiedTime is later
property
than or equal to this value. Specify the time value in GMT.
See the eBay Web Services documentation for information about specifying time values.
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. -
modTimeTo
A filter that retrieves disputes whose DisputeModifiedTime is earlier
property
than or equal to this value. Specify the time value in GMT.
See the eBay Web Services documentation for information about specifying time values.
For more precise control of the date range filter, it is a good practice to also
specify ModTimeFrom. Otherwise, all available disputes 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. -
pagination
The virtual page number of the result set to display. A result set has a number of disputes
property
divided into virtual pages, with 200 disputes per page. The response can only display one page.
The first page in the result set is number 1. Required. If not specified, a warning is returned
and Pagination.PageNumber is set to 1 by default.
Properties
disputeFilterType
An inclusive filter that isolates the returned disputes to a certain
type such as Item Not Received or Unpaid Item disputes. eBay Buyer
Protection cases are not retrieved with this call, even if the
ItemNotReceivedDisputes filter is included in the request.
@property (nonatomic, retain) NSString *disputeFilterType
Discussion
An inclusive filter that isolates the returned disputes to a certain
type such as Item Not Received or Unpaid Item disputes. eBay Buyer
Protection cases are not retrieved with this call, even if the
ItemNotReceivedDisputes filter is included in the request.
type: string constant in Trading_DisputeFilterTypeCodeType.h
Declared In
Trading_GetUserDisputesRequestType.h
disputeSortType
The value and sequence to use to sort the returned disputes.
@property (nonatomic, retain) NSString *disputeSortType
Discussion
The value and sequence to use to sort the returned disputes.
type: string constant in Trading_DisputeSortTypeCodeType.h
Declared In
Trading_GetUserDisputesRequestType.h
modTimeFrom
A filter that retrieves disputes whose DisputeModifiedTime is later
than or equal to this value. Specify the time value in GMT.
See the eBay Web Services documentation for information about specifying time values.
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.
@property (nonatomic, retain) NSDate *modTimeFrom
Discussion
A filter that retrieves disputes whose DisputeModifiedTime is later
than or equal to this value. Specify the time value in GMT.
See the eBay Web Services documentation for information about specifying time values.
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.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetUserDisputesRequestType.h
modTimeTo
A filter that retrieves disputes whose DisputeModifiedTime is earlier
than or equal to this value. Specify the time value in GMT.
See the eBay Web Services documentation for information about specifying time values.
For more precise control of the date range filter, it is a good practice to also
specify ModTimeFrom. Otherwise, all available disputes 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.
@property (nonatomic, retain) NSDate *modTimeTo
Discussion
A filter that retrieves disputes whose DisputeModifiedTime is earlier
than or equal to this value. Specify the time value in GMT.
See the eBay Web Services documentation for information about specifying time values.
For more precise control of the date range filter, it is a good practice to also
specify ModTimeFrom. Otherwise, all available disputes 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.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetUserDisputesRequestType.h
pagination
The virtual page number of the result set to display. A result set has a number of disputes
divided into virtual pages, with 200 disputes per page. The response can only display one page.
The first page in the result set is number 1. Required. If not specified, a warning is returned
and Pagination.PageNumber is set to 1 by default.
@property (nonatomic, retain) Trading_PaginationType *pagination
Discussion
The virtual page number of the result set to display. A result set has a number of disputes
divided into virtual pages, with 200 disputes per page. The response can only display one page.
The first page in the result set is number 1. Required. If not specified, a warning is returned
and Pagination.PageNumber is set to 1 by default.
type : class Trading_PaginationType
Declared In
Trading_GetUserDisputesRequestType.h