Version vom 10. November 2021, 10:29 Uhr

Diese Seite listet die Konfigurationsschlüssel für den Schnittstellentyp brShop24 auf. Informationen zur Liste und Einstellungen anderer Shop-Schnittstellen finden Sie hier.

wichtige Einstellungen brShop24

Diese Einstellung sind wichtig, damit die Schnittstelle überhaupt funktionieren kann. Siehe dazu auch brShop24 Installation/Einrichtung

Schlüssel	Erklärung	Beispiel
Allgemein.Aktiv	aktiviert oder deaktiviert die Schnittstelle	J
Allgemein.Shop.URL	Endpunkt-URL für die API	https://meinshop.brshop24.de/apitest
OAuth2.ClientId	Client-Id für OAuth2-Authentifizierung (API-Zugriff)	1
OAuth2.ClientSecret	Client-Secret für OAuth2-Authentifizierung (API-Zugriff)	0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF
OAuth2.TokenEndpoint	Token-Endpoint für OAuth2-Authentifizierung (API-Zugriff)	https://meinshop.brshop24.de/oauth/token

Übersicht Einstellungen brShop24

Allgemein.Aktiv

aktiviert oder deaktiviert die Schnittstelle

Allgemein.Debug

Debugmodus für Shop aktivieren. Erweitert das Protokoll um zusätzliche Einträge und sollte nur in Problemfällen aktiviert werden. Für Administratoren (Level 9)

Allgemein.Debug.LogLevel

Level für Logeinträge während des Debuggens (0 bis 5). 0=Keine 5=Alles Für Administratoren (Level 9)

Allgemein.Schnittstelle.Sachbearbeiter

Shopsachbearbeiter als Empfänger für Nachrichten und Aufgaben aus der Shopschnittstelle

Allgemein.Shop.URL

Endpunkt-URL für die API.
Beispiel: https://meinshop.brshop24.de/apitest

Allgemein.Standard.Personen.Preisgruppe

Personenanlage in Preisgruppe

Allgemein.Standard.Zahlungsbedingung

Standardzahlungsbedingung für Shopaufträge

Export.GraphQL.Max.batchPriceList

Maximale Anzahl an Datensätzen pro Stapel. Der minimal verwendete Wert ist 100 und der maximale Wert 5000. Größere oder kleinere Werte werden automatisch auf den maximalen bzw. minimalen Wert gesetzt. Standardwert ist 2000.

Export.Liste.Bestellvorlage.AnzahlMax

maximale Anzahl an Artikeln pro generierter Bestellvorlage

Export.Liste.Bestellvorlage.Basis

Bestellvorlage Standard-Datenbasis. 1=Auftrag 2=Rechnung

Export.Liste.Bestellvorlage.Zeitraum.Monate

Anzahl der vergangenen Monate ausgehend vom aktuellen Datum aus denen Vorgänge bei der Selektion der Positionen mit einbezogen werden. Es werden minimal 3 Monate und maximal 60 Monate (5 Jahre) selektiert.

Export.Person.Adr.OhneZeile3

Prüfung der Adressezeile 3 beim Export von Adressen, da im Shop nur zwei von drei Zeilen eingetragen werden können. Abhängig der vorhandenen Adressefelder bezieht sich dies auf "Zusatz 2" bzw. "Zusatz".
J = Export nur wenn Adresszeile 3 leer
N = Inhalt wird ignoriert und Adresse ohne Zeile 3 im Shop angelegt

Import.Adresse.Auftraggeber.Prio

Legt fest, ob die Adresse aus der Datei mit den OBS-Daten überschrieben wird (N) oder die Adresse aus der Datei beibehalten werden soll (J).

Import.Adresse.KontaktInAdresse

Kontakt wird in Adresse übernommen (Name, Zusatz1 oder Zusatz2), sofern dort Platz ist.

Import.Adresse.Rechnung

Rechnungsempfänger übernehmen. Dies benötigt eventuell die Erlaubnis Personen anlegen zu dürfen.

Import.Adresse.Versand

Versandanschrift übernehmen

