GetDispute - Call Reference - eBay Trading API

GetDispute

Requests the details of a dispute corresponding to the given dispute ID, any time after the dispute was opened and up to five years after it was closed. Can be used with Unpaid Item or Item Not Received disputes.

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

GetDispute 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 not returned (or soon will not be returned) or are not operational (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"?>
<GetDisputeResponse 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 -->
  <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 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> AmountType (double) </ConvertedCurrentPrice>
        <CurrentPrice> AmountType (double) </CurrentPrice>
      </SellingStatus>
      <Site> SiteCodeType </Site>
      <Title> string </Title>
    </Item>
    <PurchaseProtection> boolean </PurchaseProtection>
    <SellerUserID> UserIDType (string) </SellerUserID>
    <TransactionID> string </TransactionID>
  </Dispute>
</GetDisputeResponse>

Return Value	Type	Occurrence	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	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • 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. 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	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
Dispute	DisputeType	Always	The dispute record, containing information about the buyer, seller, dispute state, dispute status, comments added to the dispute, or resolutions.
Dispute.BuyerUserID	UserIDType (string)	Always	The eBay user ID of the buyer involved in the dispute.
Dispute.DisputeCreatedTime	dateTime	Always	The date and time the dispute was created, in GMT.
Dispute .DisputeCreditEligibility	DisputeCreditEligibilityCodeType	Always	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.
Dispute.DisputeExplanation	DisputeExplanationCodeType	Always	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. • BuyerNoLongerRegistered (in/out) The buyer is no longer a registered user. Allowed when DisputeReason is BuyerHasNotPaid. • BuyerNoLongerWantsItem (in/out) The buyer no longer wants the item. Allowed when DisputeReason is TransactionMutuallyCanceled. • BuyerNotClearedToPay (in/out) The buyer is not cleared to pay. Allowed when DisputeReason is BuyerHasNotPaid. • BuyerNotPaid (in/out) Buyer has not paid for the item. • BuyerPaymentNotReceivedOrCleared (in/out) Payment was not received or didn't clear. • BuyerPurchasingMistake (in/out) The buyer made a mistake. Allowed when DisputeReason is TransactionMutuallyCanceled. • BuyerRefusedToPay (in/out) The buyer has refused to pay. Allowed when DisputeReason is BuyerHasNotPaid. • BuyerReturnedItemForRefund (in/out) The buyer returned the item for a refund. Allowed when DisputeReason is TransactionMutuallyCanceled. • 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. • PaymentMethodNotSupported (in/out) The buyer requests a payment method that the seller does not accept. Allowed when DisputeReason is BuyerHasNotPaid or TransactionMutuallyCanceled. Deprecated. • SellerDoesntShipToCountry (in/out) Seller doesn't ship to the country requested by buyer. • ShipCountryNotSupported (in/out) The buyer requests shipment to a country that the seller does not ship to. Allowed when DisputeReason is BuyerHasNotPaid. Deprecated. • ShippingAddressNotConfirmed (in/out) The buyer requests shipment to an unconfirmed address. Allowed when DisputeReason is BuyerHasNotPaid or TransactionMutuallyCanceled. • UnableToResolveTerms (in/out) The buyer and seller were unable to resolve a disagreement over terms. Allowed when DisputeReason is TransactionMutuallyCanceled. • Unspecified (in/out) Used when DisputeReason is ItemNotReceived or SignificantlyNotAsDescribed. • UPIAssistance (in/out) Dispute opened by Unpaid Item Assistance • UPIAssistanceDisabled (in/out) Unpaid Item Assistance is disabled.
Dispute.DisputeID	DisputeIDType (string)	Always	The unique identifier of a dispute, returned by the eBay site when the dispute is created.
Dispute.DisputeMessage	DisputeMessageType	Always, repeatable: [1..*]	A response or message posted to a dispute, either by an application or by a user on the eBay site.
Dispute.DisputeMessage .MessageCreationTime	dateTime	Always	The date and time the message was created, in GMT.
Dispute.DisputeMessage .MessageID	int	Always	An ID that uniquely identifies the message.
Dispute.DisputeMessage .MessageSource	DisputeMessageSourceCodeType	Always	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.
Dispute.DisputeMessage .MessageText	string	Always	The text of the message.
Dispute.DisputeModifiedTime	dateTime	Always	The date and time the dispute was modified, in GMT.
Dispute.DisputeReason	DisputeReasonCodeType	Always	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.
Dispute.DisputeRecordType	DisputeRecordTypeCodeType	Always	The type of dispute. Applicable values: • CustomCode (out) Reserved for internal or future use. • HalfDispute (out) One type come from Half.com. • ItemNotReceived (out) An Item Not Received dispute. • UnpaidItem (out) An Unpaid Item dispute.
Dispute.DisputeState	DisputeStateCodeType	Always	The internal state of the dispute. The value determines which values of DisputeActivity are valid when responding to a dispute. Applicable values: See DisputeState.
Dispute.DisputeStatus	DisputeStatusCodeType	Always	The status of the dispute, which provides additional information about the dispute state. Applicable values: See DisputeStatus.
Dispute.Escalation	boolean	Always	Whether the buyer can close a dispute unhappy and escalate it to the eBay Standard Purchase Protection Program. To escalate, the buyer must be eligible for the PPP. Used in Item Not Received disputes.
Dispute.Item	ItemType	Always	Information about the item that spawned the transaction. The transaction is a purchase from this item's listing.
Dispute.Item.ItemID	ItemIDType (string)	Always	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 transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) 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 GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. 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. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
Dispute.Item.ListingDetails	ListingDetailsType	Always	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. Not applicable to Half.com.
Dispute.Item.ListingDetails .EndTime	dateTime	Always	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. In GetSearchResults, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times. In GetSearchResults, the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing.
Dispute.Item.ListingDetails .StartTime	dateTime	Always	The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
Dispute.Item.Quantity	int	Always	This meaning of this value depends on the context. For AddItem and related calls: Specify the number of identical items the seller has available for sale in this listing. For auctions (with competitive bidding), Quantity must be 1. For certain other formats (e.g., fixed-price) the Quantity can be 1 or more. See the eBay Web site online help to learn which selling formats support multi-quantity sales. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.Quantity for each variation instead. For ReviseItem and ReviseFixedPriceItem: When you revise a listing (with no variations), you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, on sites that support multi-quantity auctions (Dutch auctions), if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. In multi-variation listings, this value is the sum of all the variation quantities in the listing. 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. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. For transaction 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). For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. See Selecting a Selling Format.
Dispute.Item.SellingStatus	SellingStatusType	Always	Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com.
Dispute.Item.SellingStatus .ConvertedCurrentPrice	AmountType (double)	Conditionally	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.
Dispute.Item.SellingStatus .CurrentPrice	AmountType (double)	Always	For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.
Dispute.Item.Site	SiteCodeType	Always	The name of the site on which the item is listed. 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 Web 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 Web 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, 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). Not applicable to Half.com. Applicable values: See Site. See: The US and International eBay Sites Specifying the Target Site Field Differences for eBay Sites
Dispute.Item.Title	string	Always	Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55.
Dispute.PurchaseProtection	boolean	Always	Whether the buyer is eligible for the eBay Standard Purchase Protection Program. The eligibility rules are described in the eBay site online help. Used in Item Not Received disputes.
Dispute.SellerUserID	UserIDType (string)	Always	The eBay user ID of the seller involved in the dispute.
Dispute.TransactionID	string	Always	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.).

GetDispute Detail Controls

Detail Control: DetailLevel

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

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

GetDispute Change History

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

This document was generated with a customized version of the apireferencedocs tool.

Call-specific Input Fields
DisputeID	DisputeIDType (string)	Required	The unique identifier of the dispute, returned when the dispute is created.

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.

eBay Trading API Call Reference Version 643

eBay Trading API
Call Reference Version 643