GetUserDisputes - Call Reference - eBay Trading Web Services

GetUserDisputes

Requests a list of disputes the requester is involved in as buyer or seller. The list includes both Unpaid Item and Item Not Received disputes and can be filtered according to DisputeFilterType. Use a DetailLevel of ReturnAll to return all data about each dispute, including DisputeResolution and DisputeMessage elements.

See:
    Unpaid Item Disputes
    Item Not Received Disputes
    Getting Details About a Dispute

GetUserDisputes Input

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

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 may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetUserDisputesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel nodes here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- 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>
</GetUserDisputesRequest>

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
DetailLevel	DetailLevelCodeType (repeatable)	Optional	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 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. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) 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 a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo 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" in the eBay Web Services Guide 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. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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., 549). 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 (XML API Only) 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 in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
DisputeFilterType	DisputeFilterTypeCodeType	Optional	A filter that specifies a subset of disputes to return. The return list includes both Item Not Received and Unpaid Item disputes. Applicable values: • AllInvolvedClosedDisputes (in/out) All disputes that involve me as buyer or seller and are closed. • AllInvolvedDisputes (in/out) All disputes that involve me as buyer or seller. • CustomCode (in/out) Reserved for future use. • DisputesAwaitingMyResponse (in/out) All disputes that involve me as buyer or seller and are awaiting my response. Default value. • DisputesAwaitingOtherPartyResponse (in/out) All disputes that involve me as buyer or seller and are awaiting the other party's response. • EligibleForCredit (in/out) All disputes that involve me as buyer or seller and are eligible for a Final Value Fee credit, whether or not the credit has been granted. • ItemNotReceivedDisputes (in/out) All Item Not Received disputes. • UnpaidItemDisputes (in/out) All Unpaid item disputes.
DisputeSortType	DisputeSortTypeCodeType	Optional	The value and sequence to use to sort the returned disputes. Applicable values: • CustomCode (in) Reserved for internal or future use. • DisputeCreatedTimeAscending (in) Sort by the time the dispute was created, in ascending order. • DisputeCreatedTimeDescending (in) Sort by the time the dispute was created, in descending order. • DisputeCreditEligibilityAscending (in) Sort by whether the dispute is eligible for Final Value Fee credit, in ascending order. Ineligible disputes are listed before eligible disputes. • DisputeCreditEligibilityDescending (in) Sort by whether the dispute is eleigible for Final Value Fee credit, in descending order. Eligible disputes are listed before i(ineligible disputes. • DisputeStatusAscending (in) Sort by the dispute status, in ascending order. • DisputeStatusDescending (in) Sort by the dispute status, in descending order. • None (in) Sort by the time the dispute was created, in descending order.
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 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	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 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	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	Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders). 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 other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com).

GetUserDisputes Output

The box below lists all fields that might be returned in the call 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 Samples.

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

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetUserDisputesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- 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 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 here ... -->
      <DisputeState> DisputeStateCodeType </DisputeState>
      <DisputeStatus> DisputeStatusCodeType </DisputeStatus>
      <Item> ItemType 
        <ItemID> ItemIDType (string) </ItemID>
      </Item>
      <OtherPartyName> string </OtherPartyName>
      <OtherPartyRole> TradingRoleCodeType </OtherPartyRole>
      <TransactionID> string </TransactionID>
      <UserRole> TradingRoleCodeType </UserRole>
    </Dispute>
    <!-- ... more Dispute nodes here ... -->
  </DisputeArray>
  <DisputeFilterCount> DisputeFilterCountType 
    <DisputeFilterType> DisputeFilterTypeCodeType </DisputeFilterType>
    <TotalAvailable> int </TotalAvailable>
  </DisputeFilterCount>
  <!-- ... more DisputeFilterCount nodes here ... -->
  <EndingDisputeID> DisputeIDType (string) </EndingDisputeID>
  <ItemsPerPage> int </ItemsPerPage>
  <PageNumber> int </PageNumber>
  <PaginationResult> PaginationResultType 
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </PaginationResult>
  <StartingDisputeID> DisputeIDType (string) </StartingDisputeID>
</GetUserDisputesResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific 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 Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
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	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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 (repeatable)	Conditionally	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: • 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.
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.
Errors.ErrorParameters	ErrorParameterType (repeatable)	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 [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
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) Application-level error • Warning (out) Warning or informational error
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 Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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 "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
DisputeArray	DisputeArrayType	Always	The array of disputes returned. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute	DisputeType (repeatable)	Always	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	Whether the dispute is currently eligible for Final Value Fee credit. The value is usually Ineligible until 7 days after the dispute was created, unless a fee exception applies. Applicable values: • CustomCode (out) Reserved for internal or future use. • Eligible (out) The seller is eligible for a credit. • InEligible (out) The seller is not currently eligible for a credit. 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: • BuyerHasNotResponded (in/out) The buyer has not responded within the 7-day waiting period. Allowed when DisputeReason is BuyerHasNotPaid. Corresponds to legacy schema value 1. • BuyerNoLongerRegistered (in/out) The buyer is no longer a registered user. Allowed when DisputeReason is BuyerHasNotPaid. Corresponds to legacy schema value 23. • BuyerNoLongerWantsItem (in/out) The buyer no longer wants the item. Allowed when DisputeReason is TransactionMutuallyCanceled. Corresponds to legacy schema value 25. • BuyerNotClearedToPay (in/out) The buyer is not cleared to pay. Allowed when DisputeReason is BuyerHasNotPaid. Corresponds to legacy schema value 24. • BuyerPurchasingMistake (in/out) The buyer made a mistake. Allowed when DisputeReason is TransactionMutuallyCanceled. Corresponds to legacy schema value 14. • BuyerRefusedToPay (in/out) The buyer has refused to pay. Allowed when DisputeReason is BuyerHasNotPaid. Corresponds to legacy schema value 2. • BuyerReturnedItemForRefund (in/out) The buyer returned the item for a refund. Allowed when DisputeReason is TransactionMutuallyCanceled. Corresponds to legacy schema value 5. • CustomCode (in/out) Reserved for internal or future use. • OtherExplanation (in/out) Some other reason not specified in this code list. Allowed when DisputeReason is either BuyerHasNotPaid OR TransactionMutuallyCanceled. Corresponds to legacy schema value 13. • PaymentMethodNotSupported (in/out) The buyer requests a payment method that the seller does not accept. Allowed when DisputeReason is BuyerHasNotPaid or TransactionMutuallyCanceled. Corresponds to legacy schema value 22. Deprecated. • ShipCountryNotSupported (in/out) The buyer requests shipment to a country that the seller does not ship to. Allowed when DisputeReason is BuyerHasNotPaid. Corresponds to legacy schema value 20. Deprecated. • ShippingAddressNotConfirmed (in/out) The buyer requests shipment to an unconfirmed address. Allowed when DisputeReason is BuyerHasNotPaid or TransactionMutuallyCanceled. Corresponds to legacy schema value 21. • UnableToResolveTerms (in/out) The buyer and seller were unable to resolve a disagreement over terms. Allowed when DisputeReason is TransactionMutuallyCanceled. Corresponds to legacy schema value 12. • Unspecified (in/out) Used when DisputeReason is ItemNotReceived or SignificantlyNotAsDescribed. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute.DisputeID	DisputeIDType (string)	Conditionally	The unique identifier of a dispute, returned by the eBay site when the dispute is created. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute .DisputeMessage	DisputeMessageType (repeatable)	Conditionally	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: • Buyer (out) The buyer of the item under dispute. • CustomCode (out) Reserved for internal or future use. • eBay (out) eBay, either an administrator or the site itself. • Seller (out) The seller of the item under dispute. 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: • BuyerHasNotPaid (in/out) The buyer has not paid for the item. For Unpaid Item Process disputes. Corresponds to legacy schema value 1. • CustomCode (in/out) Reserved for future use. • ItemNotReceived (in/out) The buyer did not receive the item. For Item Not Received disputes. • NoRefund (in/out) The item was returned but no refund was given. • ReturnPolicyUnpaidItem (in/out) Item was returned and seller was not paid. • SignificantlyNotAsDescribed (in/out) An option for Item Not Received disputes. • TransactionMutuallyCanceled (in/out) The seller claims that the buyer agrees to not complete the transaction. This triggers a waiting period for buyer agreement, disagreement or no buyer response. For Unpaid Item Process disputes. Corresponds to legacy schema value 2. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute .DisputeRecordType	DisputeRecordTypeCodeType	Conditionally	The type of dispute. Applicable values: • CustomCode (out) Reserved for internal or future use. • ItemNotReceived (out) An Item Not Received dispute. • UnpaidItem (out) An Unpaid Item dispute. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute .DisputeResolution	DisputeResolutionType (repeatable)	Conditionally	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: • BuyerPaidAuctionFees (in/out) The buyer reimbursed the seller's auction fees. • CameToAgreement (in/out) The buyer and seller came to agreement. • ClaimPaid (in/out) After eBay approved payment of the claim, the claim was paid. • ComputerTechnicalProblem (in/out) The buyer or seller had a technical problem with a computer. • CustomCode (in/out) Reserved for future use. • FamilyEmergency (in/out) The buyer or seller had a family emergency. • FirstInfraction (in/out) The dispute was the buyer's first infraction. • ItemReturned (in/out) The buyer returned the item. • NoContact (in/out) The buyer and seller have not made contact. • OtherResolution (in/out) Some other resolution occurred. • ProofGivenInFeedback (in/out) The buyer provided proof of payment in feedback. • ProofOfPayment (in/out) The buyer provided proof of payment in feedback. • SellerReceivedPayment (in/out) The seller received payment. • Unresolved (in/out) The dispute was not resolved. 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: • AppealBuyerStrike (out) The buyer's unpaid item strike was appealed. • CustomCode (out) Reserved for internal or future use. • FVFCredit (out) The seller received a Final Value Fee credit. • FVFCreditNotGranted (out) The seller did not receive a Final Value Fee credit. • GenerateCSTicketForSuspend (out) The buyer is given a ticket. • InsertionFeeCredit (out) The seller's listing fee was credited. • ItemNotReceivedClaimFiled (out) The buyer did not received the item, and the buyer filed a claim. • ReverseFVFCredit (out) The seller's Final Value Fee credit was reversed. • ReverseInsertionFeeCredit (out) The seller's listing fee was reversed. • StrikeBuyer (out) The buyer received an Unpaid Item Strike. • SuspendBuyer (out) The buyer is suspended and unable to use the eBay site. • UnsuspendBuyer (out) The buyer's suspension was reversed. 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. 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: • ClaimApproved (out) Claim approved for reimbursement, sent to Account's payable for payment • ClaimClosed (out) Buyer did not respond to verification or missing some paperwork • ClaimDenied (out) Not eligible for reimbursement • ClaimInProcess (out) Paperwork received, claim being investigated • ClaimOpened (out) Claim assigned to an adjuster • ClaimPaid (out) Reimbursement completed • ClaimResolved (out) Issue resolved: seller sent Item or Refund • ClaimSubmitted (out) Claim Submitted via Web flow • Closed (out) The dispute is closed. For Item Not Received disputes. • ClosedFVFCreditNoStrike (out) The dispute is closed, the seller received a Final Value Fee credit, and the buyer did not receive a strike. For Unpaid Item disputes. • ClosedFVFCreditStrike (out) The dispute is closed, the seller received a Final Value Fee credit, and the buyer received a strike. For Unpaid Item disputes. • ClosedNoFVFCreditNoStrike (out) The dispute is closed, the seller did not receive a Final Value Fee credit, and the buyer did not receive a strike. For Unpaid Item disputes. • ClosedNoFVFCreditStrike (out) The dispute is closed, the seller did not receive a Final Value Fee credit, and the buyer received a strike. For Unpaid Item disputes. • CustomCode (out) Reserved for internal or future use. • FVFCreditReversedAfterClosing (out) The seller's Final Value Fee credit was reversed after the dispute was closed. For Unpaid Item disputes. • NoDocumentation (out) Buyer contacted and asked to submit paperwork • StrikeAppealedAfterClosing (out) The buyer's strike was appealed after the dispute was closed. For Unpaid Item disputes. • StrikeAppealedAndFVFCreditReversed (out) Both the seller's Final Value Fee credit and the buyer's strike were reversed after the dispute was closed. For Unpaid Item disputes. • WaitingForBuyerResponse (out) The dispute is waiting for the buyer's response. For both Unpaid Item and Item Not Received disputes. • WaitingForSellerResponse (out) The dispute is waiting for the seller's response. For both Unpaid Item and Item Not Received disputes. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute.Item	ItemType	Conditionally	Information about the item that spawned the transaction. The transaction is a purchase from this item's listing. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute.Item .ItemID	ItemIDType (string)	Conditionally	The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResultsExpress, always returned when ItemArray.Item is returned. For GetCart/SetCart input, this is only required if the parent container is submitted. Max length: 19. (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits.). 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. The role is either Buyer or Seller. 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: • Buyer (in/out) Acting as buyer. • CustomCode (in/out) Reserved for future use. • Seller (in/out) Acting as seller. For GetOrders, you can use this value to limit orders to those where the calling user is the seller. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeArray.Dispute .TransactionID	string	Conditionally	The unique identifier of the transaction under dispute. The transaction is created when the winning bidder commits to purchasing the item but before the bidder pays. Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.). 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: • Buyer (in/out) Acting as buyer. • CustomCode (in/out) Reserved for future use. • Seller (in/out) Acting as seller. For GetOrders, you can use this value to limit orders to those where the calling user is the seller. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input.
DisputeFilterCount	DisputeFilterCountType (repeatable)	Always	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: • AllInvolvedClosedDisputes (in/out) All disputes that involve me as buyer or seller and are closed. • AllInvolvedDisputes (in/out) All disputes that involve me as buyer or seller. • CustomCode (in/out) Reserved for future use. • DisputesAwaitingMyResponse (in/out) All disputes that involve me as buyer or seller and are awaiting my response. Default value. • DisputesAwaitingOtherPartyResponse (in/out) All disputes that involve me as buyer or seller and are awaiting the other party's response. • EligibleForCredit (in/out) All disputes that involve me as buyer or seller and are eligible for a Final Value Fee credit, whether or not the credit has been granted. • ItemNotReceivedDisputes (in/out) All Item Not Received disputes. • UnpaidItemDisputes (in/out) All Unpaid item disputes. 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 is 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. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). 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.

