Use this call to retrieve a list of disputes the requester is involved in as buyer or seller.
Note: This call retrieves all disputes except eBay Buyer Protection Item Not Received and
Significantly Not As Described cases that are created through the eBay Resolution Center.
To retrieve eBay Buyer Protection cases, the seller must use the Resolution Case Management API
getEBPCaseDetail call. Additionally, as an alternative to the
GetUserDisputes call, sellers can use the Resolution Case Management API
getUserCases call to return summary information (including case/dispute ID) on all disputes and cases. This information includes:
|
You can filter the response according to DisputeFilter values that you
supply. Use a DetailLevel of ReturnAll
to return all
data about each dispute, including DisputeResolution and
DisputeMessage elements.
GetUserDisputes retrieves disputes that were created within the last 18 months. The response might contain a large number of records, so you can apply pagination, filtering, and sorting to control the output.
If you know the DisputeID of specific disputes, use GetDispute to retrieve information on only the specified disputes.
The response from GetUserDisputes contains each dispute that involves the requester as buyer or seller, and that matches any filtering criteria you might have specified. Within each Dispute record, you can parse for information such as DisputeID, DisputeRecord, DisputeState, DisputeStatus, DisputeReason, and DisputeExplanation.
The maximum number of disputes returned per page is 200. Depending on the activity of the authenticated user, the list of disputes returned can be long, so you may want to use the Pagination fields to control the number of disputes returned per page, and which page to return from the result set.
Use DisputeSortType to specify whether the disputes should be sorted by time created, dispute status, or credit eligibility, in ascending or descending order, or not sorted at all.
You can test this call in the Sandbox.
To test GetUserDisputes, set up at least one buyer and one seller. Then, create several disputes. Have at least one involve a test user as seller, and another one involve the same test user as buyer. Call GetUserDisputes and check that disputes involving the test user as both buyer and seller are returned.
You can also check the following scenarios:
See:
Unpaid Item Disputes
Buyer Disputes
Getting Details About a Dispute
See also the reference documentation for these calls:
Output Detail Controls Samples Change History |
See also Samples.
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?> <GetUserDisputesRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <DisputeFilterType> DisputeFilterTypeCodeType </DisputeFilterType> <DisputeSortType> DisputeSortTypeCodeType </DisputeSortType> <ModTimeFrom> dateTime </ModTimeFrom> <ModTimeTo> dateTime </ModTimeTo> <Pagination> PaginationType <EntriesPerPage> int </EntriesPerPage> <PageNumber> int </PageNumber> </Pagination> <!-- Standard Input Fields --> <DetailLevel> DetailLevelCodeType </DetailLevel> <!-- ... more DetailLevel values allowed here ... --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </GetUserDisputesRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
DisputeFilterType | DisputeFilterTypeCodeType | Optional |
An inclusive filter that isolates the returned disputes to a certain type such as Item Not Received or Unpaid Item disputes. eBay Money Back Guarantee cases are not retrieved with this call, even if the ItemNotReceivedDisputes filter is included in the request.
Applicable values: See DisputeFilterType. |
DisputeSortType | DisputeSortTypeCodeType | Optional |
One of the values defined in DisputeSortTypeCodeType is used here to control the order of disputes that are returned. Default: None. Applicable values: See DisputeSortType. |
ModTimeFrom | dateTime | Optional | A filter that retrieves disputes whose DisputeModifiedTime is later than or equal to this value. Specify the time value in GMT. See the eBay Features Guide 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 | dateTime | Optional | A filter that retrieves disputes whose DisputeModifiedTime is earlier than or equal to this value. Specify the time value in GMT. See the eBay Features Guide 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 | PaginationType | Required | 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. |
Pagination.EntriesPerPage | int | Optional |
This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. Min: 200. Max: 200. Default: 200. |
Pagination.PageNumber | int | Required |
Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for the individual calls to determine the correct default value. |
Standard Input Fields |
DetailLevel | DetailLevelCodeType | Optional,
repeatable: [0..*] |
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it and processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use GranularityLevel instead, or use GetSellerEvents. If you do use 'ReturnAll' with GetSellerList, use a small Pagination.EntriesPerPage value and a narrow EndTimeFrom/EndTimeTo date range for better performance. Applicable values: (Not all values in DetailLevelCodeType apply to this field.) |
||||||||||||||||||||||||||||||||||||||||
ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
||||||||||||||||||||||||||||||||||||||||
Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
||||||||||||||||||||||||||||||||||||||||
WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
Input Detail Controls Samples Change History |
See also Samples.
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
<?xml version="1.0" encoding="utf-8"?> <GetUserDisputesResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <DisputeArray> DisputeArrayType <Dispute> DisputeType <DisputeCreatedTime> dateTime </DisputeCreatedTime> <DisputeCreditEligibility> DisputeCreditEligibilityCodeType </DisputeCreditEligibility> <DisputeExplanation> DisputeExplanationCodeType </DisputeExplanation> <DisputeID> DisputeIDType (string) </DisputeID> <DisputeMessage> DisputeMessageType <MessageCreationTime> dateTime </MessageCreationTime> <MessageID> int </MessageID> <MessageSource> DisputeMessageSourceCodeType </MessageSource> <MessageText> string </MessageText> </DisputeMessage> <!-- ... more DisputeMessage nodes allowed here ... --> <DisputeModifiedTime> dateTime </DisputeModifiedTime> <DisputeReason> DisputeReasonCodeType </DisputeReason> <DisputeRecordType> DisputeRecordTypeCodeType </DisputeRecordType> <DisputeResolution> DisputeResolutionType <DisputeResolutionReason> DisputeResolutionReasonCodeType </DisputeResolutionReason> <DisputeResolutionRecordType> DisputeResolutionRecordTypeCodeType </DisputeResolutionRecordType> <ResolutionTime> dateTime </ResolutionTime> </DisputeResolution> <!-- ... more DisputeResolution nodes allowed here ... --> <DisputeState> DisputeStateCodeType </DisputeState> <DisputeStatus> DisputeStatusCodeType </DisputeStatus> <Item> ItemType <ItemID> ItemIDType (string) </ItemID> </Item> <OrderLineItemID> string </OrderLineItemID> <OtherPartyName> string </OtherPartyName> <OtherPartyRole> TradingRoleCodeType </OtherPartyRole> <TransactionID> string </TransactionID> <UserRole> TradingRoleCodeType </UserRole> </Dispute> <!-- ... more Dispute nodes allowed here ... --> </DisputeArray> <DisputeFilterCount> DisputeFilterCountType <DisputeFilterType> DisputeFilterTypeCodeType </DisputeFilterType> <TotalAvailable> int </TotalAvailable> </DisputeFilterCount> <!-- ... more DisputeFilterCount nodes allowed here ... --> <EndingDisputeID> DisputeIDType (string) </EndingDisputeID> <ItemsPerPage> int </ItemsPerPage> <PageNumber> int </PageNumber> <PaginationResult> PaginationResultType <TotalNumberOfPages> int </TotalNumberOfPages> </PaginationResult> <StartingDisputeID> DisputeIDType (string) </StartingDisputeID> <!-- Standard Output Fields --> <Ack> AckCodeType </Ack> <Build> string </Build> <CorrelationID> string </CorrelationID> <Errors> ErrorType <ErrorClassification> ErrorClassificationCodeType </ErrorClassification> <ErrorCode> token </ErrorCode> <ErrorParameters ParamID="string"> ErrorParameterType <Value> string </Value> </ErrorParameters> <!-- ... more ErrorParameters nodes allowed here ... --> <LongMessage> string </LongMessage> <SeverityCode> SeverityCodeType </SeverityCode> <ShortMessage> string </ShortMessage> </Errors> <!-- ... more Errors nodes allowed here ... --> <HardExpirationWarning> string </HardExpirationWarning> <Timestamp> dateTime </Timestamp> <Version> string </Version> </GetUserDisputesResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
DisputeArray | DisputeArrayType | Always |
The array of disputes returned.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute | DisputeType | Always,
repeatable: [1..*] |
The information that describes a dispute, including the buyer's name, the transaction ID, the dispute state and status, whether the dispute is resolved, and any messages posted to the dispute.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeCreatedTime |
dateTime | Conditionally |
The date and time the dispute was created, in GMT.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeCreditEligibility |
DisputeCreditEligibilityCodeType | Conditionally |
A value to indicate whether or not the seller is currently eligible for a Final Value Fee credit. The seller becomes eligible for a Final Value Fee credit after filing and winning an Unpaid Item case. This tag only indicates credit eligibility and does not mean that the case can be closed. The seller can open an Unpaid Item case as soon as two days after the listing ends. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeExplanation |
DisputeExplanationCodeType | Conditionally |
The detailed explanation for the dispute. Valid values depend on the value of DisputeReason. See DisputeExplanationCodeList for details.
Applicable values: See DisputeExplanation. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute.DisputeID | DisputeIDType (string) | Conditionally |
The unique identifier of an eBay dispute.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeMessage |
DisputeMessageType | Conditionally,
repeatable: [0..*] |
A response or message posted to a dispute, either by an application or by a user on the eBay site.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeMessage .MessageCreationTime |
dateTime | Conditionally |
The date and time the message was created, in GMT.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeMessage.MessageID |
int | Conditionally |
An ID that uniquely identifies the message.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeMessage.MessageSource |
DisputeMessageSourceCodeType | Conditionally |
The party who posted the message: the buyer, the seller, or an eBay representative.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeMessage.MessageText |
string | Conditionally |
The text of the message.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeModifiedTime |
dateTime | Conditionally |
The date and time the dispute was modified, in GMT.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeReason |
DisputeReasonCodeType | Conditionally |
The top-level reason for the dispute. The value of DisputeReason determines which values of DisputeExplanation are valid. See DisputeExplanationCodeList for details.
Applicable values: See DisputeReason. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeRecordType |
DisputeRecordTypeCodeType | Conditionally |
A value to indicate the type of dispute.
Applicable values: Note: As noted above, the GetDispute or GetUserDisputes calls will not return any eBay Money Back Guarantee cases. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeResolution |
DisputeResolutionType | Conditionally,
repeatable: [0..*] |
The action resulting from the dispute resolution. The action might include a Final Value Fee credit to the seller, a strike to the buyer, a reversal, or an appeal.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeResolution .DisputeResolutionReason |
DisputeResolutionReasonCodeType | Conditionally |
The reason for the resolution. The DisputeResolutionReason results in the action described by the DisputeResolutionRecordType.
Applicable values: See DisputeResolutionReason. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeResolution .DisputeResolutionRecordType |
DisputeResolutionRecordTypeCodeType | Conditionally |
The action resulting from the resolution, affecting either the buyer or the seller.
Applicable values: See DisputeResolutionRecordType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeResolution .ResolutionTime |
dateTime | Conditionally |
The date and time the dispute was resolved, in GMT.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeState |
DisputeStateCodeType | Conditionally |
The internal state of the dispute. The value determines which values of DisputeActivity are valid when responding to a dispute.
Applicable values: See DisputeState. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .DisputeStatus |
DisputeStatusCodeType | Conditionally |
The status of the dispute, which provides additional information about the dispute state.
Applicable values: See DisputeStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute.Item | ItemType | Conditionally |
Container consisting of high-level details about the item involved in the dispute.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute.Item .ItemID |
ItemIDType (string) | Conditionally |
The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. Your code should be prepared to handle IDs of up to 19 digits. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .OrderLineItemID |
string | Conditionally |
OrderLineItemID is a unique identifier for an eBay order line item. In the case of GetDispute and GetUserDisputes responses, this value identifies the order line item involved in the dispute. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .OtherPartyName |
string | Conditionally |
The user name of the person involved in the dispute who is not taking action or requesting information.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .OtherPartyRole |
TradingRoleCodeType | Conditionally |
The role of the person involved in the dispute who is not taking action or requesting information. The role is either Buyer or Seller.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute .TransactionID |
string | Conditionally |
The unique identifier of the order line item (transaction) under dispute. An order line item is created once there is a commitment from a buyer to purchase an item. In the case of GetDispute and GetUserDisputes responses, this value identifies the order line item involved in the dispute. The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeArray.Dispute.UserRole | TradingRoleCodeType | Conditionally |
The role of the person involved in the dispute who is taking action or requesting information. The role is either Buyer or Seller.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeFilterCount | DisputeFilterCountType | Always,
repeatable: [1..*] |
The number of disputes that involve the requester as buyer or seller and match a given filter type.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeFilterCount .DisputeFilterType |
DisputeFilterTypeCodeType | Always |
A filter used to reduce the number of disputes returned. The filter uses criteria such as whether the dispute is awaiting a response, is closed, or is eligible for credit. Both Unpaid Item and Item Not Received disputes can be returned for the same filter value.
Applicable values: See DisputeFilterType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
DisputeFilterCount .TotalAvailable |
int | Always |
The number of disputes that match the filter. In the GetUserDisputes response, not returned for the filter type that was used in the request.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
EndingDisputeID | DisputeIDType (string) | Always |
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 200 and the second page returns an EndingDisputeID value of 228.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
ItemsPerPage | int | Always |
The number of disputes on each virtual page in the result set. The virtual page returned is determined by PageNumber. Default: 200. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
PageNumber | int | Always |
The page of the total result set returned in the call. The entire result set is virtual and the call returns only one page of it.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
PaginationResult | PaginationResultType | Always |
The result of the pagination, including the total number of virtual pages in the result set and the total number of disputes returned.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
PaginationResult .TotalNumberOfPages |
int | Always |
Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
StartingDisputeID | DisputeIDType (string) | Always |
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 1 and the second page returns a StartingDisputeID value of 201.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
Standard Output Fields |
Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.
Applicable values: (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. |
Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
CorrelationID | string | Conditionally |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request.
See Error Handling. |
Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Errors.ErrorCode | token | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. |
Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
Errors.ErrorParameters.Value | string | Conditionally | This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID. |
Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
Errors.SeverityCode | SeverityCodeType | Conditionally |
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
Applicable values: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Compatible Application Check section of the eBay Features Guide for more information. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list. |
Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. |
Input Output Samples Change History |
The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)
The none column indicates the fields that are returned when you do not specify a DetailLevel.
Y | The field is always returned. |
(Y) | The field is conditionally returned. See the field documentation for clarification of conditions. |
- | The field is not returned. |
Input Output Detail Controls Change History |
New to making API calls? Please see Making a Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
The following sample shows all disputes that the user is involved in both as a buyer and seller (whichever are applicable).
Input
The user wants to retrieved all disputes they have been, or are currently involved in, both as a buyer and/or seller. Disputes are sorted by dispute creation time in descending order (most recent returned first).
XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetUserDisputesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>ABC...123</eBayAuthToken>
</RequesterCredentials>
<WarningLevel>High</WarningLevel>
<DisputeFilterType>AllInvolvedDisputes</DisputeFilterType>
<DisputeSortType>DisputeCreatedTimeDescending</DisputeSortType>
<Pagination>
<EntriesPerPage>5</EntriesPerPage>
<PageNumber>1</PageNumber>
</Pagination>
</GetUserDisputesRequest>
Output
Two disputes are found for the user. One of the disputes is an Unpaid Item case in which the user was the buyer. In this case, the user paid for the item after the Unpaid Item case was opened, but ultimately, the item was returned for a refund, and the user did not get an Unpaid Item strike. In the other dispute, the user was the seller, and an Unpaid Item case was opened up against the buyer automatically with the Unpaid Item Assistant feature. The item was never shipped, and the case was eventually closed. The different dispute types (and applicable counts) are shown at the end of the response.
XML format.
<?xml version="1.0" encoding="UTF-8"?>
<GetUserDisputesResponse
xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-06T17:03:58.384Z</Timestamp>
<Ack>Success</Ack>
<Version>1131</Version>
<Build>E1131_UNI_API5_19098188_R1</Build>
<StartingDisputeID>1</StartingDisputeID>
<EndingDisputeID>2</EndingDisputeID>
<DisputeArray>
<Dispute>
<DisputeID>736547802</DisputeID>
<DisputeRecordType>UnpaidItem</DisputeRecordType>
<DisputeState>Closed</DisputeState>
<DisputeStatus>ClosedFVFCreditNoStrike</DisputeStatus>
<OtherPartyRole>Seller</OtherPartyRole>
<OtherPartyName>d***o</OtherPartyName>
<UserRole>Buyer</UserRole>
<TransactionID>920519077023</TransactionID>
<Item>
<ItemID>361940559220</ItemID>
<ConditionID>1000</ConditionID>
<ConditionDisplayName>New</ConditionDisplayName>
</Item>
<DisputeReason>TransactionMutuallyCanceled</DisputeReason>
<DisputeExplanation>BuyerReturnedItemForRefund</DisputeExplanation>
<DisputeCreditEligibility>InEligible</DisputeCreditEligibility>
<DisputeCreatedTime>2019-02-16T23:25:16.000Z</DisputeCreatedTime>
<DisputeModifiedTime>2019-02-24T12:02:43.000Z</DisputeModifiedTime>
<OrderLineItemID>361940559220-920519077023</OrderLineItemID>
</Dispute>
<Dispute>
<DisputeID>716406325</DisputeID>
<DisputeRecordType>UnpaidItem</DisputeRecordType>
<DisputeState>Closed</DisputeState>
<DisputeStatus>ClosedFVFCreditStrike</DisputeStatus>
<OtherPartyRole>Buyer</OtherPartyRole>
<OtherPartyName>j***4</OtherPartyName>
<UserRole>Seller</UserRole>
<TransactionID>1792239731002</TransactionID>
<Item>
<ItemID>122493085267</ItemID>
<ConditionID>1000</ConditionID>
<ConditionDisplayName>New</ConditionDisplayName>
</Item>
<DisputeReason>BuyerHasNotPaid</DisputeReason>
<DisputeExplanation>UPIAssistance</DisputeExplanation>
<DisputeCreditEligibility>InEligible</DisputeCreditEligibility>
<DisputeCreatedTime>2019-06-18T18:46:41.000Z</DisputeCreatedTime>
<DisputeModifiedTime>2019-06-22T18:47:20.000Z</DisputeModifiedTime>
<OrderLineItemID>122493085267-1792239731002</OrderLineItemID>
</Dispute>
</DisputeArray>
<ItemsPerPage>200</ItemsPerPage>
<PageNumber>1</PageNumber>
<DisputeFilterCount>
<DisputeFilterType>AllInvolvedDisputes</DisputeFilterType>
</DisputeFilterCount>
<DisputeFilterCount>
<DisputeFilterType>DisputesAwaitingMyResponse</DisputeFilterType>
<TotalAvailable>0</TotalAvailable>
</DisputeFilterCount>
<DisputeFilterCount>
<DisputeFilterType>DisputesAwaitingOtherPartyResponse</DisputeFilterType>
<TotalAvailable>0</TotalAvailable>
</DisputeFilterCount>
<DisputeFilterCount>
<DisputeFilterType>AllInvolvedClosedDisputes</DisputeFilterType>
<TotalAvailable>2</TotalAvailable>
</DisputeFilterCount>
<DisputeFilterCount>
<DisputeFilterType>EligibleForCredit</DisputeFilterType>
<TotalAvailable>0</TotalAvailable>
</DisputeFilterCount>
<DisputeFilterCount>
<DisputeFilterType>UnpaidItemDisputes</DisputeFilterType>
<TotalAvailable>2</TotalAvailable>
</DisputeFilterCount>
<DisputeFilterCount>
<DisputeFilterType>ItemNotReceivedDisputes</DisputeFilterType>
<TotalAvailable>0</TotalAvailable>
</DisputeFilterCount>
<PaginationResult>
<TotalNumberOfPages>1</TotalNumberOfPages>
</PaginationResult>
</GetUserDisputesResponse>
Input Output Detail Controls Samples |
Change Date | Description |
---|---|
813 2013-02-27 |
|
741 2011-09-28 |
|
705 2011-01-19 |
|
691 2010-10-14 |
|
657 2010-02-17 |
|
619 2009-05-27 |
|
483 2006-10-18 |
|
427 2005-09-21 |
|
Copyright © 2005–2021 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.