Square Sync

Über

Das Plugin verbindet ein Square-Konto mit einem Payload-Projekt und spiegelt den Square-Katalog in lokale Collections. Beim Start von Payload führt `onInit` eine Synchronisierung durch, die nacheinander Kategorien, Modifier-Listen, Items und Bestandsdaten über das Square Node.js SDK abruft. Die Daten landen in fünf Collections: `square-categories`, `square-items`, `square-item-variations`, `square-modifier-lists` und `square-inventory`. Square bleibt die einzige Datenquelle. Die generierten Collections deaktivieren das Anlegen und Löschen von Einträgen, und die synchronisierten Felder sind schreibgeschützt. Jede Collection stellt einen Endpunkt `GET /api/{slug}/refresh` bereit. Über eine React-Client-Komponente in der `beforeList`-Ansicht fügt das Plugin einen Refresh-Button in das Admin-Interface ein, mit dem sich eine einzelne Collection manuell neu synchronisieren lässt. Für Live-Updates registriert das Plugin den Endpunkt `POST /api/square-webhook`. Eingehende Square-Webhooks werden mit `WebhooksHelper.verifySignature` gegen den konfigurierten Signature-Key geprüft. Das Plugin behandelt zwei Ereignistypen: `catalog.version.updated` synchronisiert Kategorien, Modifier und Items neu, `inventory.count.updated` aktualisiert den Bestand. Ereignistypen und Webhook-URL müssen mit der Konfiguration im Square Developer Dashboard übereinstimmen. Die Konfiguration erfolgt über ein Options-Objekt mit `accessToken` (erforderlich), `environment` (Standard: Sandbox), `debug`, `enabled` und einem optionalen `webhooks`-Block mit `signatureKey`, `url` und `events`. Als Peer-Dependencies werden `payload` ab Version 3.59.1, `next` ab 15.5.5, `react` ab 19 und das `square`-SDK ab Version 40 benötigt. Das Plugin behandelt ausschließlich Katalog- und Bestandssynchronisierung, nicht aber Checkout, Zahlungen oder Bestellungen.

Paketinformationen

Paketname

payloadcms-plugin-square

Neueste Version

1.3.0

Entpackte Größe

164 kB

Lizenz

MIT

Wöchentliche Downloads

150

Zuletzt veröffentlicht

14. Okt. 2025