eBay Client Alerts APIVersion 963

GetUserAlerts

Retrieves alerts privately subscribed to by the user.

See also the reference documentation for these calls:



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.

Call-specific Input Fields
  SessionData.Value = string
  SessionID.Value = string
  Version.Value = string

Standard Input Fields
  MessageID.Value = string
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
SessionData.Value string Required 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.
SessionID.Value string Required Identifier of the session, which must be passed in every time GetUserAlerts is called. SessionId does not change over the lifetime of the session.
Version.Value string Optional Set this value to inform the API that your application is not an application predating the release of the Client Alerts API.
Standard Input Fields  
MessageID.Value string Optional 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.



Output

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

{
  /* Call-specific Output Fields */
  "ClientAlerts":
      { /* ClientAlertsType */
      "ClientAlertEvent":
          { /* ClientAlertsEventType */
          "AskSellerQuestion":
              { /* AskSellerQuestionEventType */
              "EventType": ClientAlertsEventTypeCodeType,
              "ItemID.Value": string,
              "MessageID.Value": string,
              "MessageType": MessageTypeCodeType,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "BestOffer":
              { /* BestOfferEventType */
              "BestOffer":
                  { /* ClientAlertsBestOfferType */
                  "BestOfferCodeType": BestOfferTypeCodeType,
                  "BestOfferID.Value": string,
                  "BuyerMessage.Value": string,
                  "BuyerUserID.Value": string,
                  "ExpirationTime.Value": dateTime,
                  "Price":
                      { /* AmountType */
                      },
                  "Quantity.Value": int,
                  "SellerMessage.Value": string,
                  "Status": BestOfferStatusCodeType
                  },
              "EventType": ClientAlertsEventTypeCodeType,
              "ItemID.Value": string,
              "Timestamp.Value": dateTime
              },
          "BestOfferDeclined":
              { /* BestOfferDeclinedEventType */
              "BestOffer":
                  { /* ClientAlertsBestOfferType */
                  "BestOfferCodeType": BestOfferTypeCodeType,
                  "BestOfferID.Value": string,
                  "BuyerMessage.Value": string,
                  "BuyerUserID.Value": string,
                  "ExpirationTime.Value": dateTime,
                  "Price":
                      { /* AmountType */
                      },
                  "Quantity.Value": int,
                  "SellerMessage.Value": string,
                  "Status": BestOfferStatusCodeType
                  },
              "EventType": ClientAlertsEventTypeCodeType,
              "ItemID.Value": string,
              "Timestamp.Value": dateTime
              },
          "BestOfferPlaced":
              { /* BestOfferPlacedEventType */
              "BestOffer":
                  { /* ClientAlertsBestOfferType */
                  "BestOfferCodeType": BestOfferTypeCodeType,
                  "BestOfferID.Value": string,
                  "BuyerMessage.Value": string,
                  "BuyerUserID.Value": string,
                  "ExpirationTime.Value": dateTime,
                  "Price":
                      { /* AmountType */
                      },
                  "Quantity.Value": int,
                  "SellerMessage.Value": string,
                  "Status": BestOfferStatusCodeType
                  },
              "EventType": ClientAlertsEventTypeCodeType,
              "ItemID.Value": string,
              "Timestamp.Value": dateTime
              },
          "BidPlaced":
              { /* BidPlacedEventType */
              "BidCount.Value": int,
              "BuyItNowAvailable.Value": boolean,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "HighBidderUserID.Value": string,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "ReserveMet.Value": boolean,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "BidReceived":
              { /* BidReceivedEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "HighBidderUserID.Value": string,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "CounterOfferReceived":
              { /* CounterOfferReceivedEventType */
              "BestOffer":
                  { /* ClientAlertsBestOfferType */
                  "BestOfferCodeType": BestOfferTypeCodeType,
                  "BestOfferID.Value": string,
                  "BuyerMessage.Value": string,
                  "BuyerUserID.Value": string,
                  "ExpirationTime.Value": dateTime,
                  "Price":
                      { /* AmountType */
                      },
                  "Quantity.Value": int,
                  "SellerMessage.Value": string,
                  "Status": BestOfferStatusCodeType
                  },
              "EventType": ClientAlertsEventTypeCodeType,
              "ItemID.Value": string,
              "Timestamp.Value": dateTime
              },
          "EndOfAuction":
              { /* EndOfAuctionEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string,
              "Transaction":
                  { /* ClientAlertsTransactionType */
                  "AmountPaid":
                      { /* AmountType */
                      },
                  "BuyerUserID.Value": string,
                  "CreatedDate.Value": dateTime,
                  "OrderLineItemID.Value": string,
                  "QuantitySold.Value": int,
                  "TransactionID.Value": string
                  }
              },
          "EventType": ClientAlertsEventTypeCodeType,
          "FeedbackLeft":
              { /* FeedbackLeftEventType */
              "EventType": ClientAlertsEventTypeCodeType,
              "FeedbackDetail":
                  { /* ClientAlertsFeedbackDetailType */
                  "CommentingUser.Value": string,
                  "CommentText.Value": string,
                  "CommentType": CommentTypeCodeType,
                  "FeedbackID.Value": string,
                  "FeedbackScore.Value": int,
                  "ItemID.Value": string,
                  "ItemPrice":
                      { /* AmountType */
                      },
                  "ItemTitle.Value": string,
                  "Role": TradingRoleCodeType,
                  "TransactionID.Value": string
                  },
              "Timestamp.Value": dateTime
              },
          "FeedbackReceived":
              { /* FeedbackReceivedEventType */
              "EventType": ClientAlertsEventTypeCodeType,
              "FeedbackDetail":
                  { /* ClientAlertsFeedbackDetailType */
                  "CommentingUser.Value": string,
                  "CommentText.Value": string,
                  "CommentType": CommentTypeCodeType,
                  "FeedbackID.Value": string,
                  "FeedbackScore.Value": int,
                  "ItemID.Value": string,
                  "ItemPrice":
                      { /* AmountType */
                      },
                  "ItemTitle.Value": string,
                  "Role": TradingRoleCodeType,
                  "TransactionID.Value": string
                  },
              "Timestamp.Value": dateTime
              },
          "FeedbackStarChanged":
              { /* FeedbackStarChangedEventType */
              "EventType": ClientAlertsEventTypeCodeType,
              "Timestamp.Value": dateTime,
              "User":
                  { /* ClientAlertsUserType */
                  "FeedbackRatingStar": FeedbackRatingStarCodeType,
                  "PositiveFeedbackPercent.Value": float,
                  "UserID.Value": string
                  }
              },
          "FixedPriceEndOfTransaction":
              { /* EndOfTransactionEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string,
              "Transaction":
                  { /* ClientAlertsTransactionType */
                  "AmountPaid":
                      { /* AmountType */
                      },
                  "BuyerUserID.Value": string,
                  "CreatedDate.Value": dateTime,
                  "OrderLineItemID.Value": string,
                  "QuantitySold.Value": int,
                  "TransactionID.Value": string
                  }
              },
          "FixedPriceTransaction":
              { /* EndOfTransactionEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string,
              "Transaction":
                  { /* ClientAlertsTransactionType */
                  "AmountPaid":
                      { /* AmountType */
                      },
                  "BuyerUserID.Value": string,
                  "CreatedDate.Value": dateTime,
                  "OrderLineItemID.Value": string,
                  "QuantitySold.Value": int,
                  "TransactionID.Value": string
                  }
              },
          "ItemAddedToWatchList":
              { /* ItemAddedToWatchListEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "ItemEnded":
              { /* ItemEndedEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "ItemListed":
              { /* ItemListedEventType */
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "ItemLost":
              { /* ItemLostEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "ItemMarkedPaid":
              { /* ItemMarkedPaidEventType */
              "EventType": ClientAlertsEventTypeCodeType,
              "ItemID.Value": string,
              "OrderID.Value": string,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string,
              "TransactionID.Value": string
              },
          "ItemMarkedShipped":
              { /* ItemMarkedShippedEventType */
              "EventType": ClientAlertsEventTypeCodeType,
              "ItemID.Value": string,
              "OrderID.Value": string,
              "SellerUserID.Value": string,
              "Shipment":
                  { /* ClientAlertsShipmentType */
                  "ShipmentTrackingNumber.Value": string,
                  "ShippingCarrierUsed": ShippingCarrierCodeType
                  },
              "Timestamp.Value": dateTime,
              "Title.Value": string,
              "TransactionID.Value": string
              },
          "ItemRemovedFromWatchList":
              { /* ItemRemovedFromWatchListEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "ItemSold":
              { /* ItemSoldEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "ItemUnsold":
              { /* ItemUnsoldEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "ItemWon":
              { /* ItemWonEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "Outbid":
              { /* OutbidEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "HighBidderEIASToken.Value": string,
              "HighBidderUserID.Value": string,
              "ItemID.Value": string,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "SecondChanceOffer":
              { /* SecondChanceOfferEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "ItemID.Value": string,
              "Quantity.Value": int,
              "SecondChanceOriginalItemID.Value": string,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "Title.Value": string
              },
          "WatchedItemEndingSoon":
              { /* WatchedItemEndingSoonEventType */
              "BidCount.Value": int,
              "CurrentPrice":
                  { /* AmountType */
                  },
              "EndTime.Value": dateTime,
              "EventType": ClientAlertsEventTypeCodeType,
              "GalleryURL.Value": anyURI,
              "HighBidderUserID.Value": string,
              "ItemID.Value": string,
              "SellerUserID.Value": string,
              "Timestamp.Value": dateTime,
              "ViewItemURL.Value": anyURI
              }
          }
      },
  "SessionData.Value": string,

  /* Standard Output Fields */
  "Ack": AckCodeType,

  "Build.Value": string
  "CorrelationID.Value": string,
  "Errors":       { /* ErrorType */       "ErrorClassification": ErrorClassificationCodeType,       "ErrorCode.Value": token,       "ErrorParameters":           { /* ErrorParameterType */           "Value.Value": string           },       "LongMessage.Value": string,       "SeverityCode": SeverityCodeType,       "ShortMessage.Value": string       },
  "Timestamp.Value": dateTime,
  "Version.Value": string, }
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
ClientAlerts ClientAlertsType Always Specifies type of alert. For example, BestOfferReceived or Outbid.
ClientAlerts.ClientAlertEvent ClientAlertsEventType Always,
repeatable: [1..*]
Specifies the event from among available client alert events.
ClientAlerts.ClientAlertEvent
  .AskSellerQuestion
