Dokumentation Winestro-Shop API

Die Schnittstelle basiert ursprünglich auf XML und wird live in json bei Bedarf umgeformt - wir bitten um Verständnis, dass daher auch manche Werte wie int ggf. als String übergeben werden. Dies ist notwendig um eine Rückwärts-Kompatibilität mit allen verbundenen System zu sichern.

Geht eine Version von BETA auf RELEASE, wird diese nicht mehr (außer im Fall von Fehlern) angepasst / erweitert. Durch den Time-Freeze bleiben die API-Endpoints seit Version 1 ca. 2011 stabil und nutzbar).

Alle Anfragen können an den Endpoint gestellt werden entweder als Post oder Get-Variante. Der Endpoint antwortet mit einem Status-Code und ggf. einem Return-Wert oder Fehlermeldung.

Die links angegebenen Parameter sind bei jedem Aufruf der Schnittstelle zwingend nötig. Sie werden zur Authentifizierung genutzt. Die Codes und User-Informationen finden Sie in den Angaben über jedem für Sie nach Einweisung freigegeben Shop im Developer-Center. Alternativ können Sie diese Informationen vom Weinbau-online.de Team erhalten. Diese Informationen werden zur Sicherheit ausschließlich an das Weingut herausgegeben. https://weinstore.net/xml/v21.0/wbo-API.php?UID=[UID]&apiUSER=[API_USER]&apiCODE=[AUTH_CODE]&apiShopID=1 [...]

[...] &apiACTION=[AKTION] [....] &[PARAMETER]=[VALUE]

		<fehler>
			<text> Fehler: Keine ID / Parameter übergeben!</text>
		</fehler>
		

https://weinstore.net/xml/v21.0/wbo-API.php?UID=[UID]&apiUSER=[API_USER]&apiCODE=[AUTH_CODE]&apiShopID=1&encoding=&output=json

Fügt einen neuen Webshop-Auftrag in die Datenbank des Kunden ein. Der Auftrag wartet dann auf ein Datenclearing seitens des Weinguts. https://weinstore.net/xml/v21.0/wbo-API.php?UID=[UID]&apiUSER=[API_USER]&apiCODE=[AUTH_CODE]&apiShopID=1&apiACTION=newOrder &anrede=0&name=Max&nname=Mustermann&email=max@mustermann.de&strasse=Musterweg&hnr=1&plz=12345&ort=Musterstadt&land=DE&telefon=&firma=&sendDoi=&zahlung=&l_adr=&l_anrede=&l_firma=&l_vorname=&l_name=&l_strasse=&l_plz=&l_ort=&l_land=DE&l_hnummer=&id_lieferart=&kto=&ktoInh=&blz=&iban=&bic=&gutscheincode=&gutscheinwert=0&gebuehr=0&referenz=&versandkosten=0&positionen=1&wein_anzahl1=[ANZAHL]&wein_id1=[WEINNR]

	$url = 'https://weinstore.net/xml/v21.0/wbo-API.php';
	$myvars = 'UID=' . $myUserID . '&apiUSER=' . $myApiUserId; // ... usw.

	$ch = curl_init( $url );
	curl_setopt( $ch, CURLOPT_POST, 1);
	curl_setopt( $ch, CURLOPT_POSTFIELDS, $myvars);
	curl_setopt( $ch, CURLOPT_FOLLOWLOCATION, 1);
	curl_setopt( $ch, CURLOPT_HEADER, 0);
	curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);

	$response = curl_exec( $ch );

				

	<auftrag>
		<status>ok</status>
		<nr>[AUFTRAGSNR]</nr>
	</auftrag>
				

Gibt eine Liste aller Kunden aus die in einer bestimmten Gruppe sind. Erwartet einen Suchstring und oder / eine ID der Gruppe. Die Gruppen-IDs können via getAdrGroup abgerufen werden.

Sendet eine Double-Optin Mail an den Kunden und startet den DOI-Prozess in Winestro. Die Mailvorlage kann in den Systemeinstellungen angepasst werden. Der Kunde muss die Mail bestätigen und erscheint dann in den akzeptierten DOIs im Bereich E-Mail

Fügt einen neuen Wein in die Datenbank ein. Die Weinnr muss noch frei sein und sollte dem gültigen Schema für Weinnummern entsprechen: Alphanummerisch, keine Leerschritte, Trenner für Abfüllungen ist + (%B20), Groß- und Kleinschreibung beachten!

Gibt alle Artikelgruppen zurück in denen bei der übergebenen apiShopID ein Artikel eingestellt wurde. Ist kein Artikel für den Shop / diese API in der Gruppe wird sie auch nicht ausgeliefert.

Gibt alle Warengruppen zurück die Folgende vorausetzungen erfüllen: Es gibt Artikel in Preisliste des Shops die eine Warengruppe zugeordnet haben.

Gibt alle Warengruppen-Kategorien zurück die Folgende vorausetzungen erfüllen: - Warengruppen Kategorie ist erstellt und Aktiv
- Eine Warengruppe ist in einer Warengruppen Kategorie, die Warengruppe muss wiederrum einem Artikel zugeordnet sein.

gibt alle aktiven Gutscheine zurück, die auch in den aktuellen Zeitraum fallen / noch aktiv sind.

Gibt die Einstellungen des Shop's zurück, wie z.B. Versandkosten.

