WebshopApi: Dokumentation aktualisiert
[kivitendo-erp.git] / doc / html / ch03s09.html
1 <html><head>
2       <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
3    <title>3.9. Webshop-Api</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1-RC2"><link rel="home" href="index.html" title="kivitendo 3.5.0: Installation, Konfiguration, Entwicklung"><link rel="up" href="ch03.html" title="Kapitel 3. Features und Funktionen"><link rel="prev" href="ch03s08.html" title="3.8. Dateiverwaltung (Mini-DMS)"><link rel="next" href="ch04.html" title="Kapitel 4. Entwicklerdokumentation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.9. Webshop-Api</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch03s08.html">Zurück</a>&nbsp;</td><th width="60%" align="center">Kapitel 3. Features und Funktionen</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch04.html">Weiter</a></td></tr></table><hr></div><div class="sect1" title="3.9. Webshop-Api"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e6559"></a>3.9. Webshop-Api</h2></div></div></div><p>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
4       Onlineshopbestellungen zu verwalten und zu bearbeiten.</p><p>Es ist Multishopfähig, d.h. Artikel können mehreren oder
5       unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
6       mehreren Shops geholt werden.</p><p>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
7       Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
8       werden.</p><div class="sect2" title="3.9.1. Installationvorraussetzungen"><div class="titlepage"><div><div><h3 class="title"><a name="d0e6568"></a>3.9.1. Installationvorraussetzungen</h3></div></div></div><p>In der Datenbank <code class="literal">template1</code> muss die
9         Unterstützung für die trigram-Extension eingerichet werden. Melden Sie
10         sich dafür als Benutzer “postgres” an der Datenbank an:
11         </p><pre class="programlisting">su - postgres
12 psql template1</pre><p>
13             </p><p>führen Sie die folgenden Kommandos aus:</p><pre class="programlisting">CREATE EXTENSION IF NOT EXISTS pg_trgm;
14 \q</pre><p>Für bestehende Datenbanken muss die Extension in der Datenbank
15         angelegt werden</p><pre class="programlisting">su - postgres
16 psql DATENBANKNAME</pre><pre class="programlisting">CREATE EXTENSION IF NOT EXISTS pg_trgm;
17 \q</pre></div><div class="sect2" title="3.9.2. Rechte für die Webshopapi"><div class="titlepage"><div><div><h3 class="title"><a name="d0e6589"></a>3.9.2. Rechte für die Webshopapi</h3></div></div></div><p>In der Administration können folgende Rechte vergeben
18         werden</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Webshopartikel anlegen und bearbeiten</p></li><li class="listitem"><p>Shopbestellungen holen und bearbeiten</p></li><li class="listitem"><p>Shopbestellungen holen und bearbeiten</p></li></ul></div></div><div class="sect2" title="3.9.3. Konfiguration"><div class="titlepage"><div><div><h3 class="title"><a name="d0e6604"></a>3.9.3. Konfiguration</h3></div></div></div><p>Unter System-&gt;Webshops können Shops angelegt und konfiguriert
19         werden</p><div class="mediaobject"><img src="images/Shop_Listing.png"></div></div><div class="sect2" title="3.9.4. Webshopartikel"><div class="titlepage"><div><div><h3 class="title"><a name="d0e6612"></a>3.9.4. Webshopartikel</h3></div></div></div><div class="sect3" title="3.9.4.1. Shopvariablenreiter in Artikelstammdaten"><div class="titlepage"><div><div><h4 class="title"><a name="d0e6615"></a>3.9.4.1. Shopvariablenreiter in Artikelstammdaten</h4></div></div></div><p>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
20           Markers <span class="bold"><strong>"Shopartikel" in den Basisdaten
21           </strong></span>zeigt sich der Reiter "Shopvariablen" in den
22           Artikelstammdaten. Hier können jetzt die Artikel mit
23           unterschiedlichen Beschreibung und/oder Preisen für die
24           konfigutierten Shops angelegt und bearbeitet werden. An dieser
25           Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
26           werden. Artikelbilder gelten für alle Shops.</p><div class="mediaobject"><img src="images/Shop_Artikel.png"></div><p>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
27           ist es möglich einen Artikel auch mehreren Gruppen
28           zuzuordenen</p></div><div class="sect3" title="3.9.4.2. Shopartikelliste"><div class="titlepage"><div><div><h4 class="title"><a name="d0e6628"></a>3.9.4.2. Shopartikelliste</h4></div></div></div><p>Unter dem Menu Webshop-&gt;Webshop Artikel hat man nochmal
29           eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
30           unter verschiedenen Kriterien &lt;alles&gt;&lt;nur Preis&gt;&lt;nur
31           Bestand&gt;&lt;Preis und Bestand&gt; an die jeweiligen Shops
32           hochzuladen.</p><div class="mediaobject"><img src="images/Shop_Artikel_Listing.png"></div></div></div><div class="sect2" title="3.9.5. Bestellimport"><div class="titlepage"><div><div><h3 class="title"><a name="d0e6636"></a>3.9.5. Bestellimport</h3></div></div></div><p>Unter dem Menupunkt Webshop-&gt;Webshop Import öffnet sich die
33         Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
34         Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
35         einzeln als Auftrag zu transferieren. Die Liste kann nach
36         verschiedenen Kriterien gefiltert werden.</p><div class="mediaobject"><img src="images/Shop_Bestell.png"></div><p>Bei Einträgen in der Liste.</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
37             der Datensatz konnte nicht eindeutig zugewiesen werden.</p></li><li class="listitem"><p>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
38             offene Posten und kann deswegen nicht im Stapel übernommen
39             werden.</p></li><li class="listitem"><p>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
40             einem Datensatz zugeordnet werden. Die Shopbestellung kann im
41             Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
42             übernommen werden.</p></li><li class="listitem"><p>Kundennummer vorhanden, aber die Checkbox "Auftrag
43             erstellen" fehlt. Der Kunde hat vermutlich eine
44             Shopauftragssperre.</p></li><li class="listitem"><p>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
45             sich um eine unterschiedliche Lieferadresse handelt.
46             Lieferadressen werden aber grundsätzlich beim Transferieren zu
47             Aufträgen mit übernommen.</p></li><li class="listitem"><p>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
48             tooltip zu den Positionen.</p></li></ul></div><p>Maske Auftrag erstellen</p><p>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
49         Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
50         können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
51         dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
52         die Werte Formulareingabe übernommen. Es wird bei einer Änderung
53         allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
54         Shopbestellung bleibt bestehen.</p><p>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
55         kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
56         überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
57         umgezogen ist.</p><p>Im mittleren Bereich das Adresslisting zeigt:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
58             muss zuerst deaktiviert werden bevor ich diesem Kunden eine
59             Shopbestellung zuordnen kann.</p></li><li class="listitem"><p>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
60             in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
61             auch der Grund für die Auftragssperre sein.</p></li><li class="listitem"><p>Die Buttons "Auftrag erstellen" und "Kunde mit
62             Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
63             aus dem Listing ausgewählt ist.</p></li><li class="listitem"><p>Es ist aber möglich die Shopbestellung zu löschen.</p></li><li class="listitem"><p>Ist eine Bestellung schon übernommen, zeigen sich an dieser
64             Stelle, die dazugehörigen Belegverknüpfungen.</p></li></ul></div></div><div class="sect2" title="3.9.6. Mapping der Daten"><div class="titlepage"><div><div><h3 class="title"><a name="d0e6689"></a>3.9.6. Mapping der Daten</h3></div></div></div><p>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
65         der Datei SL/ShopConnector/&lt;SHOPCONNECTORNAME&gt;.pm
66         z.B.:SL/ShopConnector/Shopware.pm</p><p>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
67         die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
68         Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
69         gibt es hier eine sehr gute Dokumentation: <a class="ulink" href="https://developers.shopware.com/developers-guide/rest-api/" target="_top">https://developers.shopware.com/developers-guide/rest-api/</a>
70             </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch03s08.html">Zurück</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch03.html">Nach oben</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch04.html">Weiter</a></td></tr><tr><td width="40%" align="left" valign="top">3.8. Dateiverwaltung (Mini-DMS)&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td><td width="40%" align="right" valign="top">&nbsp;Kapitel 4. Entwicklerdokumentation</td></tr></table></div></body></html>