| Allgemeines | ||
| Folgende 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. | ||
| Variablenname | Beschreibung | Bemerkung |
| UID | Der Nutzer der Api (Die ID des Winzers ohne das W) | |
| apiUSER | Der XML Benutzername der Schnittstelle | |
| apiCODE | Der XML Zugangscode der Schnittstelle | |
| apiShopID | Die Nummer des Shops | (meist 1) |
| apiACTION | Die Aktion die angefragt und bearbeitet werden soll | |
| Falls es Probleme bei der Anfrage gibt, können folgende Fehler zurückgegeben werden. Fehler werden innerhalb eines <fehler> Tag zurückgegeben |
||
| Tagname | Beschreibung | Bemerkung |
| id | Die Fehler ID | |
| text | Fehlerbeschreibung | |
| Aktion: newOrder | ||
| Fügt einen neuen Webshop-Auftrag in die Datenbank des Kunden ein. | ||
| Parametername | Beschreibung | Bemerkung |
| anrede | Anrede des Kunden | Erwartet Integer Wert | 0 = Herr, 1 = Frau, 2 = Firma |
| firma | Firmenname | |
| name | Vorname | |
| nname | Nachname | |
| strasse | Straße | |
| hnummer | Hausnummer | String |
| land | Land des Kunden | 2 Char: ISO-Länderkürzes: DE / UK / FR |
| plz | Postleitzahl | String |
| Ort | Ort/ Stadt | |
| telefon | Telefonnummer | |
| E-Mail Adresse | ||
| l_firma | Firma der Lieferadresse | Nur angeben wenn abweichend |
| l_vorname | Vorname der Lieferadresse | Nur angeben wenn abweichend |
| l_nachname | Nachname der Lieferadresse | Nur angeben wenn abweichend |
| l_strasse | Straße der Lieferadresse | Nur angeben wenn abweichend |
| l_hnummer | Hausnummer der Lieferadresse | Nur angeben wenn abweichend |
| l_land | Land der Lieferadresse | Nur angeben wenn abweichend | 2 Char s.o. |
| l_plz | Postleitzahl der Lieferadresse | Nur angeben wenn abweichend |
| l_ort | Ort der Lieferadresse | Nur angeben wenn abweichend |
| ktoInh | Name des Kontoinhabers | |
| kto | Kontonummer | Veraltet | optional |
| blz | Bankleitzahl | Veraltet | optional |
| iban | IBAN für Bankeinzug | |
| bic | BIC für Bankeinzug | |
| referenz | Hinweise des Kunden zur Bestellung | max 255 Zeichen |
| keine_mail | Blockiert automatische E-Mail | Erwartet keinen Wert (Mail wird gesendet) oder "keine_mail" (E-Mail wird blockiert) |
| zahlungsart | Gewählte Zahlungsart des Kunden | Integer erwartet: 1 = Rechnung | 2 = Vorkasse | 3 = Bankeinzug | 4 = Nachname | 5 = Bar/Vorort - Hinweis: Bei Paypal aktuell noch auf 2 setzen - gesonderte Zahlungsart hierfür folgt mit nächster Version |
| versandkosten | Ermittelte Versandkosten | double | Punkt (.) als Dezimaltrenner. Keine Tausende-Trenner oder Leerzeichen! |
| gebuehr | Anfallende Gebühr für die Zahlungsart | double | Punkt (.) als Dezimaltrenner. Keine Tausende-Trenner oder Leerzeichen! |
| positionen | Anzahl der gekauften Positionen | exklusive/ohne Versandkosten |
| wein_anzahl[x] | Anzahl des Weins in der Position X | Integer | [x] ist Platzhalter für die Position. Beiespiel Position 3 = wein_anzahl3 |
| wein_id[x] | Weinnummer des Weins in der Position x | String | [x] ist Platzhalter für die Position. Beiespiel Position 3 = wein_id3 | es ist exakt die Weinnr zu verwenden, die in Weinbau-online.de für diesen Wein geführt wird. Andere Nummern führen zu Fehlern in der Auftragserstellung und ggf. zu einem Datenverlust |
| gutscheincode | Code für einen Gutschein | int |
| zahlung_kosten | Kosten für die Zahlungsart | double |
| Rückgabewerte | ||
| Tagname | Beschreibung | Bemerkung |
| status | Rückgabewert | "ok" wenn Auftrag angelegt |
| nr | Eindeutige Nummer des Auftrags | Auftragsnummer zur Information des Winzers |
| fehler | Falls Fehler auftritt | Fehlerbeschreibung |
| Aktion: getKundenGruppe | ||
| Gibt eine Liste aller Kunden aus die in einer bestimmten Gruppe sind. | ||
| Parametername | Beschreibung | Bemerkung |
| id_grp | Kundengruppe die angezeigt werden soll | |
| suchstring | String nach dem in den wichtigsten Daten im Kunden gesucht werden kann | Parameter ist optional, Ergebnisse beziehen sich nur auf Inhalte der Gruppe |
| Rückgabewerte | ||
| Tagname | Beschreibung | Bemerkung |
| anzahl | Anzahl gefundener Datensätze | |
| Die Datensätze befinden sich in einem <items> Container. Jeder Datensatz an sich befindet sich in einem <item> Container | ||
| adr_id | ID des Kunden | |
| adr_nr | Kundennummer | |
| adr_vorname | Vorname des Kunden | |
| adr_nachname | Nachname des Kunden | |
| adr_firma | Firma des Kunden | |
| adr_plz | PLZ des Kunden | |
| adr_ort | Ort des Kunden | |
| adr_www | Website des Kunden | |
| adr_email | E-Mail Adresse des Kunden | |
| adr_str | Straße des Kunden | |
| adr_str_nr | Hausnummer des Kunden | |
| adr_land | Land des Kunden (ISO 2 Code) | |
| adr_festnetz | Festnetznummer des Kunden | |
| adr_mobil | Mobilnummer des Kunden | |
| adr_fax | Faxnummer des Kunden | |
| adr_note1 | Notizfeld 1 des Kunden | |
| adr_note2 | Notizfeld 2 des Kunden | |
| adr_note3 | Notizfeld 3 des Kunden | |
| adr_note4 | Notizfeld 4 des Kunden | |
| Aktion: getAdr | ||
| siehe -> getKundenGruppe. | ||
| Aktion: getWineGroups | ||
| siehe -> getArtikelGruppen. | ||
| Aktion: getArtikelGruppen | ||
| gibt alle Artikelgruppen zurück in denen bei der übergebenen apiShopID ein Artikel eingestellt wurde. | ||
| Parametername | Beschreibung | Bemerkung |
| Diese Funktion erwartet keine Parameter | ||
| Rückgabewerte | ||
| Tagname | Beschreibung | Bemerkung |
| anzahl | Anzahl gefundener Datensätze | |
| Die Datensätze befinden sich in einem <items> Container. Jeder Datensatz an sich befindet sich in einem <item> Container | ||
| grp_nr | Nr (ID) der Artikelgruppe | |
| grp_name | Name der Artikelgruppe | |
| grp_beschreibung | Beschreibung der Artikelgruppe | |
| Aktion: getGutscheine | ||
| gibt alle aktiven Gutscheine zurück, die auch in den aktuellen Zeitraum fallen | ||
| Parametername | Beschreibung | Bemerkung |
| Diese Funktion erwartet keine Parameter | ||
| Rückgabewerte: gutscheine -> gutschein | ||
| Tagname | Beschreibung | Bemerkung |
| id_shop_gutschein | Marker des Gutscheins | int |
| gueltig_bis | Verfallsdatum | String | YYYY-MM-DD |
| wert | Wert des Gutscheins | Double | optional, falls kein prozent s.u. |
| prozent | Wert des Gutscheins | Double | optional, falls kein wert s.o. |
| code | Gutscheincode | int |
| ab_wert | Ab diesem Betrag gültig | double | optional |
| Aktion: getEinstellungen | ||
| Gibt die Einstellungen des Shop's zurück, wie z.B. Versandkosten. | ||
| Parametername | Beschreibung | Bemerkung |
| Diese Funktion erwartet keine Parameter | ||
| Rückgabewerte | ||
| Tagname | Beschreibung | Bemerkung |
| Der Datensatz an sich befindet sich in einem <einstellungen> Container | ||
| name | Bezeichnung des Shop's | |
| bar | Ob Zahlungsart Barzahlung akzeptiert | Mögliche Werte 1/0 für true/false |
| vorkasse | Ob Zahlungsart Vorkasse akzeptiert | Mögliche Werte 1/0 für true/false |
| bankeinzug | Ob Zahlungsart Bankeinzug akzeptiert | Mögliche Werte 1/0 für true/false |
| nachnahme | Ob Zahlungsart Nachnahme akzeptiert | Mögliche Werte 1/0 für true/false |
| nachnahme_betrag | Zusatzbetrag f$uuml;r die Zahlungsart Nachnahme | Double |
| rechnung | Ob Zahlungsart Rechnung akzeptiert | Mögliche Werte 1/0 für true/false |
| rechnung_stammkunde | Ob Zahlungsart Rechnung akzeptiert wird mit Hinweis nur für Stammkunden | Mögliche Werte 1/0 für true/false |
| versandkosten | Ob es Versandkosten gibt | Mögliche Werte 1/0 für true/false |
| freiab | Betrag in € ab wann Lieferung keinen Versand kostet | Double |
| sechs | Versandkosten in € f$uuml;r 1-6 Paket | Double |
| zwoelf | Versandkosten in € f$uuml;r 7-12 Paket | Double |
| fuenfzehn | Versandkosten in € für 12-15 Paket | Double |
| sechtzehn | Versandkosten in € für 13-16 Paket | Double |
| achtzehn | Versandkosten in € f$uuml;r 17-18 Paket | Double |
| einundzwanzig | Versandkosten in € für 19- 21 Paket | Double |
| aktiv6 | Gibt an, ob es 6er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| aktiv12 | Gibt an, ob es 12er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| aktiv16 | Gibt an, ob es 6er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| aktiv18 | Gibt an, ob es 18er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| aktiv21 | Gibt an, ob es 21er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| paypal_aktiv | Angabe ob Paypal genutzt wird | Mögliche Werte 1/0 für true/false |
| paypal_user | Paypal User Name | String |
| paypal_pass | Paypal User Passwort | String |
| paypal_sig | Paypal Signatur | String |
| Das Suffix "eu" kann analog auch mit "ww" ersetzt werden für "weltweit" | ||
| vk_eu | Versand in EU | 0 nein | 1 ja |
| aktiv6_eu | Gibt an, ob es 6er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| aktiv12_eu | Gibt an, ob es 12er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| aktiv15_eu | Gibt an, ob es 15er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| aktiv16_eu | Gibt an, ob es 16er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| aktiv18_eu | Gibt an, ob es 18r Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| aktiv21_eu | Gibt an, ob es 21er Pakete gibt (falls Paket versandfrei) | Mögliche Werte 1/0 für true/false |
| sechs_eu | Versandkosten in € für 1-6 Paket | Double |
| zwoelf_eu | Versandkosten in € für 7-12 Paket | Double |
| fuenfzehn_eu | Versandkosten in € für 12-15 Paket | Double |
| sechtzehn_eu | Versandkosten in € für 13-16 Paket | Double |
| achtzehn_eu | Versandkosten in € für 17-18 Paket | Double |
| einundzwanzig_eu | Versandkosten in € für 19- 21 Paket | Double |
| land | Land des Versenders | String | 2Char Ländercode: z.B. DE |
| Aktion: getWines | ||
| siehe -> getArtikel. | ||
| Aktion: getArtikel | ||
| Gibt die Artikel in einer Artikelgruppe zurück die mit übergeben wird. | ||
| Parametername | Beschreibung | Bemerkung |
| id_grp | Artikelgruppe die angezeigt werden soll | Parameter ist optional, bei keinem Wert, werden alle Artikel angezeigt |
| suchstring | String nach dem in Artikelname oder Beschreibung gesucht werden kann | Parameter ist optional |
| Rückgabewerte | ||
| Tagname | Beschreibung | Bemerkung |
| anzahl | Anzahl gefundener Datensätze | |
| Die Datensätze befinden sich in einem <items> Container. Jeder Datensatz an sich befindet sich in einem <item> Container | ||
| artikel_nr | Artikelnummer des Artikels | |
| artikel_name | Artikelname des Artikels | |
| artikel_beschreibung | Beschreibungstext des Artikels | |
| artikel_jahrgang | Jahrgang des Artikels | |
| artikel_sorte | Sorte des Artikels | |
| artikel_qualitaet | Qualität des Artikels | |
| artikel_geschmack | Geschmacksrichtung des Artikels | |
| artikel_zucker | Zuckergehalt des Artikels | |
| artikel_alkohol | Alkoholgehalt des Artikels | |
| artikel_saeure | Säuregehalt des Artikels | |
| artikel_liter | Füllmenge des Artikels | |
| artikel_gewicht | Gewicht des Artikels in kg | |
| artikel_bild | URL des kleinen Bildes des Artikels | |
| artikel_bild_big | URL des großen Bildes des Artikels | |
| artikel_bild_2 | URL des kleinen Zusatzbildes Bildes des Artikels | |
| artikel_bild_big_2 | URL des großen Zusatzbildes Bildes des Artikels | |
| artikel_bild_3 | URL des kleinen Zusatzbildes Bildes des Artikels | |
| artikel_bild_big_3 | URL des großen Zusatzbildes Bildes des Artikels | |
| artikel_bild_4 | URL des kleinen Zusatzbildes Bildes des Artikels | |
| artikel_bild_big_4 | URL des großen Zusatzbildes Bildes des Artikels | |
| artikel_nuancen | Ein serialisiertes Array mit Nuancen | nutzen Sie unserialize() um das bezogenes Array wieder herzustellen. Enthält Bezeichnung und ein Bild zum Bildpfad https://nephele-s2.de/webshop_images/nuancen/ |
| artikel_auszeichnungen | Ein serialisiertes Array mit Auszeuchnungen | nutzen Sie unserialize() um das bezogenes Array wieder herzustellen. Enthält Bezeichnung und ein Bild zum Bildpfad https://nephele-s2.de/webshop_images/nuancen/ |
| artikel_versandzahl | Anzahl der tatsächlichen Flaschen / Integer | In der Regel = 1. Bei Sortimenten kann es aber abweichend sein. |
| artikel_preis | Preis in € des Artikels | Double |
| artikel_literpreis | Literpreis in € des Artikels | Double |
| artikel_mwst | Mehrwertsteuersatz des Artikels | Double |
| artikel_brennwert | Brennwert pro 100g/100ml | Float |
| artikel_eiweiss | Eiweißgehalt pro 100g/100ml | Float |
| artikel_versandfrei | Angabe ob Artikel generell versandfrei | 0 / 1 für True / False |
| artikel_keinliterpreis | Markiert Artikel, die keinen Literpreis benötigen. | 0 / 1 für True / False |
| artikel_fuellgewicht | Füllgewich in Gramm | int |
| artikel_kilopreis | Preis pro Kilogramm in € | double |
| artikel_ausgetrunken | Datum, bis zu dem der Artikel als ausgetrunken angezeigt werden soll | String | YYY-MM-DD |
| artikel_apnr | APNR | String |
| Aktion: getWineDetail | ||
| siehe -> getArtikelDetail. | ||
| Aktion: getArtikelDetail | ||
| Gibt detailierte Informationen über einen Artikel zurück. | ||
| Parametername | Beschreibung | Bemerkung |
| artikelnr | Artikelnummer des Artikels dessen Infos abgerufen werden | |
| weinnr | Weinnummer des Artikels dessen Infos abgerufen werden | Ist ein Alias f$uuml;r artikelnr wird irgendwann entfernt |
| Rückgabewerte | ||
| Tagname | Beschreibung | Bemerkung |
| Der Datensatz befindet sich in einem <item> Container | ||
| artikel_nr | Artikelnummer des Artikels | |
| artikel_name | Artikelname des Artikels | |
| artikel_beschreibung | Beschreibungstext des Artikels | |
| artikel_jahrgang | Jahrgang des Artikels | |
| artikel_sorte | Sorte des Artikels | |
| artikel_qualitaet | Qualität des Artikels | |
| artikel_geschmack | Geschmacksrichtung des Artikels | |
| artikel_zucker | Zuckergehalt des Artikels | |
| artikel_alkohol | Alkoholgehalt des Artikels | |
| artikel_saeure | Säuregehalt des Artikels | |
| artikel_liter | Füllmenge des Artikels | |
| artikel_gewicht | Gewicht des Artikels in kg | |
| artikel_bild | URL des kleinen Bildes des Artikels | |
| artikel_bild_big | URL des großen Bildes des Artikels | |
| artikel_bild_2 | URL des kleinen Zusatzbildes Bildes des Artikels | |
| artikel_bild_big_2 | URL des großen Zusatzbildes Bildes des Artikels | |
| artikel_bild_3 | URL des kleinen Zusatzbildes Bildes des Artikels | |
| artikel_bild_big_3 | URL des großen Zusatzbildes Bildes des Artikels | |
| artikel_bild_4 | URL des kleinen Zusatzbildes Bildes des Artikels | |
| artikel_bild_big_4 | URL des großen Zusatzbildes Bildes des Artikels | |
| artikel_preis | Preis in € des Artikels | |
| artikel_literpreis | Literpreis in € des Artikels | |
| artikel_shopnotiz | Shopnotiz des Artikels | |
| artikel_mwst | Mehrwertsteuersatz des Artikels | |
| artikel_brennwert | Brennwert pro 100g/100ml | |
| artikel_eiweiss | Eiweißgehalt pro 100g/100ml | |
| artikel_versandfrei | Angabe ob Artikel generell versandfrei | |
| artikel_keinliterpreis | ||
| artikel_fuellgewicht | Füllgewich in Gramm | |
| artikel_kilopreis | Preis pro Kilogramm in € | |
| artikel_ausgetrunken | Datum, bis zu dem der Artikel als ausgetrunken angezeigt werden soll | String | YYY-MM-DD |
| artikel_apnr | APNR | String |
| Aktion: getAdrGrp | ||
| Gibt alle Kundengruppen zurück. | ||
| Parametername | Beschreibung | Bemerkung |
| Diese Funktion erwartet keine Parameter | ||
| Rückgabewerte | ||
| Tagname | Beschreibung | Bemerkung |
| anzahl | Anzahl gefundener Datensätze | |
| Die Datensätze befinden sich in einem <items> Container. Jeder Datensatz an sich befindet sich in einem <item> Container | ||
| grp_nr | Nr (ID) der Kundengruppe | |
| grp_name | Name der Kundengruppe | |
| grp_beschreibung | Beschreibung der Kundengruppe | |