AskSellerQuestionEventType Conditionally Alert created for a subscribing seller (or seller's application) when a question is posted about one of the seller's active listings.
ClientAlerts.ClientAlertEvent
  .AskSellerQuestion.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .AskSellerQuestion.ItemID.Value
string Always Item about which seller is being asked questions.
ClientAlerts.ClientAlertEvent
  .AskSellerQuestion.MessageID.Value
string Always Unique ID assigned to the AskSellerQuestion message.
ClientAlerts.ClientAlertEvent
  .AskSellerQuestion.MessageType
MessageTypeCodeType Always Specifies the type of message. For example, AskSellerQuestion.

Applicable values: See MessageType.
ClientAlerts.ClientAlertEvent
  .AskSellerQuestion.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .AskSellerQuestion.Title.Value
string Always The title of the active listing on which the seller has received a question about from a potential bidder/buyer.
ClientAlerts.ClientAlertEvent
  .BestOffer
BestOfferEventType Conditionally Alert created when a bidder makes a best offer on an item opted into the Best Offer feature by the seller. Applies to Sellers.
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer
ClientAlertsBestOfferType Always A container of details about a best offer.
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer
  .BestOfferCodeType
BestOfferTypeCodeType Conditionally The best offer type.

Applicable values:

BuyerBestOffer
The buyer has placed best offer on the item.
BuyerCounterOffer
The buyer has made a counter offer.
CustomCode
Reserved for internal or future use.
SellerCounterOffer
The seller has made a counter offer.

ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer
  .BestOfferID.Value
string Conditionally An ID to distinguish this best offer from other best offers made on the item.
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer
  .BuyerMessage.Value
string Conditionally Text message that was provided by a buyer when placing a best offer. Max length: 500 (in bytes).
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer
  .BuyerUserID.Value
string Conditionally Unique eBay user ID for the user.
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer
  .ExpirationTime.Value
dateTime Conditionally Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer).
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer.Price
AmountType (double) Conditionally The amount of the best offer.
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer.Price
CurrencyCodeType Conditionally The amount of the best offer.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer.Quantity.Value
int Conditionally The number of items for which the buyer is making an offer.
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer
  .SellerMessage.Value