GetUserDisputes Detail Controls

Detail Control: DetailLevel

The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)

none	The field is returned if DetailLevel is not specified on input.
Y	The field is always returned.
(Y)	The field is conditionally returned. See the field description for clarification of conditions.

Output Field	ReturnAll	ReturnSummary	none
DisputeArray	Y	Y	Y
DisputeArray.Dispute	Y	Y	Y
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.OtherPartyName	(Y)	(Y)	(Y)
DisputeArray.Dispute.OtherPartyRole	(Y)	(Y)	(Y)
DisputeArray.Dispute.TransactionID	(Y)	(Y)	(Y)
DisputeArray.Dispute.UserRole	(Y)	(Y)	(Y)
DisputeFilterCount	Y	Y	Y
DisputeFilterCount.DisputeFilterType	Y	Y	Y
DisputeFilterCount.TotalAvailable	Y	Y	Y
EndingDisputeID	Y	Y	Y
ItemsPerPage	Y	Y	Y
PageNumber	Y	Y	Y
PaginationResult	Y	Y	Y
PaginationResult.TotalNumberOfPages	Y	Y	Y
StartingDisputeID	Y	Y	Y

GetUserDisputes Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetUserDisputes.

GetUserDisputes Change History

Version	Description
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.

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Trading API Call Reference Version 579

eBay Trading API
Call Reference Version 579