Skip to main content

A WatchedItemEndingSoon notification is sent to a subscribed buyer or application when the listing of the watched item is about to end. This notification includes a TimeLeft property that allows the buyer to specify when the notification is sent based on how much time is left before the listing ends.

Platform Choice

When a user requests, via the notification preferences web page, to be notified of this event, the default is for the notification to be sent via API ("Platform"). The user can choose instead to be notified via wireless ("SMS").

Additional Steps for WatchedItemEndingSoon Subscription

On the eBay web site notifications preferences page, a user can request to be notified about items ending soon and can set the amount of time prior to the end of the listing. A user can also subscribe via API.

In addition to the typical steps for setting notification preferences, there are a few more steps for subscribing a user for the WatchedItemEndingSoon notification:

  1. Set EventProperty.EventType to WatchedItemEndingSoon.
  2. Set EventProperty.Name to TimeLeft.
  3. Set EventProperty.Value to the number of minutes before the end of the listing that the user is to be notified.

Data Fields Returned

API Call that displays this notification: GetItem

The data fields returned by the WatchedItemEndingSoon notification are essentially the same as those returned by GetItem. Refer to the GetTokenStatus call reference documentation for additional information.

The ItemArray container will contain at most one Item container. If there is no item matching the submitted ItemID, no ItemArray container will be returned. If the listing ended, TimeLeft will be PT0S.

Refer to SOAP Message Body for information about the standard elements returned for all notifications.

Example

Sample WatchedItemEndingSoon Notification 

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="https://www.w3.org/2001/XMLSchema"
    xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <ebl:RequesterCredentials soapenv:mustUnderstand="0"
        xmlns:ns="urn:ebay:apis:eBLBaseComponents"
        xmlns:ebl="urn:ebay:apis:eBLBaseComponents">
      <ebl:NotificationSignature>a********=</ebl:NotificationSignature>
    </ebl:RequesterCredentials>
  </soapenv:Header>
  <soapenv:Body>
    <GetItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
      <Timestamp>2007-03-09T19:18:08.284Z</Timestamp>
      <Ack>Success</Ack>
      <Version>505</Version>
      <Build>e505_core_API_32243_90</Build>
      <NotificationEventName>WatchedItemEndingSoon</NotificationEventName>
      <WatchList>
        <ItemArray>
          <Item>
            <BuyItNowPrice currencyID="USD">10.0</BuyItNowPrice>
            <ItemID>4********1</ItemID>
            <ListingDetails>
              <StartTime>2007-03-08T20:57:14.000Z</StartTime>
              <EndTime>2007-03-15T20:57:14.000Z</EndTime>
            </ListingDetails>
            <Seller>
              <UserID>s********r</UserID>
            </Seller>
            <SellingStatus>
              <CurrentPrice currencyID="USD">10.0</CurrentPrice>
            </SellingStatus>
            <Site>US</Site>
            <TimeLeft>P6DT1H39M6S</TimeLeft>
            <Title>SDK item title</Title>
            <QuantityAvailable>1</QuantityAvailable>
          </Item>
        </ItemArray>
        <PaginationResult>
          <TotalNumberOfPages>1</TotalNumberOfPages>
          <TotalNumberOfEntries>1</TotalNumberOfEntries>
        </PaginationResult>
      </WatchList>
    </GetItemResponse>
  </soapenv:Body>
</soapenv:Envelope>