string Conditionally Text response to buyer from seller. Max length: 500 (in bytes).
ClientAlerts.ClientAlertEvent
  .BestOffer.BestOffer.Status
BestOfferStatusCodeType 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.

Applicable values: See Status.
ClientAlerts.ClientAlertEvent
  .BestOffer.EventType
ClientAlertsEventTypeCodeType Always Identifies the event that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .BestOffer.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .BestOffer.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined
BestOfferDeclinedEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when a seller rejects the buyer's best offer on an item opted into the Best Offer feature by the seller.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
ClientAlertsBestOfferType Always A container of details about a best offer.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .BestOfferCodeType
BestOfferTypeCodeType Conditionally The best offer type.

Applicable values:

BuyerBestOffer
The buyer has placed best offer on the item.
BuyerCounterOffer
The buyer has made a counter offer.
CustomCode
Reserved for internal or future use.
SellerCounterOffer
The seller has made a counter offer.

ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .BestOfferID.Value
string Conditionally An ID to distinguish this best offer from other best offers made on the item.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .BuyerMessage.Value
string Conditionally Text message that was provided by a buyer when placing a best offer. Max length: 500 (in bytes).
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .BuyerUserID.Value
string Conditionally Unique eBay user ID for the user.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .ExpirationTime.Value
dateTime Conditionally Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer).
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .Price
AmountType (double) Conditionally The amount of the best offer.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .Price
CurrencyCodeType Conditionally The amount of the best offer.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .Quantity.Value
int Conditionally The number of items for which the buyer is making an offer.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .SellerMessage.Value
string Conditionally Text response to buyer from seller. Max length: 500 (in bytes).
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.BestOffer
  .Status
BestOfferStatusCodeType 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.

Applicable values: See Status.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .BestOfferDeclined.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced
BestOfferPlacedEventType Conditionally Alert created for a subscribing buyer (or buyer's application) who makes a best offer on an item opted into the Best Offer feature by a seller.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
ClientAlertsBestOfferType Always A container of details about a best offer.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .BestOfferCodeType
BestOfferTypeCodeType Conditionally The best offer type.

Applicable values:

BuyerBestOffer
The buyer has placed best offer on the item.
BuyerCounterOffer
The buyer has made a counter offer.
CustomCode
Reserved for internal or future use.
SellerCounterOffer
The seller has made a counter offer.

ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .BestOfferID.Value
string Conditionally An ID to distinguish this best offer from other best offers made on the item.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .BuyerMessage.Value
string Conditionally Text message that was provided by a buyer when placing a best offer. Max length: 500 (in bytes).
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .BuyerUserID.Value
string Conditionally Unique eBay user ID for the user.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .ExpirationTime.Value
dateTime Conditionally Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer).
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .Price
AmountType (double) Conditionally The amount of the best offer.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .Price
CurrencyCodeType Conditionally The amount of the best offer.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .Quantity.Value
int Conditionally The number of items for which the buyer is making an offer.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .SellerMessage.Value
string Conditionally Text response to buyer from seller. Max length: 500 (in bytes).
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.BestOffer
  .Status
BestOfferStatusCodeType 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.

Applicable values: See Status.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .BestOfferPlaced.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .BidPlaced
BidPlacedEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when a user places a bid for an item.
ClientAlerts.ClientAlertEvent
  .BidPlaced.BidCount.Value
int Conditionally The number of bids that have been placed on the item.
ClientAlerts.ClientAlertEvent
  .BidPlaced.BuyItNowAvailable.Value
boolean Conditionally Indicates whether Buy It Now is available.
ClientAlerts.ClientAlertEvent
  .BidPlaced.CurrentPrice
AmountType (double) 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.
ClientAlerts.ClientAlertEvent
  .BidPlaced.CurrentPrice
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .BidPlaced.EndTime.Value
dateTime Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended).
ClientAlerts.ClientAlertEvent
  .BidPlaced.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .BidPlaced.GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .BidPlaced.HighBidderUserID.Value
