GetUserAlerts

Retrieves alerts privately subscribed to by the user.

Note: All methods of the Client Alerts API will be decommisioned on May 31, 2023. The alternative for this API is Platform Notifications, which supports all notification event types supported by Client Alerts API.

For anyone that is not familiar with Platform Notifications, we recommend that you read the Platform Notifications Guide to get started.

See also the reference documentation for these calls:

• GetPublicAlerts - Retrieves a list of public channel messages. Input should be in name-value pair format.
• Login - Logs the client application in to the client alerts server. All subsequent GetUserAlerts calls will require the SessionID returned by this call. The SessionData element returned by this call includes a timestamp to keep track of when alerts have been retrieved. Request should be in name- value pair format. Return will be in JSON.
• Logout - Logs the client application out of the client alerts server. Input should be in name-value pair format. Output will be in JSON.

Input

See also Samples.

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

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

{
  /* 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,
}

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

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=M*********D&
   Session
Data=p*****************D

Output

Returns a new user alert and refreshed SessionData.

JSON format.
{
   "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\":\"1**********7\",
         \"BidCount\":2,
         \"HighBidderUserID\":\"i***7\",
         \"SellerUserID\":\"a*******0\",
         \"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