Dokumentation ZapWare - Zapier Integration (Plugin für Shopware)

Link zum Plugin: http://bit.ly/netzperfekt-zapware

Shopware mit dem Rest der Welt verbinden. ZapWare ist die Zapier-Integration für Shopware - verknüpfe über 1.000 weitere Apps mit Deinem Shopware-Shop und automatisiere die Abläufe!

Installation und Einrichtung

Neben dem Shopware-Plugin ist ein (unter Umständen kostenpflichtiger) Account bei zapier.com notwendig.

 Installation
  • Das Shopware-Plugin wie gewohnt installieren und aktivieren. Eine Konfiguration ist hier nicht notwendig, die zapier-Integration kann jedoch in den Plugin-Einstellungen global deaktiviert werden.
  • Im Backend einen API-Nutzer anlegen (Einstellungen / Nutzerverwaltung), bitte in die Rolle local_admins aufnehmen. Wichtig: den API-Zugriff aktivieren.
  • Account bei zapier.com anlegen
  • Wichtig: Um die Zapier-Integration nutzen zu können, müssen wir den Zugriff in der Beta-Phase zunächst freischalten (das wird später dann nicht mehr notwendig sein), bitte eine kurze E-Mail an info@netzperfekt.de senden.
  • In zapier nun einen neuen ZAP anlegen und Shopware als App auswählen. Dann bei der Autorisierung die URL des Shopware-Shops, den Nutzernamen und API-Key eintragen. 
  • zapier stellt eine ausführliche Hilfe und Anleitung zur Verfügung.

Wir können leider keinen Support für zapier leisten!

Trigger

Trigger sind auslösende Ereignisse in Shopware. Dabei stehen sowohl Trigger für das Backend als auch für Ereignisse im Frontend zur Verfügung:

Backend-Trigger

  • article.new: Löst bei der Neuanlage eines Artikels im Backend aus.
  • article_update: Löst bei der Änderung eines Artikels im Backend aus.
  • article.delete: Löst beim Löschen eines Artikels im Backend aus.
  • customer_new: Löst bei der Neuanlage eines Kunden im Backend aus.
  • customer_update: Löst bei der Änderung eines Kunden im Backend aus.
  • customer_delete: Löst beim Löschen eines Kunden im Backend aus.


Frontend-Trigger

  • customer_register: Wird ausgelöst, wenn ein Kunde sich im Frontend des Shops neu registriert.
  • order_new: Wird bei einer neuen Bestellung im Frontend ausgelöst.
  • rating_new: Wird bei einer neuen Artikel-Bewertung im Frontend ausgelöst (unabhängig von der Freigabe der Bewertung im Backend). 
  • voucher_cashed: Wird beim Einlösen eines Gutscheins im Frontend ausgelöst.
  • stock_low: Wird bei Unterschreiten des hinterlegten Lagerbestands ausgelöst.
  • account_changeprofile: Wird bei einer Änderung des Nutzernamens oder der E-Mailadresse im Kundenaccount ausgelöst.
  • account_changeaddress: Löst bei der Änderung einer (Liefer- oder Rechnungs-)Adresse im Kundenaccount aus.
  • newsletter_subscribed: Löst bei der Anmeldung für den Newsletter im Frontend aus.


Actions

Derzeit stehen folgende Actions zur Verfügung. Hiermit lassen sich Aufgaben in Shopware über Zapier anstossen bzw. steuern:


Set Global Message: setzt (oder löscht) eine globale Shopmitteilung, diese wird oberhalb jeder Seite angezeigt. Parameter: msg


Die nachfolgenden Aktionen orientieren sich am REST API von Shopware (vgl. die Shopware-Dokumentation). Die Parameter und Rückgabewerte sind identisch.

Customer List: ruft eine Liste von Kunden ab. 

Parameter: offset, limit, criteria, order 

Beispielaufruf: 

   "offset": 0, 
   "limit": 25, 
   "criteria": { 
      "property": "firstname", 
      "value": "Mustermann" 
   }, 
   "order": { 
      "property": "lastname", 
      "direction": "DESC" 
   } 
}

Hinweis: derzeit wird nur jeweils maximal ein Filterkriterium sowie eine Sortierung unterstützt.


Customer Get: ruft einen Kundendatensatz ab.

Parameter: number

Beispielaufruf: 
{ 
   "number": "20001"   
}


Customer Create: erzeugt einen neuen Kundendatensatz. 

Beispielaufruf: 
siehe https://developers.shopware.com/developers-guide/rest-api/examples/customer/#example-3-create-customer


Customer Update: aktualisiert einen Kundendatensatz

Beispielaufruf: 
{ 
   "number": "20001",
   "payload": { ... } 
}

Weitere Parameter (payload) siehe https://developers.shopware.com/developers-guide/rest-api/examples/customer/#example-5-update-specific-customer


Customer Delete: löscht einen Kundendatensatz

Parameter: number

Beispielaufruf: 
{ 
   "number": "20001"   
}


Order List
Order Get
Order Create
Order Update
Order Delete
analog für Bestellungen


Wir wünschen Ihnen viel Erfolg 
mit unserem Plugin und 
gute Geschäfte mit Shopware.