string 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.
ClientAlerts.ClientAlertEvent
  .BidPlaced.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .BidPlaced.Quantity.Value
int Conditionally Number of items in the listing.
ClientAlerts.ClientAlertEvent
  .BidPlaced.ReserveMet.Value
boolean Conditionally Indicates whether any bids on this item are greater than the seller's reserve price for the listing (if any).
ClientAlerts.ClientAlertEvent
  .BidPlaced.SellerUserID.Value
string Conditionally eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .BidPlaced.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .BidPlaced.Title.Value
string Conditionally Name of the item as it appears in the listing or in search and browse results.
ClientAlerts.ClientAlertEvent
  .BidReceived
BidReceivedEventType Conditionally Alert created for a subscribing seller (or seller's application) when a user places a bid for an item.
ClientAlerts.ClientAlertEvent
  .BidReceived.BidCount.Value
int Conditionally The number of bids that have been placed on the item.
ClientAlerts.ClientAlertEvent
  .BidReceived.CurrentPrice
AmountType (double) 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.
ClientAlerts.ClientAlertEvent
  .BidReceived.CurrentPrice
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .BidReceived.EndTime.Value
dateTime Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended).
ClientAlerts.ClientAlertEvent
  .BidReceived.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .BidReceived.GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .BidReceived.HighBidderUserID.Value
string 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.
ClientAlerts.ClientAlertEvent
  .BidReceived.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .BidReceived.Quantity.Value
int Conditionally Number of items in the listing.
ClientAlerts.ClientAlertEvent
  .BidReceived.SellerUserID.Value
string Conditionally eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .BidReceived.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .BidReceived.Title.Value
string Conditionally Name of the item as it appears in the listing or in search and browse results.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
CounterOfferReceivedEventType Conditionally Alert created for a subscribing buyer (or buyer's application) 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.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer
ClientAlertsBestOfferType Always A container of details about a best offer.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.BestOfferCodeType
BestOfferTypeCodeType Conditionally The best offer type.

Applicable values:

BuyerBestOffer
The buyer has placed best offer on the item.
BuyerCounterOffer
The buyer has made a counter offer.
CustomCode
Reserved for internal or future use.
SellerCounterOffer
The seller has made a counter offer.

ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.BestOfferID.Value
string Conditionally An ID to distinguish this best offer from other best offers made on the item.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.BuyerMessage.Value
string Conditionally Text message that was provided by a buyer when placing a best offer. Max length: 500 (in bytes).
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.BuyerUserID.Value
string Conditionally Unique eBay user ID for the user.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.ExpirationTime.Value
dateTime Conditionally Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer).
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.Price
AmountType (double) Conditionally The amount of the best offer.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.Price
CurrencyCodeType Conditionally The amount of the best offer.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.Quantity.Value
int Conditionally The number of items for which the buyer is making an offer.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.SellerMessage.Value
string Conditionally Text response to buyer from seller. Max length: 500 (in bytes).
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .BestOffer.Status
BestOfferStatusCodeType 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.

Applicable values: See Status.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .CounterOfferReceived
  .Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .EndOfAuction
