eBay Versioning Strategy

Base type definition of the request payload, which can carry any type of payload content plus optional versioning information and detail level requirements. All concrete request types are derived from the abstract request type. The naming convention we use for the concrete type names is the name of the service (the verb or call name) followed by "RequestType": VerbNameRequestType If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response. If you're making a lot of calls, you can use this for tracking that a response is returned for every request and to match particular responses to particular requests. (In this case, specify a different value for each request.) You can specify any value that is useful to you. No Base type definition of a response payload that can carry any type of payload content with following optional elements: - timestamp of response message - application-level acknowledgement - application-level (business-level) errors and warnings This value represents the date and time when eBay processed the request. The time zone of this value is <a href="types/simpleTypes.html#dateTime">GMT</a> and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about this time format and converting to and from the GMT time zone. Always Indicates whether the call was successfully processed by eBay. Always PartialFailure A list of application-level errors or warnings (if any) that were raised when eBay processed the request. Application-level errors occur due to problems with business-level data on the client side or on the eBay server side. For example, an error would occur if the request contains an invalid combination of fields, or it is missing a required field, or the value of the field is not recognized. An error could also occur if eBay encountered a problem in our internal business logic while processing the request. Only returned if there were warnings or errors. Conditionally This refers to the particular 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. Always The release version that eBay used to process the request. Note: This is usually the latest release version, as specified in the release notes. (eBay releases the API to international sites about a week after we release it to the US site.) If a field in the response returns the token "CustomCode", it usually means that the field is a code type (a token or enumeration), and that in your request URL (or HTTP header) you specified a version that is older than the version in which the token was added to the call. Always eBay Versioning Strategy http://developer.ebay.com/DevZone/XML/docs/HowTo/eBayWS/eBaySchemaVersioning.html If you pass a value in MessageID 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. Only returned if MessageID was used. Conditionally AckCodeType - Type declaration to be used by other schema. This code identifies the acknowledgement code types that eBay could use to communicate the status of processing a (request) message to an application. This code would be used as part of a response message that contains an application-level acknowledgement element. (out) Request processing succeeded (out) Request processing failed (out) Request processing completed with warning information being included in the response message (out) Request processing completed with some failures. See the Errors data to determine which portions of the request failed. (out) Reserved for internal or future use. 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. 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. (out) Reserved for internal or future use. A variable that contains specific information about the context of this error. For example, if you pass in an attribute set ID that does not match the specified category, the attribute set ID might be returned as an error parameter. Use error parameters to flag fields that users need to correct. Also use error parameters to distinguish between errors when multiple errors are returned. The value of the variable. Conditionally The index of the parameter in the error. Conditionally These are request errors (as opposed to system errors) that occur due to problems with business-level data (e.g., an invalid combination of arguments) that the application passed in. A brief description of the condition that raised the error. Conditionally Errors by Number Errors/ErrorMessages.html A more detailed description of the condition that raised the error. Conditionally Errors by Number Errors/ErrorMessages.html 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. Conditionally Errors by Number Errors/ErrorMessages.html This field is not currently in use for eBay Shopping Web Services. Indicates whether the error message text is intended to be displayed to an end user or intended only to be parsed by the application. If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for the application, and the application should translate the error into a more appropriate message. Indicates whether the error caused the request to fail. If the request fails and the source of the problem is within the application (such as a missing required element), please 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, you 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. 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. Conditionally Errors by Number Errors/ErrorMessages.html ErrorHandlingGuidelines UseTopicAlias more information (in the eBay Trading Web Services guide) Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. You can usually predict where these will occur by looking at the "replaceable_value" indicators in our Errors by Number page. Conditionally Errors by Number Errors/ErrorMessages.html API errors are divided between two classes: system errors and request errors. Conditionally Errors by Number Errors/ErrorMessages.html SeverityCodeType - Type declaration to be used by other schema. This code identifies the severity of an API error. A code indicates whether there is an API- level error or warning that needs to be communicated to the client. (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. (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. (out) Reserved for internal or future use Basic type for specifying monetary amounts. A double value (e.g., 1.00 or 1.0) is meaningful as a monetary amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency. An AmountType expresses both the value (a double) and the currency. Details such as prices, fees, costs, and payments are specified as amount types. Currency in which the monetary amount is specified. GetClientAlerts GetChannelContent No Conditionally Sent to a seller when a question is posted about one of the seller's active listings. GetClientAlerts Always Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Item about which seller is being asked questions. GetClientAlerts Always Insert all documentation about the element here GetClientAlerts Always Insert all documentation about the element here GetClientAlerts Always Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always A container of details about a best offer. GetClientAlerts Always Describes the type of best offer event being alerted. Identifies the event that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always A container of details about a best offer. GetClientAlerts Always Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always A container of details about a best offer. GetClientAlerts Always The status of the best offer. The best offer is awaiting seller response or will naturally expire after 48 hours. The best offer was accepted by the seller. The best offer was rejected by the seller. The best offer expired after 48 hours due to no action by the seller. The best offer was retracted by the buyer. The best offer was ended by an administrator. Retrieve active best offers only. Retrieve all counter best offers. Retrieve all best offers (including declined offers, etc.). (out) Reserved for internal or future use. The offer type of the best offer. The buyer has placed best offer on the item. The buyer has made a counter offer. The seller has made a counter offer. (out) Reserved for internal or future use. Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Conditionally eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi- quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Conditionally eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetChannelContent Always Identifies the channel, such as an item, that is the subject of the alert. GetChannelContent Always Identifies the event, such as a price change, that is the subject of the alert. GetChannelContent Always Specifies the date of the most recent event on the channel. GetChannelContent Always Provides channel type and ID, and event type. GetChannelContent Yes Event type of the public channel. GetChannelContent Yes Identifier of the channel (ItemID). GetChannelContent Yes Identifies the type of event. GetChannelContent Yes An item, identified by an ItemID, is a channel whose content, in the form of alerts about events such as price change, can be retrieved using GetChannelContent. (out) Reserved for internal or future use. Identifies and describes the type of best offer event being alerted. GetClientAlerts Conditionally An ID to distinguish this best offer from other best offers made on the item. GetClientAlerts Conditionally The best offer type. GetClientAlerts Conditionally Unique eBay user ID for the user. GetClientAlerts Conditionally Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer). GetClientAlerts Conditionally The amount of the best offer. GetClientAlerts Conditionally The number of items for which the buyer is making an offer. GetClientAlerts Conditionally The state of the offer. In the case of a PlaceOffer response that specified a best offer, Status may be "Accepted" if the best offer was at or above an auto-accept price. GetClientAlerts Conditionally Text message that was provided by a buyer when placing a best offer. Max length: 500 (in bytes). GetClientAlerts Conditionally Text response to buyer from seller. Max length: 500 (in bytes). GetClientAlerts Conditionally Identifies the type of event being alerted. GetClientAlerts GetChannelContent Conditionally Type of client alert. GetChannelContent GetClientAlerts Always Sent to a user when the price of an item has changed. GetChannelContent Conditionally (in/out) An alert type sent when the listing of the watched item is about to end. GetClientAlerts Conditionally Sent to a user when another buyer has placed a higher maximum bid and the user is no longer the current high bidder. GetClientAlerts Conditionally An informational alert when a user adds an item to her/his watch list. GetClientAlerts Conditionally An informational alert when a user removes an item from her/his watch list. GetClientAlerts Conditionally Alert sent when a seller has used the Trading API AddSecondChanceItem to extend extend to a non-winning bidder a chance to purchase an unsold item or a simliar item. GetClientAlerts Conditionally Sent when an auction ends. An auction ends either when its duration expires, the buyer purchases an item with Buy It Now, or the auction is canceled. Applies to both Chinese and Dutch auctions. GetClientAlerts Conditionally Sent to a seller when a fixed-price item is sold and the buyer completes the checkout process. Not sent when a fixed-price item's duration expires without purchase. GetClientAlerts Conditionally Sent to a user when a listing for a fixed price item ends. A fixed price listing ends when a buyer starts to move through checkout or purchases the item. GetClientAlerts Conditionally Sent to a subscribing third party for the buyer when a user places a bid for an item. GetClientAlerts Conditionally Sent to a subscribing third party for the seller when a user places a bid for an item. GetClientAlerts Conditionally Sent to a subscribing third party for the buyer when a user bought an item. GetClientAlerts Conditionally Sent to a subscribing third party for the buyer when a user lost a bid for an item. GetClientAlerts Conditionally Specifies an ItemSold alert event. GetClientAlerts Conditionally Sent when seller has used the Trading API call EndItem to end the specified item listing before the date and time at which it would normally end (per the listing duration). GetClientAlerts GetChannelContents Conditionally Sent to a subscribing third party for the seller when an item was not sold. GetClientAlerts Conditionally Sent to a seller when a question is posted about one of the seller's active listings. GetClientAlerts Conditionally Sent to a subscribing third party for a buyer when a seller makes a counter offer to the buyer's best offer on an item opted into the Best Offer feature by the seller. GetClientAlerts Conditionally Sent to a subscribing third party for a buyer when a seller rejects the buyer's best offer on an item opted into the Best Offer feature by the seller. GetClientAlerts Conditionally Sent to a subscribing third party for a buyer who makes a best offer on an item opted into the Best Offer feature by a seller. GetClientAlerts Conditionally Sent to a subscribing third party when the buyer leaves feedback for a seller or the seller leaves feedback for a buyer. GetClientAlerts Conditionally Sent to a subscribing third party when a buyer leaves feedback for the seller or the seller leaves feedback for a buyer. GetClientAlerts Conditionally Sent to a subscribing third party when a user's feedback star level changes. GetClientAlerts Conditionally Defines all client alerts events that can be used. (out) Indicates that the price of an item has changed. (out) Indicates the end of item listing. (in/out) Sent to a user when another buyer has placed a higher maximum bid and the user is no longer the current high bidder. Sent when an auction ends. An auction ends either when its duration expires, the buyer purchases an item with Buy It Now, or the auction is canceled. Applies to both Chinese and Dutch auctions. Sent to a seller when a fixed-price item is sold and the buyer completes the checkout process. Not sent when a fixed-price item's duration expires without purchase. Sent to a user when a listing for a fixed price item ends. A fixed price listing ends when a buyer starts to move through checkout or purchases the item. Alert sent when a seller has used the Trading API AddSecondChanceItem to extend extend to a non-winning bidder a chance to purchase an unsold item or a simliar item. Sent to a seller when a question is posted about one of the seller's active listings. A notification type where the listing of the watched item is about to end. This event has a property with which caller can specify the TimeLeft before the listing ends. (in/out) Sent to a seller when a bidder makes a best offer on an item opted into the Best Offer feature by the seller. (in/out) An informational alert when a user adds an item to her/his watch list. (in/out) An informational alert when a user removes an item from her/his watch list. (in/out) Sent to a partner when a buyer leaves feedback for the seller or the seller leaves feedback for a buyer. (in/out) Sent to who left the feedback when a buyer leaves feedback for the seller or the seller leaves feedback for a buyer. (in/out) Sent to whose feedback star level was changed. (in/out) An informational alert for the buyer when a user places a bid for an item. (in/out) An informational alert for the seller when a user places a bid for an item. (in/out) An informational alert for the buyer when a user bought an item. (in/out) An informational alert for the buyer when a user doesn't win an item. (in/out) An informational alert for the seller when a user sold an item. (in/out) An informational alert for the seller when an item exipired without sold. (in/out) Sent to a buyer when a sellerer makes a counter offer to the buyer's best offer on an item opted into the Best Offer feature by the seller. (in/out) Sent to a buyer when a seller rejects the buyer's best offer on an item opted into the Best Offer feature by the seller. (in/out) Sent to a buyer who makes a best offer on an item opted into the Best Offer feature by a seller. (out) Reserved for future use Contains details about feedback left. GetClientAlerts Conditionally eBay user ID for the user who left the feedback. GetClientAlerts Always Text message left by the user in CommentingUser. Used to provide a more in-depth description of the user's opinion of the transaction. Returned as text in the language that the comment was originally left in. GetClientAlerts Always Type of feedback. Can be Positive, Neutral, Negative, or Withdrawn (see the CommentTypeCodeType code list). Positive feedbacks add to the user's total feedback score, negative feedbacks lower the score, and neutral feedbacks do not affect the score (but do affect the overall picture of the user's online reputation). GetClientAlerts Always The ID that uniquely identifies the item listing. GetClientAlerts Always Indicates whether the user who was the feedback recipient was a Buyer or the Seller for that transaction. GetClientAlerts Always Name of the listing for which feedback was provided. Returned as CDATA. GetClientAlerts Always The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType. GetClientAlerts Always Unique identifier for the feedback entry. GetClientAlerts Always Unique identifier for the transaction about which this feedback entry was left. GetClientAlerts Always Contains types of item alerts. GetClientAlerts GetChannelContent Conditionally Unique ID of the item that is the subject of the alert. GetClientAlerts Conditionally The total number of bids on the item. GetClientAlerts Conditionally Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. GetClientAlerts Conditionally Unique identifier for the high bidding user that does not change when the eBay user name is changed. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. GetClientAlerts Conditionally eBay user ID of the seller. GetClientAlerts Conditionally Date and time when the listing ends. GetClientAlerts Conditionally Current price of the item. GetClientAlerts Conditionally The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally Smallest amount the next bid on the item can be. GetClientAlerts Always Name of the item as it appears in the listing or search results. GetClientAlerts Conditionally Date the item was last modified. GetClientAlerts Conditionally Indicates whether the reserve price has been met for the listing. True if the reserve price was met or no reserve price was specified. GetClientAlerts Conditionally Amount of the best offer. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Category ID for the first (or only) category in which the item is listed. GetClientAlerts Conditionally Contains types of member messages. GetClientAlerts Conditionally Contains types of member messages. GetClientAlerts Conditionally Contains types of member questions. Possible question types include Shipping, Payment, MultipleItemShipping, and CustomizedSubject. GetClientAlerts Conditionally Contains types of member messages. GetClientAlerts Conditionally Contains types of member messages. GetClientAlerts Conditionally Identifies and describes the transaction. GetClientAlerts Conditionally The amount the buyer paid for the item(s) in the transaction. GetClientAlerts Conditionally Number of items purchased so far. GetClientAlerts Conditionally eBay user ID of the buyer. GetClientAlerts Conditionally One of the available client alerts event types. GetClientAlerts Always [PD] GetClientAlerts Always Contains information about a user. GetClientAlerts Conditionally Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. GetClientAlerts Conditionally Percent of total feedback that is positive. For example, if the member has 50 feedbacks, where 49 are positive and 1 is neutral or negative, the positive feedback percent could be 98.0. The value uses a max precision of 4 and a scale of 1. If the user has feedback, this value can be returned regardless of whether the member has chosen to make their feedback private. Not returned if the user has no feedback. GetClientAlerts Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType in the Trading API for specific values. GetClientAlerts Conditionally CommentTypeCodeType - Type declaration to be used by other schema. These are the possible codes to specify the types of feedback/comment. Additional information about feedback is available in the online Help of the eBay site. (in/out) Positive feedback. Increases total feedback score. (in/out) Neutral feedback. No effect on total feedback score. (in/out) Negative feedback. Decreases total feedback score. (out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. (out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. (out) Reserved for internal or future use. Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always A container of details about a best offer. GetClientAlerts Always Defines the standard 3-letter ISO 4217 currency code set. However, only certain currency codes are currently valid for use on eBay. The valid codes are documented below with the notation "(in/out)". Other codes in this list are for future use. The documentation below specifies English names for each currency. Alternatively, use GeteBayDetails to retrieve the names programmatically. A reference: http://www.xe.com/iso4217.htm (in/out) Indian Rupee. For eBay, you can only specify this currency for listings you submit to the India site (site ID 203). (in/out) Canadian Dollar. For eBay, you can only specify this currency for listings you submit to the Canada site (site ID 2) (Items listed on the Canada site can also specify USD.) (in/out) Hong Kong Dollar. For eBay, you can only specify this currency for listings you submit to the Hong Kong site (site ID 201). (in/out) Australian Dollar. For eBay, you can only specify this currency for listings you submit to the Australia site (site ID 15). (in/out) Swiss Franc. For eBay, you can only specify this currency for listings you submit to the Switzerland site (site ID 193). (in/out) Malaysian Ringgit. For eBay, you can only specify this currency for listings you submit to the Malaysia site (site ID 207). (in/out) Euro. For eBay, you can only specify this currency for listings you submit to these sites: Austria (site 16), Belgium_French (site 23), France (site 71), Germany (site 77), Italy (site 101), Belgium_Dutch (site 123), Netherlands (site 146), Spain (site 186), Ireland (site 205). (in/out) Philippines Peso. For eBay, you can only specify this currency for listings you submit to the Philippines site (site ID 211). (in/out) Poland, Zloty. For eBay, you can only specify this currency for listings you submit to the Poland site (site ID 212). (in/out) US Dollar. For eBay, you can only specify this currency for listings you submit to the US (site ID 0), eBayMotors (site 100), and Canada (site 2) sites. (in/out) Singapore Dollar. For eBay, you can only specify this currency for listings you submit to the Singapore site (site 216). (in/out) Swedish Krona. For eBay, you can only specify this currency for listings you submit to the Sweden site (site 218). (in/out) New Taiwan Dollar. Note that there is no longer an eBay Taiwan site. (in/out) Pound Sterling. For eBay, you can only specify this currency for listings you submit to the UK site (site ID 3). Reserved for internal or future use. Time of most recent retrieval of data. GetClientAlerts Always tk. GetClientAlerts Always Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The total number of bids on the item. GetClientAlerts Conditionally The eBay ID of the seller who listed the item. GetClientAlerts Conditionally Date and time when the listing ended. GetClientAlerts Conditionally Price when the listing ended. GetClientAlerts Conditionally Name of the item as it appears in the listing or search results. GetClientAlerts Conditionally URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Information about one transaction. GetClientAlerts Conditionally Contains information about the end of the transaction that is the subject of the alert. GetClientAlerts Always Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The total number of bids the user placed on the item. GetClientAlerts Conditionally The eBay ID of the seller who listed the item. GetClientAlerts Conditionally Date and time when the listing ended. GetClientAlerts Conditionally Price when the listing ended. GetClientAlerts Conditionally Name of the item as it appears in the listing or search results. GetClientAlerts Conditionally URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. GetClientAlerts Conditionally [PD] Information about one transaction. GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Container for details about feedback left. GetClientAlerts Conditionally FeedbackRatingStarCodeType - Type declaration to be used by other schema. The color of a feedback score star visually denotes the range in which the member's summary feedback score falls. The score is the net positive feedback minus the net negative feedback left for the member. (out) No graphic displayed, feedback score 0-9. (out) Yellow Star, feedback score 10-49. (out) Blue Star, feedback score 50-99. (out) Turquoise Star, feedback score 100-499. (out) Purple Star, feedback score 500-999. (out) Red Star, feedback score 1,000-4,999 (out) Green Star, feedback score 5,000-9,999. (out) Yellow Shooting Star, feedback score 10,000-24,999. (out) Turquoise Shooting Star, feedback score 25,000-49,999. (out) Purple Shooting Star, feedback score 50,000-99,999. (out) Red Shooting Star, feedback score 100,000 and above. (out) Reserved for internal or future use. Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Container for details about feedback left, including User, CommentType, and Item. GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Identifies eBay user. GetClientAlerts Always Retrieves a list of public channel messages.

Retrieves a list of public channel messages. Input should be in name-value pair format.

GetClientAlerts Identifies the requesting application. This is the same as the AppID you use to obtain a Trading API user token, which you include in your GetClientAlertsToken request. GetChannelContent Yes Provides channel type and ID, and event type. GetChannelContent Yes Set this value to inform the API that your application is not an old internal eBay application. GetChannelContent No Retrieves a list of public channel messages.

Retrieves a list of public channel messages. Input should be in name-value pair format.

Contains channel ID, channel type and an array of events. GetPublicAlerts Always Retrieves alerts privately subscribed to by the user.

Retrieves alerts privately subscribed to by the user. Input should be in name-value pair format.

GetChannelContent, SetNotificationPreferences, GetNotificationPreferences Identifier of the session, which must be passed in every time GetUserAlerts is called. SessionId does not change over the lifetime of the session. GetUserAlerts Yes Yes Returned from the server in the Login and GetUserAlerts responses, and passed in the GetUserAlerts and Logout requests. Because SessionData contains an encrypted timestamp, when the application uses the SessionData returned from the previous GetUserAlerts call in a new GetUserAlerts call, GetUserAlerts returns all new alerts since the previous call along with a brand new SessionData for use use next time. GetUserAlerts Yes Yes Set this value to inform the API that your application is not an application predating the release of the Client Alerts API. GetUserAlerts No Retrieves alerts privately subscribed to by the user.

Retrieves alerts privately subscribed to by the user. Input should be in name-value pair format.

Specifies type of alert. For example, BestOfferReceived or Outbid. GetUserAlerts Always SessionData is returned from the server. Each call passes in the session data from the previous call. This is required to correctly identify the events to be returned to the caller. Login returns SessionId and SessionData to be used for subsequent calls. GetUserAlerts Always Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Conditionally eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Conditionally eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Describes item ending event. GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The total number of bids the user placed on the item. GetClientAlerts Conditionally The eBay ID of the seller who listed the item. GetClientAlerts Conditionally Date and time when the listing ended. GetClientAlerts Conditionally Price when the listing ended. GetClientAlerts Conditionally Name of the item as it appears in the listing or search results. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Conditionally eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Always eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Always eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Conditionally eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Conditionally eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The number of bids that have been placed on the item. GetClientAlerts Conditionally eBay user ID of the seller. GetClientAlerts Conditionally Time stamp of the actual end time. GetClientAlerts Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. GetClientAlerts Conditionally Name of the item as it appears in the listing or in search and browse results. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally Logs the client application in to the client alerts server. The server returns SessionID and SessionData required in GetClientAlerts calls.

Logs the client application in to the client alerts server. All subsequent interactions will use the session identifier. Input should be in name-value pair format.

GetChannelContent, GetClientAlerts, SetNotificationPreferences Authenticates the client to the Client Alerts server. The client alerts token is valid for seven days. After the client alerts token expires, the client will have use the eBay user token to fetch a new client alerts token. To keep track of the session, the client alerts server returns the session data information to the client. The client uses the session information in subsequent client alerts calls. Login Yes Logs the client application in to the client alerts server.

All subsequent calls to the client alerts server use the SessionID and SessionData returned from this call.

Returned from the server. Each call passes in the session data from the previous call. Login returns the SessionId and SessionData to be used for subsequent calls. Login Always SessionData is returned from the server. Each call passes in the session data from the previous call. This is required to correctly identify the events to be returned to the caller. Login returns SessionId and SessionData to be used for subsequent calls. Login Always Logs the client application out of the client alerts server.

Logs the client application out of the client alerts server. Input should be in name-value pair format.

GetChannelContent Logout Yes SessionData is returned from the server. Each call passes in the session data from the previous call. This is required to correctly identify the events to be returned to the caller. Login returns SessionId and SessionData to be used for subsequent calls. Logout Yes Logout Yes Member to Member message initiated by bidder/potential bidder to a seller of a particular item. Member to Member message initiated as a response to an Ask A Question message. Member to Member message initiated by any eBay member to another eBay member. Member message between transaction partners within 90 days after the transaction. Member to Member message initiated as a response to a Contact eBay Member message. Reserved Member to Member message initiated by any eBay member to another eBay member who has posted on a community forum within the past 7 days. Reserved Reserved for future or internal use. All message types. Member to Member message initiated by sellers to their bidders during an active listing. Reserved Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The total number of bids the user placed on the item. GetClientAlerts Conditionally Unique eBay user ID for the high bidder. Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: On the US site, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. GetClientAlerts Conditionally Unique identifier for the high bidding user that does not change when the eBay user name is changed. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. GetClientAlerts Conditionally The eBay ID of the seller who listed the item. GetClientAlerts Conditionally Date and time when the listing ended. GetClientAlerts Conditionally Price following outbid event. GetClientAlerts Conditionally The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. GetClientAlerts Conditionally Smallest amount the next bid on the item can be. Name of the item as it appears in the listing or search results. GetClientAlerts Conditionally Contains information about the price change event. GetChannelContent Always Defines all client alerts events that can be used. GetClientAlerts Always Time of most recent retrieval of data. GetChannelContent Always Unique ID of the item that is the subject of the alert. GetChannelContent Always The total number of bids the user placed on the item. GetChannelContent Conditionally Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. GetChannelContent Conditionally The eBay ID of the seller who listed the item. GetChannelContent Conditionally Date and time when the listing ended. GetChannelContent Conditionally The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. Smallest amount the next bid on the item can be. GetChannelContent Conditionally Indicates whether any bids on this item are greater than the seller's reserve price for the listing (if any). GetChannelContent Conditionally General questions about the item. Questions related to the shipping of the item. Questions related to the payment for the item. Questions related to the shipping of this item bundled with other items also purchased on eBay. Customized subjects set by the seller using SetMessagePreferences or the eBay Web site. Reserved Reserved for future or internal use. Contains information about the second chance offer. GetClientAlerts Always Identifies the action that is the subject of the alert. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The total number of bids the user placed on the item. GetClientAlerts Conditionally The eBay ID of the seller who listed the item. GetClientAlerts Conditionally Date and time when the listing ended. GetClientAlerts Conditionally Price when the listing ended. GetClientAlerts Conditionally Name of the item as it appears in the listing or search results. GetClientAlerts Conditionally URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. GetClientAlerts Conditionally [PD] GetClientAlerts Conditionally The item ID for the original listing from which a second chance offer is made. This value is only returned when the data for the second chance offer listing is retrieved. Output only. GetClientAlerts Conditionally A means for identifying a person's role in doing business on eBay. (in/out) Acting as buyer. (in/out) Acting as seller. (out) Reserved for future use Contains information about the imminent end time of a watched item. GetClientAlerts Always Defines all client alerts events that can be used. GetClientAlerts Always Time of most recent retrieval of data. GetClientAlerts Always Unique ID of the item that is the subject of the alert. GetClientAlerts Always The total number of bids the user placed on the item. GetClientAlerts Conditionally Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. GetClientAlerts Conditionally The eBay ID of the seller who listed the item. GetClientAlerts Conditionally Date and time when the listing ended. GetClientAlerts Conditionally Price when the listing ended. GetClientAlerts Conditionally The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. GetClientAlerts Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. GetClientAlerts Conditionally Smallest amount the next bid on the item can be. Name of the item as it appears in the listing or in search and browse results.