eBay Trading APIVersion 1257
 

GetUserDisputes

Use this call to retrieve a list of Unpaid Item cases that the user is involved in as a buyer or seller.

Note: This call no longer supports Item not Received (INR) or Significantly not as Described (SNAD) disputes created through PayPal, since this is no longer an option for eBay buyers. eBay buyers must create an INR or SNAD case through eBay's Resolution Center, and this call also does not support eBay Money Back Guarantee cases.

To respond to an eBay Money Back Guarantee case, the seller should use the Case Management calls of the Post-Order API or manage/respond to cases manually through the eBay Resolution Center.

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 the DisputeResolution and DisputeMessage containers.

The GetUserDisputes response might contain a large number of records, as the maximum number of records returned per page is 200. Pagination fields, filters, and sorting can be used to control the number of cases returned per page, and which page to return from the result set.

If you know the DisputeID value of specific case, you can use the GetDispute call to retrieve information only on the specified case.

The response from GetUserDisputes contains each case that involves the user as a buyer or seller, and that matches any filtering criteria that may have been used. Within each Dispute record, you can parse for information such as DisputeID, DisputeRecord, DisputeState, DisputeStatus, DisputeReason, and DisputeExplanation.

See Unpaid Item Cases.

See also the reference documentation for these calls:



Input

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 Unpaid Item cases.

Applicable values: See DisputeFilterType.
DisputeSortType DisputeSortTypeCodeType Optional One of the values defined in DisputeSortTypeCodeType is used here to control the order of cases that are returned.
Default: None.

Applicable values: See DisputeSortType.
ModTimeFrom dateTime Optional 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.
ModTimeTo dateTime Optional 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.
Pagination PaginationType Required 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.
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.

Min: 0. Default: 0.
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:

ReturnAll
(in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.
ReturnSummary
(in) Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See GetMyMessages for a code sample that demonstrates this.

(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.

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States
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:
  • It indicates the version of the code lists and other data that eBay should use to process your request.
  • It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.
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:
    HTTP Headers
    eBay Schema Versioning Strategy
    Lowest Supported Version

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
(in) The WarningLevel value is set to 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
(in) The WarningLevel value is set to 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.



Output

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 that match the input criteria in the request. It will be returned as empty if no disputes match the input criteria.

DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute DisputeType Always,
repeatable: [1..*]
This container consists of detailed information on each Unpaid Item case that matches the input criteria.

DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute
  .DisputeCreatedTime
dateTime Conditionally The date and time the Unpaid Item case 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:

CustomCode
(out) Reserved for internal or future use.
Eligible
(out) This value indicates that the seller is currently eligible for a Final Value Fee credit towards the order line item under dispute.
InEligible
(out) This value indicates that the seller is not currently eligible for a Final Value Fee credit towards the order line item under dispute.

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 This enumeration value provides more details about why the Unpaid Item case was created. See DisputeExplanationCodeList type for explanation of values.

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 Unpaid Item case.

DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute
  .DisputeMessage
DisputeMessageType Conditionally,
repeatable: [0..*]
This field will contain a response or message related to the Unpaid Item case, posted by either the buyer or the seller.

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:

Buyer
(out) The buyer involved in the Unpaid Item case.
CustomCode
(out) Reserved for internal or future use.
eBay
(out) eBay, either an administrator or the site itself.
Seller
(out) The seller involved in the Unpaid Item case.

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 Unpaid Item case was last modified, in GMT.

DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute
  .DisputeReason
DisputeReasonCodeType Conditionally The reason for the Unpaid Item case. Since GetDispute and GetUserDisputes calls now only retrieve Unpaid Item cases, this value should always be BuyerHasNotPaid.

Applicable values:

BuyerHasNotPaid
(in/out) The seller has opened an Unpaid Item case against the buyer because the buyer has not paid for the order line item. A seller can open an Unpaid Item case as early as four days after the buyer commits to purchasing the item.
CustomCode
(in/out) Reserved for future or internal use.
ReturnPolicyUnpaidItem
(in/out) Item was returned and seller was not paid. This value cannot be used in AddDispute.
TransactionMutuallyCanceled
(in/out) This value indicates that the seller cancelled an order after getting mutual consent from the buyer. This may be due to the buyer requesting that it be cancelled, or it could be that the seller ran out of stock on the item.

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.

Note: The GetDispute and GetUserDisputes calls now only retrieve Unpaid Item cases, so the enumeration value returned here should always be UnpaidItem.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
UnpaidItem
(out) This enumeration value indicates that the dispute is an Unpaid Item case created by the seller against the buyer. A seller should always try to resolve an Unpaid Item issue with the buyer before opening up a case with eBay. Sometimes, just sending payment reminders to the buyer or messaging the buyer through the Messaging platform can be helpful. The Resolving unpaid items with buyers help topic provides more details and tips on trying to work Unpaid Item issues out with the buyer.

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..*]
This container provides more details about the results of an Unpaid Item case once it is resolved. Results could possibly include a Final Value Fee credit to the seller and an Unpaid Item strike to the buyer. This container will only be returned after the Unpaid Item case is resolved.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute
  .DisputeResolution
  .DisputeResolutionReason
DisputeResolutionReasonCodeType Conditionally The reason for the resolution.

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 of the outcome that resulted from the resolution of the Unpaid Item case, in GMT.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute
  .DisputeState
DisputeStateCodeType Conditionally The state of the dispute. The value determines which values of DisputeActivity are valid when responding to an Unpaid Item case with an AddDisputeResponse.

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 Unpaid Item case.

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 The unique identifier of the order line item with an Unpaid Item case filed against it.


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 Unpaid Item case 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 Unpaid Item case who is not taking action or requesting information. The role is either Buyer or Seller.

Applicable values:

Buyer
(in/out) The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order.
CustomCode
(in/out) This value is reserved for future or internal use.
Seller
(in/out) The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order.

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 sales transaction with an Unpaid Item case filed against it.

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 Unpaid Item case who is taking action or requesting information. The role is either Buyer or Seller.

Applicable values:

Buyer
(in/out) The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order.
CustomCode
(in/out) This value is reserved for future or internal use.
Seller
(in/out) The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order.

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..*]
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.

DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeFilterCount
  .DisputeFilterType
DisputeFilterTypeCodeType Always The enumeration value returned here indicates the type/category of the dispute for which a count is being shown. For example, disputes awaiting a response, closed disputes, disputes eligible for Final Value Fee credit, etc.

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 Conditionally This integer value indicates the number of disputes that match the input criteria for the corresponding type/category of dispute.

Note that this field will not be returned for the type/category of dispute that was used as a filter in the DisputeFilterType field of the request, or if this filter is not used at all, this field (with the count) will not be returned for DisputesAwaitingMyResponse, which is the default value.

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 199 (since a zero-based index is used) and the second page returns an EndingDisputeID value of 227.

DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
ItemsPerPage int Always 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.

DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
PageNumber int Always 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.

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 records 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 0 (since a zero-based index is used) and the second page returns a StartingDisputeID value of 200.

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:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(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.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

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:

CustomCode
(out) Reserved for internal or future use.
Error
(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


See the Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

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.



Detail Controls


DetailLevel

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.

YThe field is always returned.
(Y)The field is conditionally returned. See the field documentation for clarification of conditions.
-The field is not returned.

Output Field none ReturnAll ReturnSummary
DisputeArrayYYY
DisputeArray.DisputeYYY
DisputeArray.Dispute.DisputeCreatedTime(Y)(Y)(Y)
DisputeArray.Dispute.DisputeCreditEligibility(Y)(Y)(Y)
DisputeArray.Dispute.DisputeExplanation(Y)(Y)(Y)
DisputeArray.Dispute.DisputeID(Y)(Y)(Y)
DisputeArray.Dispute.DisputeMessage(Y)(Y)-
DisputeArray.Dispute.DisputeMessage.MessageCreationTime(Y)(Y)-
DisputeArray.Dispute.DisputeMessage.MessageID(Y)(Y)-
DisputeArray.Dispute.DisputeMessage.MessageSource(Y)(Y)-
DisputeArray.Dispute.DisputeMessage.MessageText(Y)(Y)-
DisputeArray.Dispute.DisputeModifiedTime(Y)(Y)(Y)
DisputeArray.Dispute.DisputeReason(Y)(Y)(Y)
DisputeArray.Dispute.DisputeRecordType(Y)(Y)(Y)
DisputeArray.Dispute.DisputeResolution(Y)(Y)-
DisputeArray.Dispute.DisputeResolution.DisputeResolutionReason(Y)(Y)-
DisputeArray.Dispute.DisputeResolution
  .DisputeResolutionRecordType
(Y)(Y)-
DisputeArray.Dispute.DisputeResolution.ResolutionTime(Y)(Y)-
DisputeArray.Dispute.DisputeState(Y)(Y)(Y)
DisputeArray.Dispute.DisputeStatus(Y)(Y)(Y)
DisputeArray.Dispute.Item(Y)(Y)(Y)
DisputeArray.Dispute.Item.ItemID(Y)(Y)(Y)
DisputeArray.Dispute.OrderLineItemID(Y)(Y)(Y)
DisputeArray.Dispute.OtherPartyName(Y)(Y)(Y)
DisputeArray.Dispute.OtherPartyRole(Y)(Y)(Y)
DisputeArray.Dispute.TransactionID(Y)(Y)(Y)
DisputeArray.Dispute.UserRole(Y)(Y)(Y)
DisputeFilterCountYYY
DisputeFilterCount.DisputeFilterTypeYYY
DisputeFilterCount.TotalAvailable(Y)(Y)(Y)
EndingDisputeIDYYY
ItemsPerPageYYY
PageNumberYYY
PaginationResultYYY
PaginationResult.TotalNumberOfPagesYYY
StartingDisputeIDYYY



Samples

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.

Sample: Basic Call

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>A*******3</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>*</EndingDisputeID>
  <DisputeArray>
    <Dispute>
      <DisputeID>7*******2</DisputeID>
      <DisputeRecordType>UnpaidItem</DisputeRecordType>
      <DisputeState>Closed</DisputeState>
      <DisputeStatus>ClosedFVFCreditNoStrike</DisputeStatus>
      <OtherPartyRole>Seller</OtherPartyRole>
      <OtherPartyName>d***o</OtherPartyName>
      <UserRole>Buyer</UserRole>
      <TransactionID>9**********3</TransactionID>
      <Item>
        <ItemID>3**********0</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>3**********0-9***********3</OrderLineItemID>
    </Dispute>
    <Dispute>
      <DisputeID>7*******5</DisputeID>
      <DisputeRecordType>UnpaidItem</DisputeRecordType>
      <DisputeState>Closed</DisputeState>
      <DisputeStatus>ClosedFVFCreditStrike</DisputeStatus>
      <OtherPartyRole>Buyer</OtherPartyRole>
      <OtherPartyName>j***4</OtherPartyName>
      <UserRole>Seller</UserRole>
      <TransactionID>1***********2</TransactionID>
      <Item>
        <ItemID>1**********7</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>1**********7-1***********2</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>



Change History

Change Date Description
813
2013-02-27
  • DisputeReasonCodeType (modified): Updated the description of the BuyerHasNotPaid value to reflect the fact that sellers may now open an Unpaid Item case just two days after the end of the listing instead of four days.
741
2011-09-28
  • DisputeExplanation.SellerRanOutOfStock (added): New dispute explanation that can be used by the seller when cancelling an order due to an item being out of stock.
705
2011-01-19
  • OrderLineItemID (modified): The OrderLineItemID value is now returned in Production under each Dispute node in the response.
691
2010-10-14
  • OrderLineItemID (added): A unique identifier for an eBay transaction, which is based upon the concatenation of ItemID and TransactionID with a hyphen in between these two IDs. OrderLineItemID is only returned if you set your request version to 705.
657
2010-02-17
  • (doc change) System announcement: Disputes created by buyers via the eBay Dispute Resolution for Buyer Claims process are not returned in the GetUserDisputes response. Sellers must use the Dispute Resolution Center to handle these particular disputes.
619
2009-05-27
  • DisputeResolutionRecordTypeCodeType.FeatureFeeCredit, DisputeResolutionRecordTypeCodeType.FeatureFeeNotCredit,and DisputeResolutionRecordTypeCodeType.ReverseFeatureFeeCredit. (added): Now Power Sellers can receive a refund or credit of their Final Value Fee as part of the resolution of a dispute. The FVF is known as the Feature Fee when it is refunded. Developers can use the GetDisputes or GetUserDisputes calls to determine if a refund or credit has been granted. If so, these new fields will be returned in the response.
483
2006-10-18
  • DisputeReasonCodeType, DisputeResolutionReasonCodeType, DisputeResolutionRecordTypeCodeType, DisputeStateCodeType (modified): Enumerations were added to these types to reflect additional states a claim can be in. This enables eBay Customer Service to keep buyers better informed of the current state of claims via the eBay Web site and via GetDispute and GetUserDisputes.
427
2005-09-21
  • DisputeFilterType (modified): Filter by Unpaid Item or Item Not Received disputes.
  • ModTimeFrom (added): Date range filter to retrieve disputes by modified time.
  • ModTimeTo (added): Date range filter to retrieve disputes by modified time.