EndOfAuctionEventType Conditionally Alert created for a subscribing seller (or seller's application) 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.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.BidCount.Value
int Conditionally The total number of bids on the item.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.CurrentPrice
AmountType (double) Conditionally Price when the listing ended.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.CurrentPrice
CurrencyCodeType Conditionally Price when the listing ended.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.EndTime.Value
dateTime Conditionally Date and time when the listing ended.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.GalleryURL.Value
anyURI Conditionally URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Quantity.Value
int Conditionally Number of items in the transaction.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.SellerUserID.Value
string Conditionally The eBay ID of the seller who listed the item.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Title.Value
string Conditionally Name of the item as it appears in the listing or search results.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Transaction
ClientAlertsTransactionType Conditionally,
repeatable: [0..*]
Information about one transaction.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Transaction
  .AmountPaid
AmountType (double) Conditionally The amount the buyer paid for the item(s) in the transaction.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Transaction
  .AmountPaid
CurrencyCodeType Conditionally The amount the buyer paid for the item(s) in the transaction.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Transaction
  .BuyerUserID.Value
string Conditionally eBay user ID of the buyer.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Transaction
  .CreatedDate.Value
dateTime Conditionally Indicates the date and time a transaction was created.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Transaction
  .OrderLineItemID.Value
string Conditionally A unique identifier for every purchase from the seller. When a buyer purchases multiple items from the same listing, each item purchased will have an Order Line Item ID and all items in that purchase will have the same Order ID. OrderLineItemID is based upon the combination of the eBay Trading API's ItemID and TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen is the Transaction ID.
Max length: 100.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Transaction
  .QuantitySold.Value
int Conditionally Number of items purchased.
ClientAlerts.ClientAlertEvent
  .EndOfAuction.Transaction
  .TransactionID.Value
string Conditionally Unique identifier for a single transaction.
ClientAlerts.ClientAlertEvent
  .EventType
ClientAlertsEventTypeCodeType Always Type of client alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft
FeedbackLeftEventType Conditionally Alert created for a subscribing user (or user's application) when a user leaves feedback.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
ClientAlertsFeedbackDetailType Conditionally Container for details about feedback left.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .CommentingUser.Value
string Always eBay user ID for the user who left the feedback.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .CommentText.Value
string 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.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .CommentType
CommentTypeCodeType 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).

Applicable values: See CommentType.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .FeedbackID.Value
string Always Unique identifier for the feedback entry.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .FeedbackScore.Value
int Always Indicates the total feedback score for the user who made this feedback entry.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .ItemID.Value
string Always The ID that uniquely identifies the item listing.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .ItemPrice
AmountType (double) Always The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .ItemPrice
CurrencyCodeType Conditionally The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .ItemTitle.Value
string Always Name of the listing for which feedback was provided. Returned as CDATA.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .Role
TradingRoleCodeType Always Indicates whether the user who was the feedback recipient was a Buyer or the Seller for that transaction.

Applicable values:

Buyer
Acting as buyer.
CustomCode
Reserved for future use
Seller
Acting as seller.

ClientAlerts.ClientAlertEvent
  .FeedbackLeft.FeedbackDetail
  .TransactionID.Value
string Always Unique identifier for the transaction about which this feedback entry was left.
ClientAlerts.ClientAlertEvent
  .FeedbackLeft.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
FeedbackReceivedEventType Conditionally Alert created for a subscribing user (or user's application) when the user receives feedback.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail
ClientAlertsFeedbackDetailType Conditionally Container for details about feedback left, including User, CommentType, and Item.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.CommentingUser.Value
string Always eBay user ID for the user who left the feedback.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.CommentText.Value
string 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.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.CommentType
CommentTypeCodeType 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).

Applicable values: See CommentType.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.FeedbackID.Value
string Always Unique identifier for the feedback entry.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.FeedbackScore.Value
int Always Indicates the total feedback score for the user who made this feedback entry.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.ItemID.Value
string Always The ID that uniquely identifies the item listing.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.ItemPrice
AmountType (double) Always The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.ItemPrice
CurrencyCodeType Conditionally The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.ItemTitle.Value
string Always Name of the listing for which feedback was provided. Returned as CDATA.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.Role
TradingRoleCodeType Always Indicates whether the user who was the feedback recipient was a Buyer or the Seller for that transaction.

Applicable values:

Buyer
Acting as buyer.
CustomCode
Reserved for future use
Seller
Acting as seller.

ClientAlerts.ClientAlertEvent
  .FeedbackReceived
  .FeedbackDetail.TransactionID.Value
string Always Unique identifier for the transaction about which this feedback entry was left.
ClientAlerts.ClientAlertEvent
  .FeedbackReceived.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .FeedbackStarChanged
FeedbackStarChangedEventType Conditionally Alert created for a subscribing user (or user's application) when a user's feedback star level changes.
ClientAlerts.ClientAlertEvent
  .FeedbackStarChanged.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .FeedbackStarChanged.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .FeedbackStarChanged.User
ClientAlertsUserType Always Identifies eBay user.
ClientAlerts.ClientAlertEvent
  .FeedbackStarChanged.User
  .FeedbackRatingStar
FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType in the Trading API for specific values.

Applicable values: See FeedbackRatingStar.
ClientAlerts.ClientAlertEvent
  .FeedbackStarChanged.User
  .PositiveFeedbackPercent.Value
float 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.
ClientAlerts.ClientAlertEvent
  .FeedbackStarChanged.User
  .UserID.Value
string 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.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
EndOfTransactionEventType Conditionally Alert created for a subscribing seller (or seller's application) 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.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .BidCount.Value
int Conditionally The total number of bids the user placed on the item.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .CurrentPrice
AmountType (double) Conditionally Price when the listing ended.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .CurrentPrice
CurrencyCodeType Conditionally Price when the listing ended.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .EndTime.Value
dateTime Conditionally Date and time when the listing ended.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .GalleryURL.Value
anyURI Conditionally URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .SellerUserID.Value
string Conditionally The eBay ID of the seller who listed the item.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Title.Value
string Conditionally Name of the item as it appears in the listing or search results.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Transaction
ClientAlertsTransactionType Conditionally,
repeatable: [0..*]
Information about one transaction.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Transaction.AmountPaid
AmountType (double) Conditionally The amount the buyer paid for the item(s) in the transaction.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Transaction.AmountPaid
CurrencyCodeType Conditionally The amount the buyer paid for the item(s) in the transaction.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Transaction.BuyerUserID.Value
string Conditionally eBay user ID of the buyer.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Transaction.CreatedDate.Value
dateTime Conditionally Indicates the date and time a transaction was created.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Transaction.OrderLineItemID.Value
string Conditionally A unique identifier for every purchase from the seller. When a buyer purchases multiple items from the same listing, each item purchased will have an Order Line Item ID and all items in that purchase will have the same Order ID. OrderLineItemID is based upon the combination of the eBay Trading API's ItemID and TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen is the Transaction ID.
Max length: 100.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Transaction.QuantitySold.Value
int Conditionally Number of items purchased.
ClientAlerts.ClientAlertEvent
  .FixedPriceEndOfTransaction
  .Transaction.TransactionID.Value
string Conditionally Unique identifier for a single transaction.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
EndOfTransactionEventType Conditionally Alert created for a subscribing seller (or seller's application) 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.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .BidCount.Value
int Conditionally The total number of bids the user placed on the item.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .CurrentPrice
AmountType (double) Conditionally Price when the listing ended.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .CurrentPrice
CurrencyCodeType Conditionally Price when the listing ended.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction.EndTime.Value
dateTime Conditionally Date and time when the listing ended.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .GalleryURL.Value
anyURI Conditionally URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .SellerUserID.Value
string Conditionally The eBay ID of the seller who listed the item.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction.Title.Value
string Conditionally Name of the item as it appears in the listing or search results.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .Transaction
ClientAlertsTransactionType Conditionally,
repeatable: [0..*]
Information about one transaction.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .Transaction.AmountPaid
AmountType (double) Conditionally The amount the buyer paid for the item(s) in the transaction.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .Transaction.AmountPaid
CurrencyCodeType Conditionally The amount the buyer paid for the item(s) in the transaction.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .Transaction.BuyerUserID.Value
string Conditionally eBay user ID of the buyer.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .Transaction.CreatedDate.Value
dateTime Conditionally Indicates the date and time a transaction was created.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .Transaction.OrderLineItemID.Value
string Conditionally A unique identifier for every purchase from the seller. When a buyer purchases multiple items from the same listing, each item purchased will have an Order Line Item ID and all items in that purchase will have the same Order ID. OrderLineItemID is based upon the combination of the eBay Trading API's ItemID and TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen is the Transaction ID.
Max length: 100.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .Transaction.QuantitySold.Value
int Conditionally Number of items purchased.
ClientAlerts.ClientAlertEvent
  .FixedPriceTransaction
  .Transaction.TransactionID.Value
string Conditionally Unique identifier for a single transaction.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList
ItemAddedToWatchListEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when the buyer adds an item to her/his watch list.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList.BidCount.Value
int Conditionally The number of bids that have been placed on the item.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList
  .CurrentPrice
AmountType (double) 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.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList
  .CurrentPrice
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList.EndTime.Value
dateTime Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended).
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList
  .EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList
  .GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList.Quantity.Value
int Conditionally Number of items in the transaction.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList
  .SellerUserID.Value
string Conditionally eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList
  .Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemAddedToWatchList.Title.Value
string Conditionally Name of the item as it appears in the listing or in search and browse results.
ClientAlerts.ClientAlertEvent
  .ItemEnded
ItemEndedEventType 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).
ClientAlerts.ClientAlertEvent
  .ItemEnded.BidCount.Value
int Conditionally The total number of bids the user placed on the item.
ClientAlerts.ClientAlertEvent
  .ItemEnded.CurrentPrice
AmountType (double) Conditionally Price when the listing ended.
ClientAlerts.ClientAlertEvent
  .ItemEnded.CurrentPrice
CurrencyCodeType Conditionally Price when the listing ended.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .ItemEnded.EndTime.Value
dateTime Conditionally Date and time when the listing ended.
ClientAlerts.ClientAlertEvent
  .ItemEnded.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemEnded.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemEnded.Quantity.Value
int Conditionally Number of items in the transaction.
ClientAlerts.ClientAlertEvent
  .ItemEnded.SellerUserID.Value
string Conditionally The eBay ID of the seller who listed the item.
ClientAlerts.ClientAlertEvent
  .ItemEnded.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemEnded.Title.Value
string Conditionally Name of the item as it appears in the listing or search results.
ClientAlerts.ClientAlertEvent
  .ItemListed
ItemListedEventType Conditionally Alert created for a subscribing seller when a seller has listed an item. Sent for each item the seller lists.
ClientAlerts.ClientAlertEvent
  .ItemListed.CurrentPrice
AmountType (double) Conditionally Price when the item was listed, if known.
ClientAlerts.ClientAlertEvent
  .ItemListed.CurrentPrice
CurrencyCodeType Conditionally Price when the item was listed, if known.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .ItemListed.EndTime.Value
dateTime Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended).
ClientAlerts.ClientAlertEvent
  .ItemListed.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemListed.GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .ItemListed.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemListed.Quantity.Value
int Conditionally Number of items listed.
ClientAlerts.ClientAlertEvent
  .ItemListed.SellerUserID.Value
string Conditionally The eBay ID of the seller who listed the item.
ClientAlerts.ClientAlertEvent
  .ItemListed.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemListed.Title.Value
string Conditionally Name of the item as it appears in the listing or search results.
ClientAlerts.ClientAlertEvent
  .ItemLost
ItemLostEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when a user loses a bid for an item.
ClientAlerts.ClientAlertEvent
  .ItemLost.BidCount.Value
int Conditionally The number of bids that have been placed on the item.
ClientAlerts.ClientAlertEvent
  .ItemLost.CurrentPrice
AmountType (double) 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.
ClientAlerts.ClientAlertEvent
  .ItemLost.CurrentPrice
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .ItemLost.EndTime.Value
dateTime Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended).
ClientAlerts.ClientAlertEvent
  .ItemLost.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemLost.GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .ItemLost.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemLost.Quantity.Value