Gibt die Artikel in einer Artikelgruppe, einer Suche oder eine NR. zurück die mit übergeben wird.
Die Parameter dieser Funktion arbeiten Additiv: Sie werden in entsprechender Reihenfolge aufgebaut

1. Kein Parameter: Alle Weine des Shops werden ausgeliefert
2. id_grp: Alle Weine des Shops einer Artikelgruppe werden ausgeliefert
3. suchstring: Die Felder Artikelname, Artikelbeschreibung, Weinnr und Geschmack werden mit einem OR / LIKE durchsucht
4. artikelnr: AND die exakte Artikelnummer wird abgefragt

Es kann kein Parameter, exakt ein Parameter oder eine Mischung genutzt werden, wobei die Abfrage von oben nach unten einschränkt.
Artikel werden nur dann gelistet, wenn sie bestimmte Krieterien erfüllen:

• Sie benötigen einen Preis in der Kategorie des Shops
• Sie benötigen ein (Füll)Gewicht oder die Markierung, dass kein Literpreis / Grundpreis angegeben werden muss.
• Sie müssen als aktiv gekennzeichnet sein (nicht unter den vergriffenen Artikeln).

Dies erlaubt ein besseres Steuern der Schnittstelle direkt durch das Weingut, indem einfach Preise entfernt werden und Artikel bei einem Umstellen des Status in Winestro automatisch aus dem Shop entfernt werden können. (Die Basis-Artikelstämme umfassen mehrere tausende Artikel und eine andere Steuerung hat sich als unpraktikabel erwiesen). Die Füllgewichte / Basispreise sollen Weingüter vor Fehlern und Abmahnungen schützen. Wenn ein Wein kein Füllgewicht besitzt, kann der Haken bei "kein Literpreis ausweisen" gesetzt werden.
Das + im Fall der Weinnr ist kein Sonderzeichen, sondern ein reserviertes System-Trennzeichen: Das + in der Artikelnummer gibt beim Weingut verschiedene Füllungen an, die nach außen als eine Weinnr (zB 100) erscheinen aber nach innen als Füllung (zB 100+1, 100+2...) geführt werden.

In der Artikelnummer werden diese Zeichen entsprechend URL-Codiert übergeben, da das die konkrete Artikelnummer ist, die auch bei Rückgabe erwartet wird - in dem Fall 100%2B1. Das + ist codiert (%2B), damit bei einer Übermittlung via URL, Post oder Get keine Codierungs Probleme entstehen.

Idr. wird das aber bei den meisten Einbauenden in der URL einfach abgeschnitten - also in der Anzeige nur der Teil vor dem + um dem Kunden nur die 100 zu produzieren. Bei der Rückmübermitllung wird aber wieder 100%2B1 erwartet, damit das intern für das Weingut der passenden Füllung zugeordnet werden kann.
Zurückgegeben wird hier imm der freie Bestand, also alles beim Weingut minus Reservierungen und Sperrungen. In den Systemeinstellungen kann ein Vorzugslager für den Shop eingestellt werden, auf das bei Bedarf gehört werden soll.

Diese Funktion wurde in 20.0 abgestellt, da die Funktion getArtikel alle Aufgaben übernehmen kann. Intern wird die Funktion mit den gleichen Parametern umgeleitet, sodass auch ältere System umgestellt werden können und bei gleichen Parametern eine Antwort erhalten sollten. Beachten Sie, dass ggf. mehr Felder zurückgeliefert werden, da die ablösende Funktion aktueller ist.

Diese Funktion wurde in 20.0 abgestellt, da die Funktion getArtikel alle Aufgaben übernehmen kann. Intern wird die Funktion mit den gleichen Parametern umgeleitet, sodass auch ältere System umgestellt werden können und bei gleichen Parametern eine Antwort erhalten sollten. Beachten Sie, dass ggf. mehr Felder zurückgeliefert werden, da die ablösende Funktion aktueller ist.

Gibt alle Kundengruppen systemweit von Winestro zurück. Mithilfe der Gruppen können auch Kunden aus diesen Gruppen abgefragt werden.

Gibt den Status und Trackinglink eines Auftrags zurück.

Liefert den aktuellen Artikelbestand gesamt oder je Lager mit. Die Bestandsabfrage wurde mit der Version 21 geändert und darf nun in Echtzeit genutzt werden. Die Limitierung entfällt ab 21!


Zurückgegeben wird hier imm der freie Bestand, also alles beim Weingut minus Reservierungen und Sperrungen. In den Systemeinstellungen kann ein Vorzugslager für den Shop eingestellt werden, auf das bei Bedarf gehört werden soll.

Liefert alle aktiven Zimmer des Kunden. Zimmer werden in Winestro als Artikel geführt und können bei Bedarf auch über die Artikelschnittstelle bei weiteren Werten angefragt werden. Die Zimmer_nr und die weinnr sind gleichbedeutend.

Liefert alle Buchungen die Heute oder in der Zukunft liegen für ein Zimmer. Buchungen sind speziell markierte Aufträge und können daher auch über den Auftragsstatus angefragt werden. Die Felder buchung_nummer und auftragnummer sind gleichbedeutend.

Liefert eine Vorschau zu allen News.

Liefert die Detail-Infos zu einem Einzel-News.