Import.Adresse.Versand.Check

Legt fest, mit welcher Adresse die Versandadresse der Shop-Bestellung verglichen wird. 0=BUYER_PARTY aus Datei 1=Auftraggeber

Import.Adresse.Versand.Prio

Legt fest, ob die Adresse aus der Datei mit den OBS-Daten überschrieben wird (1) oder die Adresse aus der Datei beibehalten werden soll (2).

Import.AU.Adressuebernahme

Adresse in Auftrag übernehmen

Import.AU.Datei.Typ

Import Typ Auftragsdateien. Bestimmt mit welchem Import die Auftragsdaten importiert werden.

Import.AU.FTPEingang.Anlegen

Aktiviert die Anlage einer Info in FTP-Eingang bei Import der Bestellung.

Import.AU.Kostenstellenuebernahme

Aktiviert die Übernahme von Kostenstellen aus der Datei (COST_CATEGORY_ID).

Import.AU.Materialanlage

Für Shopaufträge Material automatisch anlegen?

Import.AU.Person.Sachbearb

Übernahme des Sachbearbeiters aus der Person als Sachbearbeiter des Auftrags. Ist noch keine Person vorhanden oder der Sachbearbeiter leer, so wird der Standard-Sachbearbeiter der Shop-Schnittstelle verwendet.

Import.AU.Pos.NeueNummmern

Wenn aktiv ("J"), dann werden die Positionen beim Auftragsimport neu durchnummeriert.

Import.AU.Pos.UstSatz

Übernahme der Steuersätze, sofern angegeben, aus der OpenTRANS-Datei.

Import.AU.PrioShopLieferant

Beim Importieren der Bestellungen werden vorzugsweise die hinterlegten Shop-Lagerlieferanten als Lieferant für Position und Material gezogen. Andernfalls wird immer der erste Lieferant des Artikels gezogen.

Import.AU.Standard.Filiale

Standard Filiale bei Auftragsanlage. Sollte auf anderen Wegen keine Filiale gefunden werden können, wird im Auftrag diese Filiale gesetzt. Benötigt Filiallösung!

Import.AU.StempelArtikelnummer

Standard Artikelnummer für Stempel-Artikel, die aus dem Shop übernommen werden

Import.Info.EMail

Versendet eine E-Mail als Information, dass ein Auftrag importiert wurde. Die E-Mail wird nur an Benutzer versendet, die "Meldung bei Internetbestellungen (Shop)" aktiviert haben.

Import.Kostenstelle.BestimmtKunde

Ist eine Kostenstelle im Auftrag angegeben, so wird der Kunde des Auftrags durch die kostenstelle bestimmt. Ohne Kostenstelle wird die Personennummer der Buyer-Party verwendet.

Import.Kostenstelle.Suche.BezeichnungVoll

Wenn aktiv ("J"), dann wird die volle Bezeichnung der Kostenstelle mit der Referenz der Datei verglichen, um die richtige Kostenstelle zu identifizieren.

Import.Personen.Anlage

Shop darf Personen anlegen

Import.Personen.Nummernkreis

Wenn Personenanlage erlaubt, wird die Personennummer beginnend mit 1 oder 9 generiert. Der Nummernkreis kann hier vorgegeben werden. Der Nummernkreis kann auch entsprechend weiter eingeschränkt werden z. B. 123 (123001 bis 123999 bei 6-stelligen Personennummern).

Import.Projektnummer

Vorbelegung der Projektnummer bei Shopaufträgen

OAuth2.ClientId

OAuth2 Client-Id

OAuth2.ClientSecret

OAuth2 Client-Secret

OAuth2.TokenEndpoint

OAuth2 Token-URL

Positionserfassung.Starten

Aufrufen der Positionserfassung bei Shop-Aufträgen aus der Liste FTP-Eingang

@@ Zeile 1: / Zeile 1: @@
 {{Vorlage:Kostenpflichtige Module}}