int Conditionally Number of items in the transaction.
ClientAlerts.ClientAlertEvent
  .ItemLost.SellerUserID.Value
string Conditionally eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .ItemLost.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemLost.Title.Value
string Conditionally Name of the item as it appears in the listing or in search and browse results.
ClientAlerts.ClientAlertEvent
  .ItemMarkedPaid
ItemMarkedPaidEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when item marked as paid by the seller.
ClientAlerts.ClientAlertEvent
  .ItemMarkedPaid.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemMarkedPaid.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemMarkedPaid.OrderID.Value
string Conditionally Unique identifier that eBay generates for the order.
ClientAlerts.ClientAlertEvent
  .ItemMarkedPaid.SellerUserID.Value
string Always eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .ItemMarkedPaid.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemMarkedPaid.Title.Value
string Conditionally The title of the listing marked as 'Paid'.
ClientAlerts.ClientAlertEvent
  .ItemMarkedPaid.TransactionID.Value
string Conditionally Identifies one transaction for a listing.
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped
ItemMarkedShippedEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when item marked as shipped by the seller.
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped.OrderID.Value
string Conditionally Unique identifier that eBay generates for the order.
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped
  .SellerUserID.Value
string Always eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped.Shipment
ClientAlertsShipmentType Conditionally Details about the shipment. Setting the tracking number and carrier automatically marks the item as shipped (sets Shipped to true).
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped.Shipment
  .ShipmentTrackingNumber.Value
