Stock Alerts

Über

Dieses Plugin ueberwacht den Bestand von Produkten und Varianten in einer Payload-E-Commerce-Umgebung und sendet genau eine E-Mail, wenn der Lagerbestand einen konfigurierbaren Schwellenwert nach unten unterschreitet. Es ist fuer den Einsatz mit `@payloadcms/plugin-ecommerce` gedacht, funktioniert aber mit jeder Collection, die ein `inventory`-Feld hat. Die Benachrichtigung wird nur einmal pro Unterschreitung gesendet, nicht bei jedem Speichern: Beim Senden der Warnung wird ein Datum in `lowStockNotifiedAt` gesetzt, das geloescht wird, sobald der Bestand wieder ueber den Schwellenwert steigt. Dadurch ist die naechste Unterschreitung wieder scharfgestellt. Weil das offizielle E-Commerce-Plugin den Bestand nach einer Bestellung ueber `payload.db.updateOne` verringert und dieser Aufruf Collection-Hooks komplett umgeht, setzt das Plugin zusaetzlich auf `afterChange` bei der Orders-Collection. Bei einer neuen Bestellung berechnet es den aktuellen Bestand minus bestellter Menge und benachrichtigt auf Basis dieses prognostizierten Wertes. Ein `beforeValidate`-Hook verweigert negative Bestaende bei Schreibvorgaengen ueber Payload, kann aber den direkten Datenbank-Update des offiziellen Plugins nicht blockieren. Ein Verkauf kann den Bestand trotzdem unter Null druecken, dieser Zustand wird als `out-of-stock` gemeldet. Das Plugin fuegt jedem Produkt- und Varianten-Dokument ein schreibgeschuetztes virtuelles Feld `stockStatus` hinzu. Die moeglichen Werte sind `in-stock`, `low-stock`, `out-of-stock` und `backorder`. So kann ein Storefront den Backorder-Status anzeigen, ohne eine zweite Abfrage zu benoetigen. Unter `/api/stock-alerts` werden zwei REST-Endpunkte bereitgestellt: `GET /low-stock` gibt die aktuelle Liste der niedrigen Bestaende zurueck, `POST /check` prueft alle Artikel unter dem Schwellenwert, die noch nicht markiert wurden, und sendet Benachrichtigungen. Beide Endpunkte sind durch eine `isAdmin`-Access-Pruefung abgesichert, die standardmaessig nach der Rolle `admin` sucht. Der E-Mail-Versand erfolgt ueber `payload.sendEmail`. Das Plugin hat keinen eigenen Mail-Adapter und keine Runtime-Abhaengigkeiten, sondern nutzt die im Projekt bereits konfigurierte Mail-Integration. Pro Artikel lassen sich individuelle Werte setzen: ein numerisches Feld `lowStockThreshold` und eine Checkbox `allowBackorder`. Ohne diese Werte greifen die Store-weiten Standardwerte. Exportierte Helper wie `findLowStock`, `checkStock`, `stockStatus`, `crossedDown`, `decideNotification` und `resolveConfig` ermoeglichen eigene Erweiterungen.

Paketinformationen

Paketname

payload-stock-alerts

Neueste Version

1.0.0

Entpackte Größe

36 kB

Lizenz

MIT

Wöchentliche Downloads

1

Zuletzt veröffentlicht

21. Aug. 2026