GetDispute

Use this call to retrieve the details and status of a case. The user making this call must be either the seller or buyer involved in this case.

Note: This call is deprecated and is scheduled for decommission on January 31, 2023. The alternative API to retrieve a specific cancellation request is the Get Cancellation method of the Post-Order API .

Input

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"?>
<GetDisputeResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <Dispute> DisputeType
    <BuyerUserID> UserIDType (string) </BuyerUserID>
    <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>
    <DisputeState> DisputeStateCodeType </DisputeState>
    <DisputeStatus> DisputeStatusCodeType </DisputeStatus>
    <Escalation> boolean </Escalation>
    <Item> ItemType
      <ItemID> ItemIDType (string) </ItemID>
      <ListingDetails> ListingDetailsType
        <EndTime> dateTime </EndTime>
        <StartTime> dateTime </StartTime>
      </ListingDetails>
      <Quantity> int </Quantity>
      <SellingStatus> SellingStatusType
        <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
        <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
      </SellingStatus>
      <Site> SiteCodeType </Site>
      <Title> string </Title>
    </Item>
    <OrderLineItemID> string </OrderLineItemID>
    <PurchaseProtection> boolean </PurchaseProtection>
    <SellerUserID> UserIDType (string) </SellerUserID>
    <TransactionID> string </TransactionID>
  </Dispute>
  <!-- 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>
</GetDisputeResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

Dispute	DisputeType	Always	Deprecated as of version 1275. No longer recommended. If the Unpaid Item case that is specified in the call request is found, this Dispute container is returned in the response. This container includes detailed information about the Unpaid Item case, the buyer and seller user IDs, and information on the listing that is associated with the dispute. Deprecation version: 1275. See also Deprecated Objects.
Dispute.BuyerUserID	UserIDType (string)	Always	Deprecated as of version 1275. No longer recommended. The eBay user ID of the buyer involved in the Unpaid Item case. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeCreatedTime	dateTime	Always	Deprecated as of version 1275. No longer recommended. The date and time the Unpaid Item case was created, in GMT. Deprecation version: 1275. See also Deprecated Objects.
Dispute .DisputeCreditEligibility	DisputeCreditEligibilityCodeType	Always	Deprecated as of version 1275. No longer recommended. 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. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeExplanation	DisputeExplanationCodeType	Always	Deprecated as of version 1275. No longer recommended. 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. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeID	DisputeIDType (string)	Always	Deprecated as of version 1275. No longer recommended. The unique identifier of an Unpaid Item case. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeMessage	DisputeMessageType	Always, repeatable: [1..*]	Deprecated as of version 1275. No longer recommended. This field will contain a response or message related to the Unpaid Item case, posted by either the buyer or the seller. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeMessage .MessageCreationTime	dateTime	Always	Deprecated as of version 1275. The date and time the message was created, in GMT. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeMessage .MessageID	int	Always	Deprecated as of version 1275. No longer recommended. An ID that uniquely identifies the message. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeMessage .MessageSource	DisputeMessageSourceCodeType	Always	Deprecated as of version 1275. 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. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeMessage .MessageText	string	Always	Deprecated as of version 1275. The text of the message. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeModifiedTime	dateTime	Always	Deprecated as of version 1275. No longer recommended. The date and time the Unpaid Item case was last modified, in GMT. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeReason	DisputeReasonCodeType	Always	Deprecated as of version 1275. No longer recommended. 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. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeRecordType	DisputeRecordTypeCodeType	Always	Deprecated as of version 1275. No longer recommended. 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. Code so that your app gracefully handles any future changes to this list. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeState	DisputeStateCodeType	Always	Deprecated as of version 1275. No longer recommended. 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. Deprecation version: 1275. See also Deprecated Objects.
Dispute.DisputeStatus	DisputeStatusCodeType	Always	Deprecated as of version 1275. No longer recommended. 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. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Escalation	boolean	Always	Deprecated as of version 1275. No longer recommended. This field is returned as `true` if the buyer is eligible to appeal a closed Unpaid Item case. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item	ItemType	Always	Deprecated as of version 1275. No longer recommended. Container consisting of high-level details about the item involved in the Unpaid Item case. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.ItemID	ItemIDType (string)	Always	Deprecated as of version 1275. 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. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.ListingDetails	ListingDetailsType	Always	Deprecated as of version 1275. Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.ListingDetails .EndTime	dateTime	Always	Deprecated as of version 1275. Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration ) or the actual end time if the item has ended. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.ListingDetails .StartTime	dateTime	Always	Deprecated as of version 1275. The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.Quantity	int	Always	Deprecated as of version 1275. For AddItem family of calls: The Quantity value for auction listings must always be `1`. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations. For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be `1`. For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was `10`, and three items have been sold, eBay sets the relisted item's Quantity to `10` by default, and not `7`. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests. When eBay auto-renews a GTC listing (ListingDuration = GTC) on your behalf, eBay relists with correct quantity available. For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. For order line item calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.SellingStatus	SellingStatusType	Always	Deprecated as of version 1275. Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.SellingStatus .ConvertedCurrentPrice	AmountType (double)	Conditionally	Deprecated as of version 1275. Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ]	CurrencyCodeType	Always	Deprecated as of version 1275. Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType.
Dispute.Item.SellingStatus .CurrentPrice	AmountType (double)	Always	Deprecated as of version 1275. The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.SellingStatus .CurrentPrice [ attribute currencyID ]	CurrencyCodeType	Always	Deprecated as of version 1275. The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType.
Dispute.Item.Site	SiteCodeType	Always	Deprecated as of version 1275. The name of the eBay listing site. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing. When you specify Item.Site in AddItem or AddFixedPriceItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY-API-SITEID header (for the XML API). Applicable values: See Site. Code so that your app gracefully handles any future changes to this list. Deprecation version: 1275. See also Deprecated Objects.
Dispute.Item.Title	string	Always	Deprecated as of version 1275. This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours. Max length: 80. Deprecation version: 1275. See also Deprecated Objects.
Dispute.OrderLineItemID	string	Always	Deprecated as of version 1275. No longer recommended. The unique identifier of the order line item with an Unpaid Item case filed against it. Deprecation version: 1275. See also Deprecated Objects.
Dispute.PurchaseProtection	boolean	Always	Deprecated as of version 1275. No longer recommended. This field is no longer applicable, and if it is returned, it can be ignored. Deprecation version: 1275. See also Deprecated Objects.
Dispute.SellerUserID	UserIDType (string)	Always	Deprecated as of version 1275. No longer recommended. The eBay user ID of the seller involved in the Unpaid Item case. Deprecation version: 1275. See also Deprecated Objects.
Dispute.TransactionID	string	Always	Deprecated as of version 1275. No longer recommended. 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. Deprecation version: 1275. See also Deprecated Objects.

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

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

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