string Conditionally The tracking number associated with the shipment. The format of the shipment tracking number must be consistent with the specified ShippingCarrierUsed.
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped.Shipment
  .ShippingCarrierUsed
ShippingCarrierCodeType Conditionally The shipping carrier used.

Applicable values:

UPS
United Parcel Service.
USPS
U.S. Postal Service.

(Not all values in ShippingCarrierCodeType apply to this field.)
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped.Title.Value
string Conditionally The title of the listing marked as 'Shipped'.
ClientAlerts.ClientAlertEvent
  .ItemMarkedShipped
  .TransactionID.Value
string Conditionally Identifies one transaction for a listing.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
ItemRemovedFromWatchListEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when the buyer removes an item from her/his watch list.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .BidCount.Value
int Always The number of bids that have been placed on the item.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .CurrentPrice
AmountType (double) 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.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .CurrentPrice
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .EndTime.Value
dateTime Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended).
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .Quantity.Value
int Conditionally Number of items in the transaction.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .SellerUserID.Value
string Conditionally eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemRemovedFromWatchList
  .Title.Value
string Conditionally Name of the item as it appears in the listing or in search and browse results.
ClientAlerts.ClientAlertEvent
  .ItemSold
ItemSoldEventType Conditionally Alert created for a subscribing seller (or seller's application) when one of their items is sold.
ClientAlerts.ClientAlertEvent
  .ItemSold.BidCount.Value
int Conditionally The number of bids that have been placed on the item.
ClientAlerts.ClientAlertEvent
  .ItemSold.CurrentPrice
AmountType (double) 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.
ClientAlerts.ClientAlertEvent
  .ItemSold.CurrentPrice
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .ItemSold.EndTime.Value
dateTime Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended).
ClientAlerts.ClientAlertEvent
  .ItemSold.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemSold.GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .ItemSold.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemSold.Quantity.Value
int Conditionally Number of items in the transaction.
ClientAlerts.ClientAlertEvent
  .ItemSold.SellerUserID.Value
string Conditionally eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .ItemSold.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemSold.Title.Value
string Conditionally Name of the item as it appears in the listing or in search and browse results.
ClientAlerts.ClientAlertEvent
  .ItemUnsold
ItemUnsoldEventType Conditionally Alert created for a subscribing seller (or seller's application) when an item was not sold.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.BidCount.Value
int Conditionally The number of bids that have been placed on the item.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.CurrentPrice
AmountType (double) 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.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.CurrentPrice
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.EndTime.Value
dateTime Conditionally Time stamp of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended).
ClientAlerts.ClientAlertEvent
  .ItemUnsold.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.Quantity.Value
int Conditionally Number of items in the transaction.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.SellerUserID.Value
string Conditionally eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemUnsold.Title.Value
string Conditionally Name of the item as it appears in the listing or in search and browse results.
ClientAlerts.ClientAlertEvent
  .ItemWon
ItemWonEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when a user buys an item.
ClientAlerts.ClientAlertEvent
  .ItemWon.BidCount.Value
int Conditionally The number of bids that have been placed on the item.
ClientAlerts.ClientAlertEvent
  .ItemWon.CurrentPrice
AmountType (double) 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.
ClientAlerts.ClientAlertEvent
  .ItemWon.CurrentPrice
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .ItemWon.EndTime.Value
dateTime Conditionally Time stamp of the actual end time.
ClientAlerts.ClientAlertEvent
  .ItemWon.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .ItemWon.GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .ItemWon.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .ItemWon.Quantity.Value
int Conditionally Number of items in the transaction.
ClientAlerts.ClientAlertEvent
  .ItemWon.SellerUserID.Value
string Conditionally eBay user ID of the seller.
ClientAlerts.ClientAlertEvent
  .ItemWon.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .ItemWon.Title.Value
string Conditionally Name of the item as it appears in the listing or in search and browse results.
ClientAlerts.ClientAlertEvent
  .Outbid
OutbidEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when another buyer has placed a higher maximum bid and the buyer is no longer the current high bidder.
ClientAlerts.ClientAlertEvent
  .Outbid.BidCount.Value
int Conditionally The total number of bids the user placed on the item.
ClientAlerts.ClientAlertEvent
  .Outbid.CurrentPrice
AmountType (double) Conditionally Price following outbid event.
ClientAlerts.ClientAlertEvent
  .Outbid.CurrentPrice
CurrencyCodeType Conditionally Price following outbid event.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .Outbid.EndTime.Value
dateTime Conditionally Date and time when the listing ended.
ClientAlerts.ClientAlertEvent
  .Outbid.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .Outbid.GalleryURL.Value
anyURI Conditionally URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified.
ClientAlerts.ClientAlertEvent
  .Outbid.HighBidderEIASToken.Value
string 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.
ClientAlerts.ClientAlertEvent
  .Outbid.HighBidderUserID.Value
string 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.
ClientAlerts.ClientAlertEvent
  .Outbid.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .Outbid.SellerUserID.Value
string Conditionally The eBay ID of the seller who listed the item.
ClientAlerts.ClientAlertEvent
  .Outbid.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .Outbid.Title.Value
