Informational Alerts

Account Activity Summary

A user can subscribe to receive an account activity summary via SMS. The user can specify the period (time range) for the account summary and can select how often the summary is to be sent.

This alert is not triggered by a direct event but rather by an eBay daemon process that monitors a subscription database.

Codelists, for your reference:

As noted in the following table, any period of activity can be returned on the user's choice of weekday. Periods that are 31 days or longer can also be returned via certain frequencies.

Table: Allowable Frequencies per Period
Window period Frequency
All periods
  • Weekly, on the weekday of the user's choosing (e.g. EveryTuesday).
31 days
  • Every31Days
Current month
  • On a selected date of every month (e.g. MonthlyOn4th).
Last month
  • On the first day of every month (the summary covers the previous month's activity): MonthlyOn1st
Last 60 days
  • Every60Days

Adding or Updating a Schedule

Use SummarySchedule in combination with UserDeliveryPreferenceArray.NotificationEnable to set EventType to AccountSummary and to set EventEnable to Enable. Also set UserData.SummarySchedule.EventType to AccountSummary, and set SummaryPeriod and Frequency as desired. To delete all schedules for a user, set EventEnable to Disable, and omit SummarySchedule from the UserData container (or omit the UserData container entirely).

The following example creates a new schedule for the user. Every Monday, the user will receive a summary of the last 31 days' activities.

Figure: Within SetNotificationPreferences: Creating/Adding
<UserDeliveryPreferenceArray>
  <NotificationEnable>
    <EventType>AccountSummary</EventType>
    <EventEnable>Enable</EventEnable>
  </NotificationEnable>
</UserDeliveryPreferenceArray>
<UserData>
  <SummarySchedule>
    <EventType>AccountSummary</EventType>
    <SummaryPeriod>Last31Days</SummaryPeriod>
    <Frequency>EveryMonday</Frequency>
  </SummarySchedule>
</UserData>

Deleting Schedules

To delete all schedules for a user, omit UserData from the call to SetNotificationPreferences:

Figure: Within SetNotificationPreferences: Deleting All
<UserDeliveryPreferenceArray>
  <NotificationEnable>
    <EventType>AccountSummary</EventType>
    <EventEnable>Disable</EventEnable>
  </NotificationEnable>
</UserDeliveryPreferenceArray>

To delete a specific schedule, set UserData.SummarySchedule.EventType to AccountSummary, and set SummaryPeriod and Frequency to match the schedule to be deleted.

The following example deletes the "EveryMonday, Last31Days" schedule for the user:

Figure: Within SetNotificationPreferences: Deleting Selected
<UserDeliveryPreferenceArray>
  <NotificationEnable>
    <EventType>AccountSummary</EventType>
    <EventEnable>Disable</EventEnable>
  </NotificationEnable>
</UserDeliveryPreferenceArray>
<UserData>
  <SummarySchedule>
    <EventType>AccountSummary</EventType>
    <SummaryPeriod>Last31Days</SummaryPeriod>
    <Frequency>EveryMonday</Frequency>
  </SummarySchedule>
</UserData>

To delete all schedules matching a particular frequency regardless of summary period, set Frequency to that particular frequency and omit SummaryPeriod.

The following example deletes all of the user's schedules for Monday:

Figure: Within SetNotificationPreferences: Deleting Selected
<UserDeliveryPreferenceArray>
  <NotificationEnable>
    <EventType>AccountSummary</EventType>
    <EventEnable>Disable</EventEnable>
  </NotificationEnable>
</UserDeliveryPreferenceArray>
<UserData>
  <SummarySchedule>
    <EventType>AccountSummary</EventType>
    <Frequency>EveryMonday</Frequency>
  </SummarySchedule>
</UserData>

Similarly, you can delete all schedules matching a SummaryPeriod by providing SummaryPeriod and omitting Frequency.

Copyright © 2005–2016 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.