Retrieves data for an Unpaid Item dispute.

Description

The requester is the seller involved in this dispute, and he is looking for information on the unpaid item.

Input

For input, the seller provides the DisputeID for the dispute.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetDisputeRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <DisputeID>2****3</DisputeID>
</GetDisputeRequest>

Output

The response describes the Unpaid Item dispute. Note that the value of DisputeRecordType is UnpaidItem.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetDisputeResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-04T20:34:16.908Z</Timestamp>
  <Ack>Success</Ack>
  <CorrelationID>
    00000000-00000000-00000000-00000000-00000000-00000000-0000000000
  </CorrelationID>
  <Version>1131</Version>
  <Build>E1131_UNI_API5_19098188_R1</Build>
  <Dispute>
    <DisputeID>2****3</DisputeID>
    <DisputeRecordType>UnpaidItem</DisputeRecordType>
    <DisputeState>BuyerFirstResponsePayOption</DisputeState>
    <DisputeStatus>WaitingForBuyerResponse</DisputeStatus>
    <BuyerUserID>s**********r</BuyerUserID>
    <SellerUserID>s**********r</SellerUserID>
    <TransactionID>7****0</TransactionID>
    <Item> 
      <ItemID>1********6</ItemID>
      <ListingDetails>
        <StartTime>2019-10-08T02:37:07.000Z</StartTime>
        <EndTime>2019-10-08T02:39:43.000Z</EndTime>
      </ListingDetails>
      <Quantity>1</Quantity>
      <SellingStatus>
        <ConvertedCurrentPrice currencyID="USD">199.0</ConvertedCurrentPrice>
        <CurrentPrice currencyID="USD">199.0</CurrentPrice>
      </SellingStatus>
      <Site>US</Site>
      <Title>Antique Silver Candelabra</Title>
    </Item>
    <DisputeReason>BuyerHasNotPaid</DisputeReason>
    <DisputeExplanation>BuyerHasNotResponded</DisputeExplanation>
    <DisputeCreditEligibility>InEligible</DisputeCreditEligibility>
    <DisputeCreatedTime>2016-03-10T02:50:37.000Z</DisputeCreatedTime>
    <DisputeModifiedTime>2016-03-10T18:11:46.000Z</DisputeModifiedTime>
    <DisputeMessage>
      <MessageID>4****0</MessageID>
      <MessageSource>eBay</MessageSource>
      <MessageCreationTime>2019-10-10T02:50:40.000Z</MessageCreationTime>
      <MessageText>
        An Unpaid Item dispute has been opened for the following item:
        Antique Silver Candelabra (#9202501086)
        Reason given for Unpaid Item: The buyer has not paid for the item.
        Buyer actions reported by seller: The buyer has not responded.
      </MessageText>
    </DisputeMessage>
    <DisputeMessage>
      <MessageID>4****9</MessageID>
      <MessageSource>Seller</MessageSource>
      <MessageCreationTime>2019-10-10T18:11:02.000Z</MessageCreationTime>
      <MessageText>No response from the buyer in 10 days</MessageText>
    </DisputeMessage>
    <DisputeMessage> 
      <MessageID>4****0</MessageID>
      <MessageSource>Seller</MessageSource>
      <MessageCreationTime>2019-10-10T18:11:29.000Z</MessageCreationTime>
      <MessageText>Still attempting to contact the buyer</MessageText>
    </DisputeMessage>
    <DisputeMessage>
      <MessageID>4****1</MessageID>
      <MessageSource>Seller</MessageSource>
      <MessageCreationTime>2019-10-10T18:11:46.000Z</MessageCreationTime>
      <MessageText>Last attempt to contact the buyer</MessageText>
    </DisputeMessage>
    <Escalation>false</Escalation>
    <PurchaseProtection>false</PurchaseProtection>
  </Dispute>
</GetDisputeResponse>

Change History

Change Date	Description
897 2014-10-21	SiteCodeType (modified): 'Russia' added as enumeration value to support selling on the new Russia site.
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 for an order line item is now returned in Production.
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.
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.
425 2005-09-07	(added) GetDispute response data now available as a notification. See "INR (ItemNotReceived) Notifications" for information on the new notification.