Notification Catch-up API

Configure delivered-email catch-up limits and understand how historical, superseded, and stale shipment notifications are suppressed.

Platform Email Preferences

GET/api/v1/notification-rules/platform-preferences
PUT/api/v1/notification-rules/platform-preferences

These merchant-authenticated routes read or update platform-account email preferences. The update body contains the supported preference keys as booleans. They do not control WooCommerce customer shipment templates.

Delivered Catch-up Preference

GET/api/v1/notification-rules/catchup-preferences
PUT/api/v1/notification-rules/catchup-preferences

Owners/admins can choose 0, 24, 48, or 72 hours. Zero disables delayed delivered catch-up only; fresh real-time delivered notifications remain eligible.

Suppression Policy

  • Initial historical baseline states are suppressed.
  • Queued states that are no longer current are suppressed.
  • Freshness is 12 hours for out for delivery, 48 hours for available for pickup, and 24 hours for other non-delivered states.
  • Delivered uses the merchant's configured catch-up age.
  • Eligible catch-up sends are throttled to 10 per store per minute.

Public/Internal Notification Route

POST/api/v1/notification-rules/ses-notifications

The SES/SNS-shaped receiver processes bounce and complaint events so affected email addresses can be suppressed from future sends. It must not be exposed in production until it verifies the full SNS signature, allowlists the expected topic ARN, and deduplicates replayed messages; use an independently verified bounce consumer in the meantime.