string Conditionally Name of the item as it appears in the listing or search results.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer
SecondChanceOfferEventType Conditionally Alert created for a subscribing buyer (or buyer's application) 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.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer.BidCount.Value
int Conditionally The total number of bids the user placed on the item.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer
  .CurrentPrice
AmountType (double) Conditionally Price when the listing ended.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer
  .CurrentPrice
CurrencyCodeType Conditionally Price when the listing ended.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer.EndTime.Value
dateTime Conditionally Date and time when the listing ended.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer.EventType
ClientAlertsEventTypeCodeType Always Identifies the action that is the subject of the alert.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer.GalleryURL.Value
anyURI Conditionally URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer.Quantity.Value
int Conditionally Number of items in the listing.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer
  .SecondChanceOriginalItemID.Value
string 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.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer
  .SellerUserID.Value
string Conditionally The eBay ID of the seller who listed the item.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer.Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .SecondChanceOffer.Title.Value
string Conditionally Name of the item as it appears in the listing or search results.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
WatchedItemEndingSoonEventType Conditionally Alert created for a subscribing buyer (or buyer's application) when the listing of a watched item is about to end.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
  .BidCount.Value
int Conditionally The total number of bids the user placed on the item.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
  .CurrentPrice
AmountType (double) Conditionally Price when the listing ended.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
  .CurrentPrice
CurrencyCodeType Conditionally Price when the listing ended.

For a list of possible enumeration values, see CurrencyCodeType.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon.EndTime.Value
dateTime Conditionally Date and time when the listing ended.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
  .EventType
ClientAlertsEventTypeCodeType Always Defines all client alerts events that can be used.

Applicable values: See EventType.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
  .GalleryURL.Value
anyURI 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.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
  .HighBidderUserID.Value
string 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.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon.ItemID.Value
string Always Unique ID of the item that is the subject of the alert.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
  .SellerUserID.Value
string Conditionally The eBay ID of the seller who listed the item.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
  .Timestamp.Value
dateTime Always Time of most recent retrieval of data.
ClientAlerts.ClientAlertEvent
  .WatchedItemEndingSoon
  .ViewItemURL.Value
anyURI 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.
SessionData.Value string 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.
Standard Output Fields  
Ack AckCodeType Always Indicates whether the call was successfully processed by eBay.

Applicable values:

CustomCode
Reserved for internal or future use.
Failure
Request processing failed
Success
Request processing succeeded
Warning
Request processing completed with warning information being included in the response message

(Not all values in AckCodeType apply to this field.)
Build.Value string Always 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.
CorrelationID.Value string Conditionally 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.
Errors ErrorType Conditionally,
repeatable: [0..*]
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.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
Reserved for internal or future use.
RequestError
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
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.

See Errors by Number.

Errors.ErrorCode.Value 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 Errors by Number.

Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
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.

See Errors by Number.

Errors.ErrorParameters.Value.Value string Conditionally The value of the variable.
Errors.ErrorParameters.ParamID string Conditionally 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.
Errors.LongMessage.Value string Conditionally A more detailed description of the condition that raised the error.

See Errors by Number.

Errors.SeverityCode SeverityCodeType Conditionally 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.

Applicable values:

CustomCode
Reserved for internal or future use
Error
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.
Warning
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.

See:
    Errors by Number
    Checklist for Going Live for more information see the eBay Features Guide.

Errors.ShortMessage.Value string Conditionally A brief description of the condition that raised the error.

See Errors by Number.

Timestamp.Value 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 "dateTime" type for information about this time format and converting to and from the GMT time zone.
Version.Value string 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.

See Schema Versioning Strategy.



Samples

New to making API calls? Please see Making an API 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: Outbid

Retrieves new user alerts.

Description

Retrieves new user alerts.

Input

Requests any new user alerts. The session information (SessionID and SessionData) identifies the user and records when this call was last made.

URL format. See also the non-wrapped version of this URL.

http://clientalerts.ebay.com/ws/ecasvc/ClientAlerts?
   callname=GetUserAlerts&
   SessionID=MySessionID&
   Session Data=p0SVs0iK4imqkoKkI1D

Output

Returns a new user alert and refreshed SessionData.

JSON format. Also available is the .txt version of this JSON.

{
   "Timestamp":"2008-05-24T03:52:54.843Z",
   "Ack":"Success",
   "Build":"e565_core_Bundled_6412298_R1",
   "Version":"565",
   "Content":[
      {
         "ClientAlerts":"
        {
         \"EventType\":\"Outbid\",
         \"Timestamp\":\"2008-04-13T01:03:52.703Z\",
         \"ItemID\":\"190001080067\",
         \"BidCount\":2,
         \"HighBidderUserID\":\"i***7\",
         \"SellerUserID\":\"apitest20\",
         \"EndTime\":\"2008-04-20T01:02:45.000Z\",
         \"CurrentPrice\":
         {
           \"Value\":1.0,
           \"CurrencyID\":\"USD\"
         },
         \"MinimumToBid\":
         {
           \"Value\":1.25,
           \"CurrencyID\":\"USD\"
         }
        }",
         "LastModifiedDate":"2008-04-13T01:06:00.000Z"
      }
   ]
}



Change History

Change Date Description
777
2012-06-06
  • AskSellerQuestionEventType.Title (added): The title of the listing.
  • ItemMarkedPaidEventType.Title (added): The title of the listing.
  • ItemMarkedShippedEventType.Title (added): The title of the listing.
675
2010-06-23
  • ClientAlertsEventType.ItemListed (added): New user alert available for sellers.
601
2009-01-21
  • ClientAlertsEventType.ItemMarkedPaid, ClientAlertsEventType.ItemMarkedShipped (added): New user alerts available for buyers.
569
2008-06-11
  • (added) New call.