-Diese Seite listet die Konfigurationsschlüssel für den Schnittstellentyp VShop 4.0 auf. Informationen zur Liste und Einstellungen anderer Shop-Schnittstellen finden Sie [[FRMSHOPEINSTELLUNGEN|hier]].
+Diese Seite listet die Konfigurationsschlüssel für den Schnittstellentyp brShop24 auf. Informationen zur Liste und Einstellungen anderer Shop-Schnittstellen finden Sie [[FRMSHOPEINSTELLUNGEN|hier]].
-=wichtige Einstellungen VShop 4.0=
+=wichtige Einstellungen brShop24=
-Diese Einstellung sind wichtig, damit die Schnittstelle überhaupt funktionieren kann.
+Diese Einstellung sind wichtig, damit die Schnittstelle überhaupt funktionieren kann. Siehe dazu auch [[Kostenpflichtige_Module/Internet-Shop/brShop24#Installation.2FEinrichtung|brShop24 Installation/Einrichtung]]
 {| class="wikitable"
 |-
 ! Schlüssel!! Erklärung!! Beispiel
 |-
-| Shop.Aktiv|| aktiviert oder deaktiviert die Schnittstelle|| J
+| Allgemein.Aktiv|| aktiviert oder deaktiviert die Schnittstelle|| J
 |-
-| Datenbank.Host|| Adresse des Datenbankservers|| mein.dbserver.de
+| Allgemein.Shop.URL|| Endpunkt-URL für die API|| https://meinshop.brshop24.de/apitest
 |-
-| Datenbank.Login.Benutzer|| Benutzername für Datenbankzugang|| OBS100000
+| OAuth2.ClientId|| Client-Id für OAuth2-Authentifizierung (API-Zugriff)|| 1
 |-
-| Datenbank.Login.Passwort|| Passwort für Datenbankzugang|| pA5sw0rT
+| OAuth2.ClientSecret|| Client-Secret für OAuth2-Authentifizierung (API-Zugriff)|| 0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF
 |-
-| Datenbank.Datenbankname|| Name der Shop-Datenbank|| v40_100000
+| OAuth2.TokenEndpoint|| Token-Endpoint für OAuth2-Authentifizierung (API-Zugriff)|| https://meinshop.brshop24.de/oauth/token
-|-
-| Shop.Lagerlieferant.1|| erster Shop-Lagerlieferant|| 700001
 |}
+=Übersicht Einstellungen brShop24=
-=Übersicht Einstellungen VShop 4.0=
+==Allgemein.Aktiv==
-==Shop.Aktiv==
 aktiviert oder deaktiviert die Schnittstelle
+==Allgemein.Debug==
-==Shop.Sachbearbeiter==
+Debugmodus für Shop aktivieren. Erweitert das Protokoll um zusätzliche Einträge und sollte nur in Problemfällen aktiviert werden.
-Name der Shop-Datenbank
+'''Für Administratoren (Level 9)'''<br />
+==Allgemein.Debug.LogLevel==
-==Shop.Lagerlieferant.1==
+Level für Logeinträge während des Debuggens (0 bis 5). 0=Keine 5=Alles
-erster Shop-Lagerlieferant ('''Pflichtfeld''')
+'''Für Administratoren (Level 9)'''<br />
+==Allgemein.Schnittstelle.Sachbearbeiter==
-==Shop.Lagerlieferant.2==
+Shopsachbearbeiter als Empfänger für Nachrichten und Aufgaben aus der Shopschnittstelle
-zweiter Shop-Lagerlieferant
+==Allgemein.Shop.URL==
+Endpunkt-URL für die API.<br />
-==Shop.Lagerlieferant.3==
+Beispiel: https://meinshop.brshop24.de/apitest
-dritter Shop-Lagerlieferant
+==Allgemein.Standard.Personen.Preisgruppe==
+Personenanlage in Preisgruppe
-==Shop.Lagerlieferant.4==
+==Allgemein.Standard.Zahlungsbedingung==
-vierter Shop-Lagerlieferant
+Standardzahlungsbedingung für Shopaufträge
+==Export.GraphQL.Max.batchPriceList==
-==Shop.Lagerlieferant.5==
+Maximale Anzahl an Datensätzen pro Stapel. Der minimal verwendete Wert ist 100 und der maximale Wert 5000. Größere oder kleinere Werte werden automatisch auf den maximalen bzw. minimalen Wert gesetzt. Standardwert ist 2000.
-fünfter Shop-Lagerlieferant
+==Export.Liste.Bestellvorlage.AnzahlMax==
+maximale Anzahl an Artikeln pro generierter Bestellvorlage
-==Datenbank.Host==
+==Export.Liste.Bestellvorlage.Basis==
-Datenbankserver Adresse
+Bestellvorlage Standard-Datenbasis. 1=Auftrag 2=Rechnung
+==Export.Liste.Bestellvorlage.Zeitraum.Monate==
-==Datenbank.Login.Benutzer==
+Anzahl der vergangenen Monate ausgehend vom aktuellen Datum aus denen Vorgänge bei der Selektion der Positionen mit einbezogen werden. Es werden minimal 3 Monate und maximal 60 Monate (5 Jahre) selektiert.
-Datenbankserver Benutzer
+==Export.Person.Adr.OhneZeile3==
+Prüfung der Adressezeile 3 beim Export von Adressen, da im Shop nur zwei von drei Zeilen eingetragen werden können. Abhängig der vorhandenen Adressefelder bezieht sich dies auf "Zusatz 2" bzw. "Zusatz".<br />
-==Datenbank.Login.Passwort==
+J = Export nur wenn Adresszeile 3 leer<br />
-Passwort für Datenbankzugang
+N = Inhalt wird ignoriert und Adresse ohne Zeile 3 im Shop angelegt
+==Import.Adresse.Auftraggeber.Prio==
-==Datenbank.Datenbankname==
+Legt fest, ob die Adresse aus der Datei mit den OBS-Daten überschrieben wird (N) oder die Adresse aus der Datei beibehalten werden soll (J).
-Name der Shop-Datenbank
+==Import.Adresse.KontaktInAdresse==
+Kontakt wird in Adresse übernommen (Name, Zusatz1 oder Zusatz2), sofern dort Platz ist.
-==FTP.Host==
+==Import.Adresse.Rechnung==
-FTP-Server Adresse
+Rechnungsempfänger übernehmen. Dies benötigt eventuell die Erlaubnis Personen anlegen zu dürfen.
-==FTP.Login.Benutzer==
-FTP-Server Benutzer
-==FTP.Login.Passwort==
-FTP-Server Passwort
-==FTP.Mode.Passiv==
-Modus der Übertragung. Standardmäßig ist der Modus "aktiv" (N).
-==FTP.Verzeichnis.IN==
-FTP-Server Verzeichnis für Übertragung
-==FTP.Verzeichnis.OUT==
-FTP-Server Verzeichnis für Abholung
-==Bild.FTP.Host==
-FTP-Server Bilder Adresse
-==Bild.FTP.Login.Benutzer==
-FTP-Server Bilder Benutzer
-==Bild.FTP.Login.Passwort==
-FTP-Server Bilder Passwort
-==Bild.FTP.Mode.Passiv==
-Modus der Übertragung. Standardmäßig ist der Modus "aktiv" (N).
-==Bild.FTP.Verzeichnis.IN==
-FTP-Server Bilder Verzeichnis für Übertragung
-==Bild.FTP.Verzeichnis.OUT==
-FTP-Server Bilder Verzeichnis für Abholung
-==Import.Personen.Anlage==
-Shop darf Personen anlegen
-==Import.Personen.Nummernkreis==
-Personennummer beginnend mit
-==Import.Projektnummer==
-Vorbelegung der Projektnummer bei Shopaufträgen
 ==Import.Adresse.Versand==
-Versandanschrift übernehmen, wenn abweichend. Für den Adress-Vergleich ist [[#Import.Adresse.Versand.Check|Import.Adresse.Versand.Check]] bei Bedarf anzupassen.
+Versandanschrift übernehmen
 ==Import.Adresse.Versand.Check==
-Legt fest, mit welcher Adresse die Versandadresse der Shop-Bestellung verglichen wird.<br />
+Legt fest, mit welcher Adresse die Versandadresse der Shop-Bestellung verglichen wird. 0=BUYER_PARTY aus Datei 1=Auftraggeber
-=BUYER_PARTY aus Datei<br />
+==Import.Adresse.Versand.Prio==
-=Auftraggeber
+Legt fest, ob die Adresse aus der Datei mit den OBS-Daten überschrieben wird (1) oder die Adresse aus der Datei beibehalten werden soll (2).
+==Import.AU.Adressuebernahme==
+Adresse in Auftrag übernehmen
+==Import.AU.Datei.Typ==
+Import Typ Auftragsdateien. Bestimmt mit welchem Import die Auftragsdaten importiert werden.
+==Import.AU.FTPEingang.Anlegen==
+Aktiviert die Anlage einer Info in FTP-Eingang bei Import der Bestellung.
+==Import.AU.Kostenstellenuebernahme==
+Aktiviert die Übernahme von Kostenstellen aus der Datei (COST_CATEGORY_ID).
 ==Import.AU.Materialanlage==
 Für Shopaufträge Material automatisch anlegen?
@@ Zeile 109: / Zeile 72: @@
 Übernahme des Sachbearbeiters aus der Person als Sachbearbeiter des Auftrags. Ist noch keine Person vorhanden oder der Sachbearbeiter leer, so wird der Standard-Sachbearbeiter der Shop-Schnittstelle verwendet.
 ==Import.AU.Pos.NeueNummmern==
-Der Import übernimmt den Wert des Elements ''LINE_ITEM_ID'' als Positionsnummer. Ist diese Einstellung aktiv (''J''), dann werden die Positionen beim Auftragsimport neu durchnummeriert. Andernfalls bleiben die Positionsnummern der Datei erhalten.
+Wenn aktiv ("J"), dann werden die Positionen beim Auftragsimport neu durchnummeriert.
+==Import.AU.Pos.UstSatz==
+Übernahme der Steuersätze, sofern angegeben, aus der OpenTRANS-Datei.
 ==Import.AU.PrioShopLieferant==
-Im Standard ist diese Option deaktiviert (N). Es wird dann bei Erstellung der Auftragspositionen und des Materials immer der erste Lieferant eines Artikels gezogen. Wird dies auf J gestellt, werden beim importieren der Bestellungen die Lieferanten aus [[#Shop.Lagerlieferant.1|Shop.Lagerlieferant.1]] bis [[#Shop.Lagerlieferant.5|Shop.Lagerlieferant.5]] beim anlegen der Position und des Materials priorisiert behandelt. Wurde ein Artikel nicht über den Lieferanten gefunden, so wird wieder der erste Lieferant des Artikels gezogen.
+Beim Importieren der Bestellungen werden vorzugsweise die hinterlegten Shop-Lagerlieferanten als Lieferant für Position und Material gezogen. Andernfalls wird immer der erste Lieferant des Artikels gezogen.
+==Import.AU.Standard.Filiale==
+Standard Filiale bei Auftragsanlage. Sollte auf anderen Wegen keine Filiale gefunden werden können, wird im Auftrag diese Filiale gesetzt. Benötigt Filiallösung!
+==Import.AU.StempelArtikelnummer==
+Standard Artikelnummer für Stempel-Artikel, die aus dem Shop übernommen werden
 ==Import.Info.EMail==
-Erstellt eine E-Mail als Information, dass ein Auftrag importiert wurde. Die E-Mail wird nur auf das Standardkonto von Benutzern erstellt, die "Meldung bei Internetbestellungen (Shop)" in Ihren [[OBS/System/F9_Layout|Einstellungen]] aktiviert haben.
+Versendet eine E-Mail als Information, dass ein Auftrag importiert wurde. Die E-Mail wird nur an Benutzer versendet, die "Meldung bei Internetbestellungen (Shop)" aktiviert haben.
+==Import.Kostenstelle.BestimmtKunde==
+Ist eine Kostenstelle im Auftrag angegeben, so wird der Kunde des Auftrags durch die kostenstelle bestimmt. Ohne Kostenstelle wird die Personennummer der Buyer-Party verwendet.
 ==Import.Kostenstelle.Suche.BezeichnungVoll==
-Wenn aktiv ("J"), dann wird die volle Bezeichnung der Kostenstelle mit der Referenz der Datei verglichen, um die richtige Kostenstelle zu identifizieren. Die Standardsuche bezieht nur die ersten 6 Zeichen der Referenz mit ein, da diese auch mit der OBS-Kostenstellennummer gefüllt sein kann.
+Wenn aktiv ("J"), dann wird die volle Bezeichnung der Kostenstelle mit der Referenz der Datei verglichen, um die richtige Kostenstelle zu identifizieren.
+==Import.Personen.Anlage==
-==Standard.Personen.Preisgruppe==
+Shop darf Personen anlegen
-Personenanlage in Preisgruppe
+==Import.Personen.Nummernkreis==
+Wenn Personenanlage erlaubt, wird die Personennummer beginnend mit 1 oder 9 generiert. Der Nummernkreis kann hier vorgegeben werden. Der Nummernkreis kann auch entsprechend weiter eingeschränkt werden z. B. 123 (123001 bis 123999 bei 6-stelligen Personennummern).
-==Standard.Zahlungsbedingung==
+==Import.Projektnummer==
-Standardzahlungsbedingung für Shopaufträge
+Vorbelegung der Projektnummer bei Shopaufträgen
+==OAuth2.ClientId==
-==Bestellvorlage.Basis==
+OAuth2 Client-Id
-Bestellvorlage Standard-Datenbasis. 1=Auftrag 2=Rechnung
+==OAuth2.ClientSecret==
+OAuth2 Client-Secret
-==Bestellvorlage.Anzahl==
+==OAuth2.TokenEndpoint==
-maximale Anzahl an Artikeln pro generierter Bestellvorlage
+OAuth2 Token-URL
-==Bestellvorlage.DatumAb==
-Datum, ab welchem Vorgänge für Selektion von Artikeln einbezogen werden
-==Bestellvorlage.Sortierung==
-Sortierung für Bestellvorlage. 1=Pickhäufigkeit 2=Artikelnummer
-==Export.Person.E-Mail-Login==
-E-Mail-Adresse als Login verwenden
-==Export.Artikel.Preis.Auswert==
-Artikelauswertung für VK1 Aktualisierung. Bei der Aktualisierung von Preisen wird der VK1 auch direkt im Shopartikel gesetzt.
-==Export.Person.Gruppenpreise==
-Gruppenpreise
-==Export.Preise.perFTP==
-Die Übertragung der Gesamtdaten erfolgt bei Verwendung des Preislisten-Moduls per FTP. OBS überträgt dabei insgesamt 4 Dateien in einer ZIP-Datei an Büroring. Die Übernahme der Daten erfolgt morgens bis 7:50.
 ==Positionserfassung.Starten==
 Aufrufen der Positionserfassung bei Shop-Aufträgen aus der Liste FTP-Eingang
-==Prioritaet.Artikel==
-OBS hat Artikelpriorität. Das heißt, dass bei der Aktualisierung nicht nur der Preis geändert wird. Folgende Daten werden dann gesetzt:
-*Name
-*Kurzbeschreibung
-*Beschreibung
-*Suchbegriffe
-*EAN
-*Mengeneinheit
-*Packungseinheit
-*Artikelgruppe (Shop-Warengruppe)
-*Hersteller
-==Prioritaet.Preis==
-Mögliche Werte sind "J" und "N" für Ja und Nein. Bei Ja hat der Shop die Preispriorität. Das heißt es werden die Preise aus der Bestellung in den Auftrag übernommen. Steht diese Einstellung auf Nein so führt OBS für jede Position die [[OBS/Preislisten/FAQ_Preislisten#Wie_funktioniert_die_Preisfindung.3F|Bestpreisfindung]] mit Shop-Preislisten durch.

Kostenpflichtige Module/Internet-Shop/brShop24/Konfiguration: Unterschied zwischen den Versionen