Schnittstellenleitfaden

• Stammdatenexport an externe Webshop-Systeme
• Auftragsimport aus externen Webshop-Systemen

Stand Frühjahr 2026

Vorbemerkungen

Im Folgenden werden die Austauschformate für die nicht spezifische Webshop-Schnittstelle aufgeführt. Die Schnittstelle ist eine von mehreren Schnittstellen, die genutzt werden können.

Hinweise für externe Entwickler

Wir weisen explizit darauf hin, dass die vorliegende Schnittstelle seit vielen Jahren von verschiedenen Schnittstellenpartnern eingesetzt wird

Es handelt sich um eine praxiserprobte und erwiesenermaßen robuste, funktionsfähige Schnittstelle. Die Schnittstelle wurde mit Fachleuten aus mehreren Unternehmen gemeinsam entwickelt. Sie wurde bereits erfolgreich in Systeme wie "Shopware" oder "Drinkware" implementiert und wird im Produktivbetrieb von Anwendern genutzt:

• Die Schnittstelle ist voll funktionsfähig
• Alle zugrundeliegenden Normen und Spezifikationen werden eingehalten

Daraus folgt:

• Es werden keine Anpassung aufgrund von Einschränkungen oder Inkompatibilitäten auf der Seite des Shopsystems durchgeführt, auch nicht auf Anfrage oder gegen Kostenerstattung
• Eine Erweiterung der Schnittstelle ist auf Anfrage und in jedem Fall kostenpflichtig, möglich.
• Es muss nicht die Schnittstelle, sondern immer das Shopsystem angepasst werden. Dies ist nicht Aufgabe des Schnittstellenanbieters, sondern des Webshopentwicklers.

Sie erhalten auf Anfrage Hilfestellung zu Schnittstellendefinitionen, jedoch keinesfalls zu branchenspezifischen Themen. Zu branchenspezifische Themen sprechen Sie ausschließlich den Auftraggeber an

Vor der Implementierung fordern wir beim Auftraggeber eine Freigabe zur Erstattung der Beratungskosten an. Der entstandenen Aufwand wird dokumentiert.

Dateiformate

CSV-Dateien

• Es werden deutsche Formatierungen und Zeichensätze verwendet
• Zeichensatz ist UTF-8
• Spalten werden, durch Semikola getrennt
• Jeder Datensatz wird mit einem Semikolon abgeschlossen
• Es werden keine Delimiter verwendet, der Typ eines Datensatzes ergibt sich aus der Reihenfolge

XML-Dateien

• RFC- und W3C-konform
• Zeichensatz ist UTF-8

Dateitransfer

Im einfachsten Fall werden Stammdaten als CSV-Daten bereitgestellt und auf einen FTP-Server übertragen. Die Auftragsdaten werden als XML-Dateien von einem FTP-Server heruntergeladen und verarbeitet. Das Abrufen

• Das FTP-Protokoll wird RFC- und W3C-konform angewendet.
• Der FTP-Client der Anwendung arbeitet im passiven Modus, es wird der Standardport verwendet
• Die Anmeldung am Server erfolgt mit einem Benutzernamen und einem Passwort.
• Der Befehlssatz des Servers muss ASCII, CWD, DELE, GET, NLST und STOR umfassen

Neben den branchenspezifischen Schnittstellen (KOLLEX, OctopusOrder, Gastivo) unterstützt die Anwendung auch EDI-Formate

Bereitstellung von Daten

Im einfachsten Fall werden Stammdaten als CSV-Daten bereitgestellt und auf einen FTP-Server übertragen. Die Auftragsdaten werden als XML-Dateien von einem FTP-Server herutergeladen und verarbeitet. Das Abrufen und Verarbeiten der Aufträge kann automnatisch oder manuell erfolgen.

• Informationen für die Auftragsverarbeitung finden Sie hier.
• Die Einstellungen für für den Datenaustausch mit WEBDRINK finden Sie hier.
• Die Einstellungen für für den Datenaustausch mit Shopware oder Magento u.ä. finden Sie hier.

Stammdatenexport als CSV

Die Daten werden mit einer FTP-Verbindung übertragen. Nach erfolgreichem Verbindungsaufbau werden die CSV-Daten in einem zu definierenden Ordner kopiert.

Formatkennzeichen

Zeichen	Bedeutung
Eindimensionaler alphanumerischer String	UTF-8, ohne Delimiter
Gleitkommazahl	(-)n0,n, maximal 32-Bit
Ganzzahl	(-)i, maximal 32-Bit
Logischer Wert	True/False oder Wahr/Falsch, ohne Delimiter
Datum	ISO 8601 JJJJ-MM-TT, Zeitanteil wird ignoriert
Uhrzeit	ISO 8601 hh:nn:ss, Millisekunden werden ignoriert
Datumsstempel	JJJJ-MM-TT hh:nn:ss, Millisekunden werden ignoriert

Feldbeschreibungen Datei "Kunden.csv“

Nachfolgend wird ein Kundendatensatz beschrieben.

Feld	Typ	Information
KDNr	Alphanumerisch	Eindeutige Identnummer
Anrede	Alphanumerisch	Anrede, optional
Vorname	Alphanumerisch	Vorname, optional
Name/Firma	Alphanumerisch	Firmenname oder Name
Zusatz	Alphanumerisch	optional Abteilung etc.
Strasse	Alphanumerisch	Straße mit Hausnummer
PLZ	Ganzzahl	ohne Nationalitätskennzeichen
Ort	Alphanumerisch	Ort
Alphanumerisch	A20	Telefon 1, optional
Alphanumerisch	A20	Telefon 2, optional
Email	Alphanumerisch	Mehrfacheinträge werden mit Komma getrennt
StNr	Alphanumerisch	StNr. oder USt.ID, optional
BIC	Alphanumerisch	ohne Leerzeichen, optional
IBAN	Alphanumerisch	Darf Leerzeichen enthalten, optional
Bar	Logisch	Kunde muss bei Lieferung zahlen
Gewerbe	Logisch	Gewerbe oder Privatkunde
Limit	Ganzzahl	-1 = gesperrt, 0 = kein Limit
Preisgruppe	Ganzzahl	Preisgruppenliste

Optional: Feldbeschreibungen Datei "Lieferadressen.csv“

Nachfolgend wird ein Adressdatensatz beschrieben. Diese Liste enthält zusätzliche Adressen eines Kunden. Die Datei ist optional. Sind keine Zusatzadressen vorhanden, wird die Baissadresse des Kundendatensatzes als Lieferadresse verwendet.

Feld	Typ	Information
KDNr	Alphanumerisch	Eindeutige Identnummer
Anrede	Alphanumerisch	Anrede, optional
Vorname	Alphanumerisch	Vorname, optional
Name/Firma	Alphanumerisch	Firmenname oder Name
Zusatz	Alphanumerisch	optional Abteilung etc.
Strasse	A20	Straße mit Hausnummer
PLZ	Ganzzahl	ohne Nationalitätskennzeichen
Ort	Alphanumerisch	Ort
Telefon	Alphanumerisch	Telefon 1, optional
Ident	Alphanumerisch	Kennung der Adresse

Feldbeschreibungen Datei "Artikel.csv“

Nachfolgend wird ein Artikeldatensatz beschrieben.

Feld	Typ	Information
Versionsnummer	Alphanumerisch	Wird nicht verwendet
ArtNr	Alphanumerisch	Eindeutige Identnummer
Artikelbezeichnung	Alphanumerisch	Artikelbezeichnung
Menge	Ganzzahl	Flaschen im Kasten, Einzel = 0
Gebinde-Inhalt	Kommazahl	Liter
Warengruppe	Alphanumerisch	Warengruppe
Untergruppe	Alphanumerisch	Wird nicht verwendet
Hersteller	Alphanumerisch	Hersteller
Bruttopreis	Kommazahl	Basispreis 1 des Artikels inkl. MwSt.
Brutto-Pfand	Kommazahl	Basispreis 1 des Pfands inkl. MwSt.
Brutto-Literpreis	Kommazahl	Basispreis 1 pro Liter inkl. MwSt.
Nettopreis	Kommazahl	Basispreis 2 des Artikels exkl. MwSt.
Netto-Pfand	Kommazahl	Basispreis 2 des Pfands exkl. MwSt.
Netto-Literpreis	Kommazahl	Basispreis 2 pro Liter exkl. MwSt.
MwSt	Kommazahl	MwSt.-Satz in Prozent
Barcode	Alphanumerisch	EAN des Teilgebinde oder Einzelartikel
Lieferbar	Ganzzahl	Wird nicht verwendet
Angebotsart	Ganzzahl	Wird nicht verwendet

Optional: Feldbeschreibungen Datei "Favoriten.csv“

Nachfolgend wird ein Kundensortimentsdatensatz beschrieben. Diese Liste enthält die bisher bestellten Artikel eines Kunden. Die Datei ist optional.

Feld	Typ	Information
KDNr	Alphanumerisch	Eindeutige Identnummer des Kunden
ArtNr	Alphanumerisch	Eindeutige Identnummer des Artikels
Anzahl	Ganzzahl	übliche Bestellmenge

Optional: Feldbeschreibungen Datei "Sonderpreise.csv“

Nachfolgend wird eine Tabelle mit kundenspezifischen oder zeitlich beschränkten Sonderpreisen beschrieben. Die Datei ist optional.

Feld	Typ	Information
KDNr	Alphanumerisch	Eindeutige Identnummer des Kunden
ArtNr	Alphanumerisch	Eindeutige Identnummer des Artikels
NettoVK	Kommazahl	Netto Sonderpreis
Start	Zeitstempel	Zeitstempel Gültigkeitsbeginn eines Aktionspreises
Ende	Zeitstempel	Zeitstempel Gültigkeitsende eines Aktionspreises
Gruppe	Alphanumerisch	Aktionspreis gilt für Preisgruppe
Ersetzen	Logisch (ja/nein)	Aktionspreis kann Sonderpreise überschreiben
Vorrat	Ganzzahl	Beschränkter Vorrat eines Aktionspreises, -1 = kein Vorrat

Aktionspreise': Ist das Feld KDNr leer, wird der eingetragene Preis NettoVK als zeitlich gesteuerter Aktionspreis behandelt, der im Zeitraum von Start bis Ende unter Beachtung der Zugehörigkeit eines Kunden zur Preisgruppe in „Gruppe“, der Vorgabe der Möglichkeit zum Überschreiben eines möglichen Sonderpreises eines Kunden für den Artikel und Einschränkung der Gültigkeit eines Aktionspreises auf eine maximale Abverkaufsmenge Vorrat gilt.

Auftragsimport als XML

Die Daten werden mit einer FTP-Verbindung übertragen. Nach erfolgreichem Verbindungsaufbau werden die XML-Daten aus einem zu definierenden Ordner geladen.

Bedingungen:

• Elemente ohne Daten werden XML-konform als <Tag-Name/> dargestellt
• Jede Bestellung wird einzeln erfasst
• Der Datensatz enthält alle Informationen zur Bestellung und zum Kunden
• Zeichensatz ist UTF-8
• Der Name der XML-Datei besteht aus dem Zeitstempel (YYYY-MM-DD-HHNNSS) sowie der Auftragsnummer, welche vom Webshop vergeben wird. Beispiel: 2012-02-06-105730-5432.xml

Aufbau der XML-Datei

<order>
 [notwendig, einmal]
 
 <paymentDetails>
   [optional, einmal]
 </paymentDetails>
    
 <DeliveryDetails>
   [optional, mehrfach]
 </DeliveryDetails>

 <article>
   [optional, mehrfach]
 </article>
</order>
<customer>
 [notwendig, einmal]
 
 <DeliveryAddress>
   [optional, einmal]
 </DeliveryAddress>

 <BankDetails>
   [optional, einmal]
 </BankDetails>
</customer>

Die Entität "order"

Die Entität ist primär, notwendig und einmalig. Sie enthält Informationen zur Bestellung.

Entität	Typ	Beispiel	Erläuterungen
<orderID>	Alphanumerisch	5456	Bestellnummer des Shop (optional)
<type>	Auswahl (order = Bestellung, request = Anfrage)	order	Typ des Auftrags (wird nicht ausgewertet)
<randomPinCode>	Alphanumerisch	48664411	Zufallspin (wird nicht ausgewertet)
<ip>	Alphanumerisch formatiert	91.53.190.30	IP Adresse (optional)
<orderDate>	Zeitstempel ISO-8601	2012-06-02 14:15:45	Bestelldatum
<deliveryDate>	Zeitstempel ISO-8601	2012-07-02 11:00:00	Lieferdatum
<deliveryPeriod>	Alphanumerisch	Vormittags	Lieferzeit (optional)
<comment>	Alphanumerisch	Leergut steht im Garten	Kommentar (optional)
<payment>	Auswahl (Cash = bar, Invoice = Rechnung, bankCollection = Einzug, paypal = PayPal)	bankCollection	Zahlweise
<paymentDeadlineInDays>	Ganzzahl	5	Zahlungsziel in Tagen
<paymentFeeForPaymentDeadlineInPercent>	Ganzzahl (wird nicht ausgewertet)	0	Mahnzins in Prozent (wird nicht ausgewertet)
<paymentFeeForPaymentDeadline>	Kommazahl	0.00	Mahngebühr als Betrag (wird nicht ausgewertet)
<priceMode>	Auswahl (gross = Verbraucher, net = Wiederverkäufer)	gross	Kundentyp
<merchandiseValue>	Kommazahl	81.84	Gesamt Netto (wird nicht ausgewertet)
<deliveryCosts>	Kommazahl	5.00	Liefergebühren (wird nicht ausgewertet)
<smallVolumePurchase>	Kommazahl	0.00	Mindermengenzuschlag (wird nicht ausgewertet)
<discountPercent>	Kommazahl	3.00	Rabatt in Prozent (wird nicht ausgewertet)
<discountFix>	Kommazahl	5.45	Rabatt als Betrag (wird nicht ausgewertet)
<sumDeposit>	Kommazahl	6.60	Pfand (wird nicht ausgewertet)
<sumFee>	Kommazahl	0.00	Gebühren (wird nicht ausgewertet)
<sumDeliveryCosts>	Kommazahl	0.00	Summe Transportkosten (wird nicht ausgewertet)
<sumTotal>	Kommazahl	75.24	Gesamtsumme ohne Pfand (wird nicht ausgewertet)

Die Entität "paymentDetails"

Die Entität ist in <order> enthalten, optional und einmalig. Sie enthält optionale Informationen zur Zahlweise

Entität	Typ	Beispiel	Erläuterungen
<paymentSystem>	Alphanumerisch	Bank	Zahlweise
<externalId>	Alphanumerisch	58	EDI-Code der Zahlweise

Die Entität "DeliveryDetails"

Die Entität ist in <order> enthalten, optional und wiederholbar. Sie enthält optionale Informationen zu Transportkosten

Entität	Typ	Beispiel	Erläuterungen
<type>	Auswahl (flat = pauschal, tba.)	flat	Berechnungsweise
<name>	Alphanumerisch	Anfahrtspauschale	Bezeichnung
<price>	Kommazahl	5.00	Betrag

Die Entität "article"

Die Entität ist in <order> enthalten, (thoretisch) optional und wiederholbar. Sie enthält Informationen zu Bestellposten

Entität	Typ	Beispiel	Erläuterungen
<amount>	Ganzzahl	2	Anzahl
<articleQuantity>	Ganzzahl	2	Anzahl
<articleNumber>	Alphanumerisch	301012	Artikelnummer ERP
<name>	Alphanumerisch	Coca Cola Zero	Bezeichnung
<package>	Alphanumerisch	12x1,00	Gebinde
<price>	Kommazahl	11.99	Ware Einzel
<unitPrice>	Kommazahl	11.99	Ware Einzel
<deposit>	Kommazahl	3.30	Pfand Einzel
<unitDeposit>	Kommazahl	0.00	Pfand pro Einheit
<unitFee>	Kommazahl	0.00	Gebühr
<taxRate>	Kommazahl	19.00	MwSt.Satz
<ean>	Alphanumerisch	4008287077018	EAN

Die Entität "customer"

Die Entität ist primär, notwendig und einmalig. Sie enthält Informationen zum Kunden

Entität	Typ	Beispiel	Erläuterungen
<externalAddressID>	Alphanumerisch	4535	Externe Adressnummer
<priceGroupID>	Ganzzahl	1	Nummer der Preisgruppe
<wdCustomerID>	Alphanumerisch	5456	Kundennummer Shop
<customerNumber>	Alphanumerisch	1101	Kundennummer ERP
<street>	Alphanumerisch	Musterstraße	Straße (darf Hausnummer enthalten)
<streetNumber>	Alphanumerisch	10b	Hausnummer (optional)
<additionalAddressInformation	Alphanumerisch	5. Etage	Zusatzinformationen
<floor>	Alphanumerisch	2	Etage
<elevator>	Logisch (ja, nein/leer)	Fahrstuhl vorhanden
<postcode>	Ganzzahl	35708	Postleitzahl
<town>	Alphanumerisch	Haiger	Ort
<salutation>	Alphanumerisch	Herr	Anrede
<title>	Alphanumerisch	Prof. Dr.	Titel
<company>	Alphanumerisch	Mustermann AG	Firma
<name>	Alphanumerisch	Mustermann	Name
<firstName>	Alphanumerisch	Max	Vorname
<phone>	Alphanumerisch	02773-12345	Telefonnummer
<fax>	Alphanumerisch		Telefaxnummer
<mobile>	Alphanumerisch	0175-1234567	Mobilfunknummer
<email>	Alphanumerisch	info@mail.de	E-Mailadresse
<registrationDate>	Zeitstempel ISO-8601	2012-04-03 15:00:00	Registrierdatum
<dateOfBirth>	Zeitstempel ISO-8601		Geburtsdatum (wird nicht ausgewertet)
<dataStatus>	Auswahl(new = Neu, tba)	new
<newsletter>	Logisch (ja, nein/leer)		Newsletteranmeldung

Die Entität "DeliveryAddress"

Die Entität ist in <customer> enthalten, optional und einmalig. Sie enthält optionale Informationen zur Lieferadresse

Entität	Typ	Beispiel	Erläuterungen
<street>	Alphanumerisch	Musterstraße	Straße (darf Hausnummer enthalten)
<streetNumber>	Alphanumerisch	10b	Hausnummer (optional)
<additionalAddressInformation	Alphanumerisch	5. Etage	Zusatzinformationen
<postcode>	Ganzzahl	35708	Postleitzahl
<town>	Alphanumerisch	Haiger	Ort
<title>	Alphanumerisch	Prof. Dr.	Titel
<company>	Alphanumerisch	Mustermann AG	Firma
<name>	Alphanumerisch	Mustermann	Name
<firstName>	Alphanumerisch	Max	Vorname

Die Entität "BankDetails"

Die Entität ist in <customer> enthalten, optional und einmalig. Sie enthält optionale Informationen zur Bankverbindung

Entität	Typ	Beispiel	Erläuterungen
<accountOwner>	Alphanumerisch	Max Mustermann	Kontoinhaber
<Iban>	Alphanumerisch	DE67416500011234567890	IBAN
<bic>	Alphanumerisch	WELADED1LIP	BIC

Abhängig vom <priceMode> werden die Preise Brutto oder Netto übergeben. Ausnahme ist der Wert <sumTotal>, welcher immer die Gesamtsumme inklusive der gesetzlichen Steuer enthält.

Die Tags <discountPercent und <discountFix> definieren mögliche Rabatte sowie Gutscheine. Bei prozentualen Rabatten sind diese direkt in den Artikelpreisen berücksichtigt. Bei einem Einmalbetrag werden die Werte in dem Tag <sumTotal> berücksichtigt.

Beispiel einer Auftragsdatei

<order>
 <orderID>5456</orderID>
 <type>order</type>
 <randomPinCode/>
 <ip>91.53.190.30</ip>
 <orderDate>2012-06-02 14:15:45</orderDate>
 <deliveryDate>2012-07-02 11:00:00</deliveryDate> 
 <deliveryPeriod>Vormittags</deliveryPeriod>
 <comment>Leergut steht im Garten</comment>
 <payment>bankCollection</payment>
 <paymentDetails>
  <paymentSystem>Bank</paymentSystem>
  <externalId>1200</externalId>
 </paymentDetails>  
 <paymentDeadlineInDays>5</paymentDeadlineInDays>
 <paymentFeeForPaymentDeadlineInPercent>0</paymentFeeForPaymentDeadlineInPercent>
 <paymentFeeForPaymentDeadline>0</paymentFeeForPaymentDeadline>
 <priceMode>gross</priceMode>
 <taxRate>19.00</taxRate>
 <merchandiseValue>75.69</merchandiseValue>
 <deliveryCosts>5.00</deliveryCosts>
 <smallVolumePurchase>0.00</smallVolumePurchase>
 <discountPercent>3.00</discountPercent>
 <discountFix>5.45</discountFix>
 <sumDeposit>0.00</sumDeposit>
 <sumFee>0.00</sumFee>
 <sumDeliveryCosts>0.00</sumDeliveryCosts>
 <sumTotal>75.24</sumTotal>
 <DeliveryDetails>
   <type>flat</type>
   <name>Anfahrtspauschale</name>
   <price>5.00</price>
 </DeliveryDetails>
 <article>
   <amount>2</amount>
   <articleQuantity>2</articleQuantity>    
   <articleNumber>301012</articleNumber>
   <name>Coca Cola Zero</name>
   <package>12x1,00</package>
   <price>11.99</price>
   <unitPrice>11.99</unitPrice>   
   <deposit>3.30</deposit>
   <unitDeposit>1.76</unitDeposit>
   <unitFee>0.00</unitFee>
   <taxRate>19.00</taxRate>
   <ean>4008287077018</ean>
 </article> 
</order>
<customer>
 <externalAddressID/>
 <priceGroupID>1</priceGroupID>
 <wdCustomerID>5456</wdCustomerID>
 <customerNumber>1101</customerNumber>
 <street>Musterstraße</street>
 <streetNumber>10</streetNumber>
 <additionalAddressInformation>5. Etage</additionalAddressInformation>
 <floor>2</floor>
 <elevator></elevator>
 <postcode>35708</postcode>
 <town>Haiger</town>
 <salutation>Herr</salutation>  
 <title>Prof. Dr.</title>
 <company>Mustermann AG</company>
 <name>Mustermann</name>
 <firstName>Max</firstName>
 <phone>02773-12345</phone>
 <fax></fax>
 <mobile>0175-1234567</mobile>
 <email>info@mail.de</email>
 <registrationDate>2012-04-03 15:00:00</registrationDate>
 <dateOfBirth/>
 <dataStatus>new</dataStatus>  
 <newsletter></newsletter> 
 <DeliveryAddress>
   <street>Musterstraße</street>
   <streetNumber>10</streetNumber>
   <additionalAddressInformation>5. Etage</additionalAddressInformation>
   <postcode>35708</postcode>
   <town>Haiger</town>
   <title>Prof. Dr.</title>
   <company>Mustermann AG</company>
   <name>Mustermann</name>
   <firstName>Max</firstName>
 </DeliveryAddress>
 <BankDetails>
   <accountOwner>Max Mustermann</accountOwner>
   <Iban>DE67416500011234567890</Iban>
   <bic>WELADED1LIP</bic>
 </BankDetails>
</customer>

Auftragsimport als JSON

Die Anwendung unterstützt den Auftragsimport mittels REST-API. Die Kommunikation erfolgt über eine HTTPS-Schnittstelle, welche JSON-Objekte im Request-Body erwartet. Die Zeichenkodierung ist UTF-8.

JSON-Objekte

JSON Request-Objekt:

• id: Eindeutiger Identifier innerhalb des Requests.
• command: String für den auszuführenden Command.
• params: Parameter für den Command.

JSON Response-Objekt:

• id: Hierbei handelt es sich um die übergebene Id des Requests.
• result: Bei einer erfolgreichen Verarbeitung wird immer ein result übergeben. Bei einem error existiert dieser Wert nicht.
• error: Ausschließlich bei einem Fehler existiert dieses Objekt. Es unterteilt sich immer in code und message. Bei einem Validierungsfehler wird ein Objekt input übergeben. Die Keys des Objektes enthalten die fehlgeschlagenen Parameter einschließlich der Fehlermeldung.

• Single data sent to Server:

{"id":"1","command":"articles/set","params":{"data":{"articleNumber":"H64326426","name":"Testartikel","quantity":3,"unit":1.74,"taxRate":19,"prices":[{"priceGroup":"1","fromArticleQuantity":1,"fromCartQuantity":1,"netPrice":8.15,"netDeposit":0}],"groups":[{"groupName":"Testgruppe"}]}}}

• Single data receive from Server:

{"id":"1","result":{"articles":{"data":{"id":"63f8340b5f86a975e10f8725"}}}}

• Batch data sent to Server:

[{"id":"1","command":"articles/update","params":{"data":{"articleNumber":"1","availability":"Kein Bestand"}}}, {"id":"2","command":"articles/update","params":{"data":{"articleNumber":"2","availability":"Kein Bestand"}}}]

• Batch data received from Server:

[{"id":"1","result":{"articles":{"updated":{"matched":1,"upserted":0,"modified":1}}}}, {"id":"2","result":{"articles":{"updated":{"matched":1,"upserted":0,"modified":1}}}}]

Authentifizierung

Die Authentifizierung erfolgt über einen API-Token, welcher über den Header "Authorisation: Bearer apiToken" wird.

cURL Beispiel-Request:

curl -X POST <domain>
-H "Authorisation: Bearer apiToken"
-H "Content-Type: application/json"
-d "{"id": 1,"command":"articles/delete", "params": {"data":{"articleNumber": "123"}}}"

Artikel

article Ratings

articleRatings_set {}

Feld	Typ	Beschreibung
id	Alphanumerisch
command	Alphanumerisch	Erlaubte Werte: articleRatings/set
params	Object

"params":{"data":{}}

Feld	Typ	Beschreibung
articleId	Alphanumerisch (24)
userId	Alphanumerisch (24)
username	Alphanumerisch (24)
Nachricht	Alphanumerisch (255)
rating	Integer (1..5)
Kommentar	Alphanumerisch (1.000)

"result":{"articleRatings": {"data":{} } }

Feld	Typ	Beschreibung
id	Alphanumerisch (24)

articleRatings_get {}

Feld	Typ	Beschreibung
id	Alphanumerisch
command	Alphanumerisch	Erlaubte Werte: articleRatings/get
params	Object

"params":{"filters": [{}, {}]}

Feld	Typ	Beschreibung
values	Array	Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich
fields	Array	Optional. Feld welches gefiltert werden soll. Erlaubte Werte: id, articleId, userId, username, rating
useRegex	Enum (0..1)	Optional. Default: 0
fieldOperator	Enum (and, or)	Optional. Default: or
or	Object	Optional. kann "or" oder Werte von filters enthalten.

"params":{"filterDates": [{}, {}]}

Feld	Typ	Beschreibung
fields	Array (lastUpdate, dateCreated)	Feld welches gefiltert werden soll
greaterThan	Alphanumerisch	Optional. Größenbereich: Date (Y-m-d H:i:s)
greaterThanEqual	Alphanumerisch	Optional. Größenbereich: Date (Y-m-d H:i:s)
lessThan	String	Optional. Größenbereich: Date (Y-m-d H:i:s)
lessThanEqual	Alphanumerisch	Optional. Größenbereich: Date (Y-m-d H:i:s)

"params":{"articleRatings": {}}

Feld	Typ	Beschreibung
start	Number	Optional. Startwert, Default: 0
limit	Number (40)	Optional. Maximale Anzahl an Einträgen
sort	array	Optional. Siehe "articleRatings": {"sort": [{}, {}]}
expectedData	Object	Optional. Siehe "articleRatings": {"expectedData": {}

"params":{"articleRatings": {"sort": [{}, {}]} }

Feld	Typ	Beschreibung
field	Alphanumerisch (id, articleId, userId, username, rating, dateCreated, lastUpdate)	Feld das sortiert werden soll
direction	Number (-1, 1)	Richtung der Sortierung

"params":{"articleRatings": {"expectedData": {}} }

! style="background:#B3B7FF" | Feld !! style="background:#B3B7FF" | Typ !! style="background:#B3B7FF" | Beschreibung |- |id |Number (1) | |- |articleId |Number (1) | |- |userId |Number (1) | |- |username |Number (1) | |- |rating |Number (1) | |- |dateCreated |Number (1) | |- |lastUpdate |Number (1) | |- |}

"result":{"articleRatings": {}}

! style="background:#B3B7FF" | Feld !! style="background:#B3B7FF" | Typ !! style="background:#B3B7FF" | Beschreibung |- |data |Array |Optional. Siehe "expectedData" |- |count |Object |Optional. Siehe "result":{"articleRatings": {"count": {} }} |}

"result":{"articleRatings": {"count": {} }}

! style="background:#B3B7FF" | Feld !! style="background:#B3B7FF" | Typ !! style="background:#B3B7FF" | Beschreibung |- |total |Number |Optional. Alle Einträge in der Datenbank |- |filtered |Number |Optional. Gefundene Einträge mit den übergebenen Parametern |}

"result":{"averageArticleRating": {}

! style="background:#B3B7FF" | Feld !! style="background:#B3B7FF" | Typ !! style="background:#B3B7FF" | Beschreibung |- |averageArticleRating |Number |Optional. Durchschnittliche Bewertung |}

articleRatings_delete {}

Feld	Typ	Beschreibung
id	Alphanumerisch
command	Alphanumerisch	Erlaubte Werte: articleRatings/deleted
params	Object

-->

"params":{"data":{}} Feld Typ Beschreibung id String

Größenbereich: 24 Zeichen "result":{"articleRatings":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge articles articles | 001. articles_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articles/set params Object "params":{"data":{}} Feld Typ Beschreibung articleNumber String

Artikelnummer

1. Artikelnummer

Größenbereich: 255 Zeichen name String

Artikelname

1. Artikeldaten > Kurztext

Größenbereich: 255 Zeichen quantity Number

Anzahl der Gebinde

1. Gruppierung > Stück je ME

Größenbereich: Int unit Number

Gebinde-Inhalt z.B. 0.33

1. Gruppierung > je Stück

Größenbereich: Float taxRate Number

Mehrwertsteuersatz

1. Verkaufspreise > Steuer-KZ

Größenbereich: Float groups Array

Array aus Objekten gem. "params":{"data":{"groups": [{}] }} prices Array

Array aus Objekten gem. "params":{"data":{"prices": [{}] }} partOfArticleNumber String

Teil eines Artikels z.B. Einzelflasche

Größenbereich: 255 Zeichen priceChanges Array

Array aus Objekten gem. "params":{"data":{"priceChanges": [{}] }} availability String

Verfügbarkeit. Sofern keine Verfügbarkeit hinterlegt wird, wird eine Verfügbarkeit anhand des Bestandes ausgelesen, welche der Kunde frei definieren kann.

Größenbereich: 255 Zeichen inventory Interger

Bestand createVoucherWhenOrdering Boolean

Auf true wird ein Gutschein erstellt in Höhe des Preise, wenn der Artikel bestellt wird. eanPackage String

DEPRECATED EAN-Verpackung

Größenbereich: 13 Zeichen eanBottle String

DEPRECATED EAN-Flasche

Größenbereich: 13 Zeichen eans Object

Array aus Objekten gem. "params":{"data":{"eans": [{}] }} packageType String

Gebindetyp

Größenbereich: 50 Zeichen depositPackageType String

Typ des Leerguts

Größenbereich: 50 Zeichen quantityAddition String

Gebindezusatz z.B. 6x4

Größenbereich: 50 Zeichen unitAddition String

Unit-Zusatz z.B. Flasche 33cl

Größenbereich: 255 Zeichen unitType String

Unit-Typ z.B. Flasche, Kiste

Größenbereich: 255 Zeichen unitOfMeasurement String

Maßeinheit der Unit (l, kg o.ä.)

Größenbereich: 50 Zeichen totalWeightInKg Number

Gewicht in Kilogramm

Größenbereich: Float brand String

Marke

Größenbereich: 255 Zeichen manufacturer String

Hersteller

Größenbereich: 255 Zeichen manufacturerCompanyAddress String

Adresse des Herstellers

Größenbereich: 5000 Zeichen manufacturerInternetAddress String

Internetadresse des Herstellers

Größenbereich: 255 Zeichen distributor String

Lieferant

Größenbereich: 255 Zeichen description String

Produktbeschreibung

Größenbereich: 5000 Zeichen additionalData String

Zusätzliche Angaben

Größenbereich: 5000 Zeichen country String

Land

Größenbereich: 255 Zeichen region String

Region

Größenbereich: 255 Zeichen winery String

Weingut

Größenbereich: 255 Zeichen wineType String

Weinart

Größenbereich: 255 Zeichen wineTypeFilter String

Weinart-Filter

Größenbereich: 1000 Zeichen relatedArticleGroup String

Produktname für eine Gruppierung von unterschiedlichen Gebinden

Größenbereich: 255 Zeichen relatedArticleGroupPos String

Position innerhalb der Gruppierung

Größenbereich: 255 Zeichen minimumDurability String

Mindesthaltbarkeit

Größenbereich: 255 Zeichen salesDescription String

Verkehrsbezeichnung des Herstellers

Größenbereich: 5000 Zeichen manufacturingLocation String

Herstellungsort

Größenbereich: 255 Zeichen certificates String

Zertifikate

Größenbereich: 5000 Zeichen alcoholicStrength String

Alkoholgehalt

Größenbereich: 255 Zeichen caffeine String

Koffeingehalt in g je 100ml

Größenbereich: 50 Zeichen foodDirectory String

Zutatenverzeichnis

Größenbereich: 5000 Zeichen additives Array

Array aus Strings mit maximal 255 Zeichen pro Wert ['Zusatzstoff', 'Zusatzstoff1'] allergenIngredients Array

Array aus Strings mit maximal 255 Zeichen pro Wert ['Allergene Zutat', 'Allergene Zutat1'] energyInKilojoule String

Brennwert in g Kilojoule je 100ml

Größenbereich: 50 Zeichen energyInKilokalorie String

Brennwert in g Kilokalorie je 100ml

Größenbereich: 50 Zeichen protein String

Eiweß in g je 100ml

Größenbereich: 50 Zeichen carbohydrates String

Kohlenhydrate in g je 100ml

Größenbereich: 50 Zeichen fatRate String

Fettgehalt in g je 100ml

Größenbereich: 50 Zeichen sugar String

Zucker in g je 100ml

Größenbereich: 50 Zeichen saturatedFattyAcids String

Gesättigte Fettsäuren in g je 100ml

Größenbereich: 50 Zeichen dietaryFibers String

Ballaststoffe in g je 100ml

Größenbereich: 50 Zeichen natrium String

Natrium in g je 100ml

Größenbereich: 50 Zeichen salt String

Salz in g je 100ml

Größenbereich: 50 Zeichen category String

Kategorie

Größenbereich: 255 Zeichen variety String

Rebsorte

Größenbereich: 255 Zeichen flavor String

Geschmack

Größenbereich: 255 Zeichen quality String

Qualität

Größenbereich: 255 Zeichen colorNuance String

Farbnuance

Größenbereich: 255 Zeichen drinkingTemperature String

Trinktemperatur

Größenbereich: 255 Zeichen acid String

Säuregehalt

Größenbereich: 255 Zeichen shelfLife String

Lagerfähigkeit

Größenbereich: 255 Zeichen recommendation String

Empfehlung

Größenbereich: 5000 Zeichen recommendationFilter String

Empfehlung

Größenbereich: 5000 Zeichen characteristics String

Charakter

Größenbereich: 5000 Zeichen soilType String

Bodenart

Größenbereich: 255 Zeichen vinification String

Vinifizierung

Größenbereich: 255 Zeichen scent String

Duft

Größenbereich: 5000 Zeichen residualSugar String

Restzucker

Größenbereich: 255 Zeichen flavorDescriptionShort String

Kurzbeschreibung Geschmack

Größenbereich: 5000 Zeichen flavorDescriptionLong String

Geschmacksbeschreibung

Größenbereich: 5000 Zeichen flavorDescriptionLong2 String

Geschmacksbeschreibung2

Größenbereich: 5000 Zeichen conclusion String

Fazit

Größenbereich: 5000 Zeichen growerInfo String

Winzerbeschreibung

Größenbereich: 5000 Zeichen vitamins String

Vitamine

Größenbereich: 5000 Zeichen keywords String

Keywords, welche für die Artikelsuche verwendet werden

Größenbereich: 5000 Zeichen dateDataStatus Datetime

Datum von dem Datenstand des Artikels

Größenbereich: Y-m-d H:i lmivInfo String

LMIVInfo z.B. Artikel benötigt keine LMIV-Daten; LMIV-Daten hinterlegt; productDBArticleNumber String

Artikelnummer der ProductDB considerQuantityInCart Boolean

Artikel wird bei der Artikelmenge für den Preis fromCartQuantity berücksichtigt, sofern der Wert auf true steht visibilityGroups Array

Array aus Strings mit maximal 255 Zeichen pro Wert ['public', 'specialCustomers'] SEO Object

SEO Details s. "params":{"data":{"SEO": {} }}) notifications Array

Array aus Objekten gem. "params":{"data":{"notifications": [{}] }} images Array

Array aus Objekten gem. "params":{"data":{"images": [{}] }} "params":{"data":{"SEO": [{}] }} Feld Typ Beschreibung title String

Titel

Größenbereich: 80 Zeichen description String

Beschreibung

Größenbereich: 200 Zeichen keywords String

Keywords

Größenbereich: 200 Zeichen "params":{"data":{"groups": [{}] }} Feld Typ Beschreibung groupName String

Hauptgruppe

Größenbereich: 255 Zeichen group1Name String

Untergruppe 1

Größenbereich: 255 Zeichen group2Name String

Untergruppe 2

Größenbereich: 255 Zeichen "params":{"data":{"eans": [{}] }} Feld Typ Beschreibung ean String

EAN

Größenbereich: 13 Zeichen note String

Notiz (z.B. Flasche)

Größenbereich: 255 Zeichen "params":{"data":{"prices": [{}] }} Feld Typ Beschreibung priceGroup String

Preisgruppe

Größenbereich: 50 Zeichen netPrice Number

Netto-Preis

Größenbereich: Float netDeposit Number

Netto-Pfand

Größenbereich: Float netFee Number

Netto-Gebühr

Größenbereich: Float grossFee Number

Brutto-Gebühr

Größenbereich: Float fromArticleQuantity Number

Ab Menge von diesem Artikel

Größenbereich: Int fromCartQuantity Number

Ab Menge von der Artikelanzahl innerhalb des Warenkorbs. Berücksichtigt werden ausschließlich Artikel die den Wert considerQuantityInCart auf true stehen haben

Größenbereich: Int validFrom Datetime

Gültig von

Größenbereich: Y-m-d H:i validTo Datetime

Gültig bis

Größenbereich: Y-m-d H:i "params":{"data":{"priceChanges": [{}] }} Feld Typ Beschreibung priceGroup String

Preisgruppe

Größenbereich: 50 Zeichen fromArticleQuantity Int

Ab Menge des Artikels (nicht Menge im Warenkorb) netPrice Number

Netto-Preis Der Preis dient nur als Info für den Kunden und wird nicht in der Preisziehung berücksichtigt!!!

Größenbereich: Float validFrom Datetime

Gültig von

Größenbereich: Y-m-d "params":{"data":{"disableOrder": {} }}) Feld Typ Beschreibung from Datetime

Deaktiviert die Bestellung ab dem übergebenen Datum

Größenbereich: Y-m-d H:i to Datetime

Deaktiviert die Bestellung bis zu dem übergebenen Datum

Größenbereich: Y-m-d H:i "params":{"data":{"invisible": {} }}) Feld Typ Beschreibung from Datetime

Der Artikel ist ab dem übergebenen Datum im Shop nicht sichtbar

Größenbereich: Y-m-d H:i to Datetime

Der Artikel bis zu dem übergebenem im Shop nicht sichtbar

Größenbereich: Y-m-d H:i "params":{"data":{"notifications": [{}] }} Feld Typ Beschreibung category String

Z.B. Neuheit

Größenbereich: 255 Zeichen validFrom Datetime

Gültig von

Größenbereich: Y-m-d H:i validTo Datetime

Gültig bis

Größenbereich: Y-m-d H:i "params":{"data":{"images": [{}] }} Feld Typ Beschreibung filePath String

Die Daten werden über die Schnittstelle "uploads/image" erstellt thumbnails Array "params":{"data":{"images": [{"thumbnails":[{}]}] }} Feld Typ Beschreibung small String

Kleinste Auflösung medium String

Mittlere Auflösung big String

Große Auflösung "result":{"articles": {"data":{} } } Feld Typ Beschreibung id String articles | 002. articles_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articles/get params Object "params":{} Feld Typ Beschreibung customerId Number

Id des ausgewählten customers, um die jeweilige Preisgruppe des Kunden zu berücksichtigen. deliveryDate String

Lieferdatum Y-m-d . Es werden die Preise des jeweiligen Lieferdatums ermittelt.

Standardwert: Datum von Heute filters Array

S. "params":{"filters": [{}, {}]} filterNumbers Array

S. "params":{"filterNumbers": [{}, {}]} filterDates Array

S. "params":{"filterDates": [{}, {}]} filterDatesArticlePrices Array

S. "params":{"filterDatesArticlePrices": [{}, {}]} filterText Array

S. "params":{"filterText": {}]} "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. fields Array

Felder welches gefiltert werden sollen. Falls nicht übergeben, werden alle Felder für den Filter verwendet

Erlaubte Werte: id, articleNumber, partOfArticleNumber, name, nameASCII, eans.ean, description, salesDescription, flavor, quality, keywords, colorNuance, recommendation, recommendationFilter, characteristics, soilType, scent, flavorDescriptionShort, flavorDescriptionLong, conclusion, growerInfo, wineDescription, additionalData, groups.groupName, groups.group1Name, groups.group2Name, notifications.category, quantity, unit, unitType, availability, inventory, packageType, unitAddition, depositPackageType, unitOfMeasurement, brand, manufacturer, distributor, country, region, relatedArticleGroup, manufacturingLocation, certificates, alcoholicStrength, caffeine, additives, allergenIngredients, category, vinification, variety, visibilityGroups, lmivInfo, productDBArticleNumber useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regulären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 or Object

Das Objekt or kann die identischen Werte von filters enthalten. "params":{"filterNumbers": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: inventory fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or greaterThan Float

Größer als lessThan Float

Kleiner als or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: notifications.validFrom, notifications.validTo, lastUpdate, dateCreated fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDatesArticlePrices": [{}, {}]} Feld Typ Beschreibung field String

Feld welches gefiltert werden soll

Erlaubte Werte: validFrom, validTo greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) "params":{"filterText": [{}, {}]} Feld Typ Beschreibung value String

Wert nach dem gesucht werden soll. Auf das Feld name ist ein Text-Index gesetzt, damit die Suche bei großen Datenbanken performanter ist, als mit einem Regex. "params":{"articles": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 groupBy Object

Siehe "articles": {"groupBy": {}} sortByPassedArticleNumbers Array

Array aus Artikelnummern. Die Sortierung erfolgt nach der übergebenen Reihenfolge. sortArticlePrice Object

Siehe "articles": {"sortArticlePrice": {}} sortIndividual String

Der Kunde kann über das Shopbackend intern eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben sort Array

Siehe "articles": {"sort": [{}, {}]} expectedData Object

Siehe "articles": {"expectedData": {} "params":{"articles": {"groupBy": {}} } Feld Typ Beschreibung field Enum

Feld welches gruppiert werden sollen

Erlaubte Werte: relatedArticleGroup "params":{"articles": {"sortArticlePrice": {}} } Feld Typ Beschreibung direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 fromArticleQuantity Number

Ab Menge fromCartQuantity Number

Ab Menge "params":{"articles": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll. Die Sortierung für den filterTextScore ist nur vorhanden, wenn der filterText übergeben wurde

Erlaubte Werte: articleNumber, partOfArticleNumber, name, groups.groupName, groups.group1Name, groups.group2Name, notifications.category, quantity, unit, availability, packageType, depositPackageType, unitOfMeasurement, brand, manufacturer, distributor, country, inventory, region, relatedArticleGroups, manufacturingLocation, certificates, alcoholicStrength, caffeine, additives, allergenIngredients, category, variety, recommendationFilter, dateCreated, lastUpdate, filterTextScore direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"articles": {"expectedData": {}} } Feld Typ Beschreibung articleNumber Number

Erlaubte Werte: 1 name Number

Erlaubte Werte: 1 nameASCII Number

Erlaubte Werte: 1 quantity Number

Erlaubte Werte: 1 unit Number

Erlaubte Werte: 1 tax Number

Erlaubte Werte: 1 groups Number

Erlaubte Werte: 1 prices Number

Erlaubte Werte: 1 bestPrice Number

Gibt den besten Preis unter berücksichtigung des eingeloggten Kunden zurück

Erlaubte Werte: 1 priceChanges Number

Gibt zukünftige Preisänderungen zurück

Erlaubte Werte: 1 inventory Number

Erlaubte Werte: 1 availability Number

Erlaubte Werte: 1 eans Number

Erlaubte Werte: 1 packageType Number

Erlaubte Werte: 1 depositPackageType Number

Erlaubte Werte: 1 quantityAddition Number

Erlaubte Werte: 1 unitAddition Number

Erlaubte Werte: 1 unitOfMeasurement Number

Erlaubte Werte: 1 totalWeightInKg Number

Erlaubte Werte: 1 brand Number

Erlaubte Werte: 1 manufacturer Number

Erlaubte Werte: 1 manufacturerCompanyAddress Number

Erlaubte Werte: 1 manufacturerInternetAddress Number

Erlaubte Werte: 1 distributor Number

Erlaubte Werte: 1 description Number

Erlaubte Werte: 1 additionalData Number

Erlaubte Werte: 1 country Number

Erlaubte Werte: 1 region Number

Erlaubte Werte: 1 relatedArticleGroup Number

Erlaubte Werte: 1 minimumDurability Number

Erlaubte Werte: 1 salesDescription Number

Erlaubte Werte: 1 manufacturingLocation Number

Erlaubte Werte: 1 certificates Number

Erlaubte Werte: 1 alcoholicStrength Number

Erlaubte Werte: 1 caffeine Number

Erlaubte Werte: 1 foodDirectory Number

Erlaubte Werte: 1 additives Number

Erlaubte Werte: 1 allergenIngredients Number

Erlaubte Werte: 1 energyInKilojoule Number

Erlaubte Werte: 1 energyInKilokalorie Number

Erlaubte Werte: 1 protein Number

Erlaubte Werte: 1 carbohydrates Number

Erlaubte Werte: 1 fatRate Number

Erlaubte Werte: 1 sugar Number

Erlaubte Werte: 1 saturatedFattyAcids Number

Erlaubte Werte: 1 dietaryFibers Number

Erlaubte Werte: 1 natrium Number

Erlaubte Werte: 1 salt Number

Erlaubte Werte: 1 category Number

Erlaubte Werte: 1 variety Number

Erlaubte Werte: 1 flavor Number

Erlaubte Werte: 1 quality Number

Erlaubte Werte: 1 colorNuance Number

Erlaubte Werte: 1 drinkingTemperature Number

Erlaubte Werte: 1 acid Number

Erlaubte Werte: 1 shelfLife Number

Erlaubte Werte: 1 recommendation Number

Erlaubte Werte: 1 recommendationFilter Number

Erlaubte Werte: 1 characteristics Number

Erlaubte Werte: 1 soilType Number

Erlaubte Werte: 1 vinification Number

Erlaubte Werte: 1 scent Number

Erlaubte Werte: 1 SEO Number

Erlaubte Werte: 1 residualSugar Number

Erlaubte Werte: 1 flavorDescriptionShort Number

Erlaubte Werte: 1 flavorDescriptionLong Number

Erlaubte Werte: 1 conclusion Number

Erlaubte Werte: 1 growerInfo Number

Erlaubte Werte: 1 wineDescription Number

Erlaubte Werte: 1 considerQuantityInCart Number

Erlaubte Werte: 1 visibilityGroups Number

Erlaubte Werte: 1 disableOrder Number

Erlaubte Werte: 1 notifications Number

Erlaubte Werte: 1 keywords Number

Erlaubte Werte: 1 images Number

Erlaubte Werte: 1 vitamins Number

Erlaubte Werte: 1 dateDataStatus Number

Erlaubte Werte: 1 productDBArticleNumber Number

Erlaubte Werte: 1 lmivInfo Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "params":{"groups": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"groups1": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"availabilities": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"packageTypes": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"brands": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"manufacturer": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"distributors": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"countries": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"regions": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"manufacturingLocations": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"flavors": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"recommendationsFilter": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "params":{"priceChanges": {}} Feld Typ Beschreibung _ String

Sobald ein leeres Objekt übergeben wurde, werden die priceChanges im result ausgegeben. "params":{"notifications": {}} Feld Typ Beschreibung searchString String

Suchwert. Reguläre Ausdrücke möglich sortIndividual String

Der Kunde kann über das Shopbackend eine eigene Sortierungen festlegen, welche über eine Kategorie definiert werden. Bei Übergabe wird die Sortierung der jeweiligen Kategorie zurückgegeben "result":{"groups": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"groups": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"groups": {"count": {} }} "result":{"groups": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"groups": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"groups1": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"groups1": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"groups1": {"count": {} }} "result":{"groups1": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"groups1": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"groups2": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"groups1": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"groups1": {"count": {} }} "result":{"groups2": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"groups2": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"units": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"units": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"units": {"count": {} }} "result":{"units": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"units": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"availabilities": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"availabilities": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"availabilities": {"count": {} }} "result":{"availabilities": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"availabilities": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"inventories": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"inventories": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"inventories": {"count": {} }} "result":{"inventories": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"inventories": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"packageTypes": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"packageTypes": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"packageTypes": {"count": {} }} "result":{"packageTypes": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"packageTypes": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"unitAdditions": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"unitAdditions": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"unitAdditions": {"count": {} }} "result":{"unitAdditions": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"unitAdditions": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"brands": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"brands": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"brands": {"count": {} }} "result":{"brands": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"brands": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"manufacturer": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"manufacturer": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"manufacturer": {"count": {} }} "result":{"manufacturer": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"manufacturer": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"distributors": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"distributors": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"distributors": {"count": {} }} "result":{"distributors": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"distributors": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"countries": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"countries": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"countries": {"count": {} }} "result":{"countries": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"countries": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"regions": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"regions": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"regions": {"count": {} }} "result":{"regions": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"regions": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"manufacturingLocations": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"manufacturingLocations": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"manufacturingLocations": {"count": {} }} "result":{"manufacturingLocations": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"manufacturingLocations": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"flavors": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"flavors": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"flavors": {"count": {} }} "result":{"flavors": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"flavors": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"recommendationsFilter": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"recommendationsFilter": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"recommendationsFilter": {"count": {} }} "result":{"recommendationsFilter": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"recommendationsFilter": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"notifications": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"notifications": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"notifications": {"count": {} }} "result":{"notifications": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"notifications": {"data": [{}, {}] }} Feld Typ Beschreibung value String

Der gruppierte Wert articlesCount Number

Gefundene Artikel zu diesem Wert "result":{"priceChanges": {}} Feld Typ Beschreibung data Array

Ein Array aus Objekten. Siehe "result":{"priceChanges": {"data": [{}, {}] }}

Falls keine Einträge gefunden wurde, wird ein leeres Array zurückgeliefert. count Object

Siehe "result":{"priceChanges": {"count": {} }} "result":{"priceChanges": {"data": [{}, {}] }} Feld Typ Beschreibung articleNumber String

Artikelnummer, welche eine Preisänderung hat "result":{"articles": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"articles": {"count": {} }} "result":{"articles": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern articles | 003. articles_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articles/update params Object "params":{"data":{}} Feld Typ Beschreibung articleNumber String

Artikelnummer

Hinweis Die Parameter in dem Objekt data sind identisch zu dem command articles/set . Abweichend zu articles/set sind alle Felder optional (mit Ausnahme der articleNumber). Es werden uasschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 255 Zeichen "params":{"unset":[]} Feld Typ Beschreibung unset Array

Entfernt die Spalten aus der Datenbank

Erlaubte Werte: invisible, disableOrder "result":{"articles":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte articles | 004. articles_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articles/delete params Object "params":{"data":{}} Feld Typ Beschreibung articleNumber String

Artikelnummer partOfArticleNumber String

Löscht alle Artikel die den Wert enthalten "result":{"articles":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge articles | 005. articleRecommendations_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articleRecommendations/set params Object "params":{"data":{}} Feld Typ Beschreibung articleNumber String

Artikelnummer

Größenbereich: 255 Zeichen recommendations Array

Array aus Artikelnummern "result":{"articleRecommendations": {"data":{} } } Feld Typ Beschreibung id String articles | 006. articleRecommendations_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articleRecommendations/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: articleNumber fieldOperator Enum

Operator für die Felder

Standardwert: or

Erlaubte Werte: or, and useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"articleRecommendations": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "articleRecommendations": {"sort": [{}, {}]} expectedData Object

Siehe "articleRecommendations": {"expectedData": {} "params":{"articleRecommendations": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: articleNumber direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"articleRecommendations": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 articleNumber Number

Erlaubte Werte: 1 recommendations Number

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"articleRecommendations": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"articleRecommendations": {"count": {} }} "result":{"articleRecommendations": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern articles | 007. articleRecommendations_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articleRecommendations/update params Object "params":{"data":{}} Feld Typ Beschreibung articleNumber String

Artikelnummer

Größenbereich: 255 Zeichen recommendations Array

Array aus Artikelnummern "result":{"articleRecommendations":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte articles | 008. articleRecommendations_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articleRecommendations/delete params Object "params":{"data":{}} Feld Typ Beschreibung articleNumber String "result":{"articleRecommendations":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge articles | 009. articlePrices_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articlePrices/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Erlaubte Werte: customerNumber, articleNumber, priceGroup fieldOperator Enum

Operator für die Felder

Standardwert: or

Erlaubte Werte: or, and useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: date fieldOperator Enum

Operator für die Felder

Standardwert: or

Erlaubte Werte: or, and greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"articlePrices": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "articlePrices": {"sort": [{}, {}]} expectedData Object

Siehe "articlePrices": {"expectedData": {} "params":{"articlePrices": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Erlaubte Werte: customerNumber, articleNumber, priceGroup, netPrice, netDeposit, netFee, fromArticleQuantity, fromCartQuantity, validFrom, validTo, dateCreated direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"articlePrices": {"expectedData": {}} } Feld Typ Beschreibung customerNumber Number

Erlaubte Werte: 1 articleNumber Number

Erlaubte Werte: 1 priceGroup Number

Erlaubte Werte: 1 netPrice Number

Erlaubte Werte: 1 netDeposit Number

Erlaubte Werte: 1 netFee Number

Erlaubte Werte: 1 fromArticleQuantity Number

Erlaubte Werte: 1 fromCartQuantity Number

Erlaubte Werte: 1 validFrom Number

Erlaubte Werte: 1 validTo Number

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 "result":{"articlePrices": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"articlePrices": {"count": {} }} "result":{"articlePrices": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern articles | 010. articleIndividualSort_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articleIndividualSort/set params Object "params":{"data":{}} Feld Typ Beschreibung type Enum

Typ

Erlaubte Werte: article, group sortName String

Name der Sortierung

Größenbereich: 255 Zeichen value String

Eindeutige Identifizierung (z.B. articleNumber oder groupName)

Größenbereich: 255 Zeichen pos Float

Position des Eintrags "result":{"articleIndividualSort": {"data":{} } } Feld Typ Beschreibung id String articles | 011. articleIndividualSort_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articleIndividualSort/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: type, category, value fieldOperator Enum

Operator für die Felder

Standardwert: or

Erlaubte Werte: or, and useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"articleIndividualSort": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 100.000 groupBy String

Gruppiert die Eintrage anhand des übergebenen Feldes

Erlaubte Werte: category sort Array

Siehe "articleIndividualSort": {"sort": [{}, {}]} expectedData Object

Siehe "articleIndividualSort": {"expectedData": {} "params":{"articleIndividualSort": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: type, category, pos direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"articleIndividualSort": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 type Number

Erlaubte Werte: 1 category Number

Erlaubte Werte: 1 value Number

Erlaubte Werte: 1 pos Number

Erlaubte Werte: 1 "result":{"articleIndividualSort": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"articleIndividualSort": {"count": {} }} "result":{"articleIndividualSort": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern articles | 012. articleIndividualSort_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: articleIndividualSort/delete params Object "params":{"data":{}} Feld Typ Beschreibung code String

Eindeutige Nummer des Dokuments "result":{"articleIndividualSort":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge captcha captcha | 1. captcha_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: captcha/get "result":{"captcha": {"data":{} } } Feld Typ Beschreibung question String

Frage welches Bild gesucht wird answerOptions Array

Antwortmöglichkeiten "result":{"captcha": {"data":{"answerOptions": [{}]} } } Feld Typ Beschreibung id String

Id der Antwort img String

URL des Bildes captcha | 2. captcha_verify post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: captcha/verify params Object "params":{"data":{}} Feld Typ Beschreibung questionId String

Größenbereich: 255 Zeichen answerId String

Größenbereich: 255 Zeichen "result":{"captcha": {"data":{} } } Feld Typ Beschreibung expiredIn Int

Ablaufzeit in Sekunden configs configs | 1. configs_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: configs/set params Object "params":{"data":{}} Feld Typ Beschreibung type ENUM

Von jedem Typ darf nur ein Eintrag existieren.

Erlaubte Werte: live, develop articleDetailTextTop String

Text wird im Kopfbereich von jedem Artikel ausgelesen

Größenbereich: 1000 Zeichen articleDetailTextBottom String

Text wird im Fußbereich von jedem Artikel ausgelesen

Größenbereich: 1000 Zeichen articleGroupByRelatedArticleGroup Boolean

Gruppiert die Artikel nach der relatedArticleGroup articleDetailStructures Array

S. "params":{"data":{"articleDetailStructures":[{}, {}] } } articleSearchInFields Array

S. "params":{"data":{"articleSearchInFields":[{}, {}] } } articleListAvailableFilters Array

S. "params":{"data":{"articleListAvailableFilters":[{}, {}] } } articleAvailabilities Array

S. "params":{"data":{"articleAvailabilities":[{}, {}] } } disableOrderForArticles Object

S. "params":{"data":{"disableOrderForArticles":{}, {} } } countries Array

Länder die im Shop zur Verfügung stehen currency String

Währung

Erlaubte Werte: EUR, CHF customerShopFields Object

S. "params":{"data":{"customerShopFields":[{}, {}] } } customerLoginTextTop String

Text wird im Kopfbereich des Logins ausgelesen

Größenbereich: 1000 Zeichen customerRegisterTextTop String

Text wird im Kopfbereich der Kundenregistrierung ausgelesen

Größenbereich: 1000 Zeichen customerRegisterTextBottom String

Text wird im Fußbereich der Kundenregistrierung ausgelesen (oberhalt der optionalen dynamischen Artikel)

Größenbereich: 1000 Zeichen defaultArticleTemplate String

Standard-Artikel Template

Erlaubte Werte: gallery, list defaultCountry String

Default-Land, wenn der Kunde noch keins gewählt hat defaultPriceGroup String

Öffentliche Preisgruppe defaultVisibilityGroups Array

Diese Gruppen werden ausgelesen, wenn der Kunde keine Gruppe hinterlegt hat depositTaxRate Number

Globale Mehrwertsteuer auf den Pfand depositNetEqualGrossForPrivateCustomers Boolean

Netto-Pfand ist gleich Brutto-Pfand, wenn das Rechnungsfeld für die Firma gefüllt ist depositTaxRateExceptions Object

Ausnahmen für die Steuer des Pfands S. "params":{"data":{"depositTaxRateExceptions":[{}, {}] } } dealer Object

S. "params":{"data":{"dealer":[{}, {}] } } deliveryAreaOverlayText Object

Text der innerhalb des Overlays, für die Auswahl der Liefergebiete, ausgelesen wird dynamicCSS String

CSS-Code der über eine externe CSS-Datei geladen wird

Größenbereich: 5000 Zeichen dynamicJS String

JavaScript-Code der über eine externe JS-Datei geladen wird (DOM existiert zum Zeitpunkt der Einbindung).

Größenbereich: 5000 Zeichen favicons Object

S. "params":{"data":{"favicons":[{}, {}] } } layoutHtmlHead String

HTML-Code für den Head

Größenbereich: 5000 Zeichen layoutHtmlFoot String

HTML-Code für den Fuß

Größenbereich: 5000 Zeichen layoutPrimaryColor String

Primärfarbe (Hex-Code)

Größenbereich: 7 Zeichen layoutPrimaryColorInvert String

Primärfarbe für z.B. Schrift (Hex-Code)

Größenbereich: 7 Zeichen layoutSecondaryColor String

Sekundärfarbe (Hex-Code)

Größenbereich: 7 Zeichen layoutSecondaryColorInvert String

Sekundärfarbe für z.B. schrift (Hex-Code)

Größenbereich: 7 Zeichen logoutAfterOrder Boolean

Soll der Kunde nach der Bestellung ausgeloggt werden manifest String

site.webmanifest

Größenbereich: 5000 Zeichen redirectRouterLinkAfterLogin String

Wenn der User sich auf der Startseite einloggt, wird er auf den hinterlegten RouterLink weitergeleitet z.B. /customer/favorites showArticleRating Boolean

Aktiviert die Bewertung für Artikel orderDeliveryDateSelectable Boolean

Lieferdatum auswählbar orderEmailSettings Array

S. "params":{"data":{"orderEmailSettings":[{}, {}] } } emailServer Object

S. "params":{"data":{"emailServer":{}, {} } } taxRate Number

Globale Mehrwertsteuer SEO Object

S. "params":{"data":{"SEO":[{}] } } shopUrl String

URL des Shops

Größenbereich: 255 Zeichen shopLoginRequired Boolean

Kunde muss sich vorab einloggen, um den Shop einzusehen sortArticleList Array

S. "params":{"data":{"sortArticleList":[{}] } } sortArticle Object

S. "params":{"data":{"sortArticle":{} } } sortGroup Object

S. "params":{"data":{"sortGroup":{} } } sortGroup1 Object

S. "params":{"data":{"sortGroup1":{} } } paymentMethods Object

S. "params":{"data":{"paymentMethods":[{}, {}] } } voucherPDFTemplate Object

Smarty-Template für gekaufte Gutscheine, welches als PDF angehängt werden. Smarty-Variablen {$value} {$code} productDBToken String

Smarty-Template für gekaufte Gutscheine, welches als PDF angehängt werden. Smarty-Variablen {$value} {$code}

Größenbereich: 255 Zeichen productDBFields Array

Smarty-Template für gekaufte Gutscheine, welches als PDF angehängt werden. Smarty-Variablen {$value} {$code}

Erlaubte Werte: images, groups, description, quantity, quantityAddition, unit, unitOfMeasurement, unitAddition, packageType, totalWeightInKg, additionalData, manufacturer, manufacturerCompanyAddress, manufacturerInternetAddress, manufacturingLocation, brand, category, certificates, country, region, recommendation, recommendationFilter, flavorDescriptionLong, flavorDescriptionShort, flavorDescriptionLong2, conclusion, salesDescription, distributor, allergenIngredients, additives, foodDirectory, vitamins, shelfLife, minimumDurability, alcoholicStrength, caffeine, energyInKilojoule, energyInKilokalorie, protein, carbohydrates, saturatedFattyAcids, fatRate, dietaryFibers, natrium, salt, sugar, wineType, growerInfo, soilType, residualSugar, acid, variety, flavor, quality, colorNuance, drinkingTemperature, scent, vinification, SEO, relatedArticleGroup "params":{"data":{"articleSearchInFields":[{}, {}] } } Feld Typ Beschreibung field Enum

Die Artikelsuche wird in den übergebenen Feldern durchgeführt

Erlaubte Werte: articleNumber, partOfArticleNumber, name, groups.groupName, groups.group1Name, notifications.category, quantity, unit, availability, packageType, depositPackageType, unitOfMeasurement, brand, manufacturer, distributor, country, inventory, region, relatedArticleGroups, manufacturingLocation, certificates, alcoholicStrength, caffeine, additives, allergenIngredients, category, variety, recommendationFilter, dateCreated, lastUpdate "params":{"data":{"articleAvailabilities":[{}, {}] } } Feld Typ Beschreibung availability String

Verfügbarkeit

Größenbereich: 255 Zeichen color String

Farbe als Hexcode z.B. #ff0000

Größenbereich: 7 Zeichen fromInventory Number

Ab Bestand

Größenbereich: Int toInventory Number

Bis Bestand

Größenbereich: Int "params":{"data":{"articleDetailStructures":[{}, {}] } } Feld Typ Beschreibung tabName String

Name des Tabs

Größenbereich: 255 Zeichen fields Object

S. "params":{"data":{"articleDetailStructures":[{fields:{}}] } } "params":{"data":{"articleDetailStructures":[{fields: {}}, {}] } } Feld Typ Beschreibung name String

Name des Feldes

Größenbereich: 255 Zeichen nameInternal String

Interner Feldname innerhalb der Datenbank

Größenbereich: 255 Zeichen selected Bool

Feld wird angezeigt "params":{"data":{"articleListAvailableFilters":[{}, {}] } } Feld Typ Beschreibung name String

Name des Filters

Größenbereich: 255 Zeichen field Enum

Feldname des Filters

Erlaubte Werte: unitType, unitAddition, certificates, groups.group1Name, availability, brand, country, packageType, manufacturer, distributor, region, manufacturingLocation, recommendationFilter, inventory responseName Enum

Feldname wie er von der Schnittstelle zurückkommt

Erlaubte Werte: unitTypes, unitAdditions, certificates, groups1, availabilities, brands, countries, packageTypes, manufacturer, distributors, manufacturingLocations, regions, recommendationsFilter, notifications, inventories "params":{"data":{"dealer":[{}, {}] } } Feld Typ Beschreibung logoUrl String

URL zum Logo

Größenbereich: 255 Zeichen company String

Name der Firma

Größenbereich: 255 Zeichen owner String

Inhaber / Geschäftsführer der Firma. Bitte Gesellschaftsform beachten!

Größenbereich: 255 Zeichen street String

Straße

Größenbereich: 255 Zeichen postcode String

Postleitzahl

Größenbereich: 255 Zeichen town String

Stadt

Größenbereich: 255 Zeichen phone String

Telefon

Größenbereich: 255 Zeichen commercialRegister String

Handelsregister

Größenbereich: 1000 Zeichen VATRegistrationNumber String

Umsatzsteuer-Identifikationsnummer

Größenbereich: 255 Zeichen additionalInformation String

Zusatzinformationen z.B. BIO-Nummer

Größenbereich: 5000 Zeichen email String

E-Mail

Größenbereich: 255 Zeichen "params":{"data":{"depositTaxRateExceptions":[{}, {}] } } Feld Typ Beschreibung priceGroups Array

Bei den übergebenen Preisgruppen wird keine Steuer auf das Pfand berechnet "params":{"data":{"disableOrderForArticles":{} } } Feld Typ Beschreibung whenInventoryExceeded Boolean

Wenn der maximale Bestand erreicht ist. whenInventoryExceededRequiredPriceGroups Array

Gilt ausschließlich für die hinterlegen Preisgruppen, falls der Wert nicht existiert, gilt es für alle Preisgruppen atAvailabilities Array

String aus Arrays. Bei den Verfügbarkeiten ist keine Bestellung möglich "params":{"data":{"disableOrderForArticles":{"atAvailabilities": {}} } } Feld Typ Beschreibung availability String

Verfügbarkeit die gesperrt werden soll "params":{"data":{"disableOrderForArticles":{"requiredPriceGroups": {}} } } Feld Typ Beschreibung requiredPriceGroups Array

Gilt ausschließlich für die hinterlegen Preisgruppen, falls der Wert nicht existiert, gilt es für alle Preisgruppen "params":{"data":{"emailServer":{} } } Feld Typ Beschreibung email Email

E-Mail-Adresse replyTo Email

Antwort an (E-Mail-Adresse) from String

Absendername

Größenbereich: 255 Zeichen host String

SMTP-Host

Größenbereich: 255 Zeichen username String

Benutzername

Größenbereich: 255 Zeichen password String

Passwort

Größenbereich: 255 Zeichen smtpAuth Boolean

SMTP-Authentifizierung encryption Enum

Verschlüsselung

Erlaubte Werte: none, tls, ssl port Number

Port "params":{"data":{"favicons":{} } } Feld Typ Beschreibung ico String

Größenbereich: 255 Zeichen svg String

Größenbereich: 255 Zeichen 96x96 String

Größenbereich: 255 Zeichen 180x180 String

Größenbereich: 255 Zeichen 192x192 String

Größenbereich: 255 Zeichen 512x512 String

Größenbereich: 255 Zeichen "params":{"data":{"orderEmailSettings":[{}, {}] } } Feld Typ Beschreibung orderType String

Erlaubte Werte: order, orderRequest recipients Array

Array subjects Array

Siehe "params":{"data":{"orderEmailSettings":[{subjects:[]} } } textFieldTop String

Wird im oberen Bereich der Bestätigung ausgelesen

Größenbereich: 5000 Zeichen textFieldBottom String

Wird im unteren Bereich der Bestätigung ausgelesen

Größenbereich: 5000 Zeichen visibilitySinglePrice Bool

Zeigt den Einzelpreis an visibilityUnitPrice Bool

Zeigt den Unitpreis an attachments Array

Array aus Anhängen "params":{"data":{"orderEmailSettings":[{subjects:[]} } } Feld Typ Beschreibung subject String

Betreff. Der Platzhalter :orderId wird durch die jeweilige ID ersetzt.

Größenbereich: 100 Zeichen requiredDynamicArticleIds Array

Der Betreff wird nur verwendet, wenn die ids in der Order enthalten sind "params":{"data":{"customerShopFields":[{}, {}] } } Feld Typ Beschreibung field Enum

Erlaubte Werte: salutation, fistName, name, company, phone, email, dateOfBirth, street, postcode, town, country, floor, elevator required Bool disabled Bool hidden Bool errorMsg String

Größenbereich: 255 Zeichen regex String

Größenbereich: 255 Zeichen "params":{"data":{"sortArticleList":[{}] } } Feld Typ Beschreibung type Enum

Art der Sortierung

Erlaubte Werte: sort, sortArticlePrice, sortIndividual name String

Angezeigter Name der Sortierung z.B. Preis aufsteigend

Größenbereich: 255 Zeichen nameInternal String

Wird intern genutzt, damit die Namen frei gewählt werden können

Größenbereich: 255 Zeichen field Enum

Ist bei dem type sort ein Pflichtfeld.

Erlaubte Werte: articleNumber, name, groups.groupName, groups.group1Name, notifications.category, unit, availability, packageType, depositPackageType, unitOfMeasurement, brand, manufacturer, distributor, country, region, relatedArticleGroups, manufacturingLocation, certificates, alcoholicStrength, caffeine, additives, allergenIngredients, category, variety, recommendationFilter, dateCreated direction Enum

Richtung der Sortierung. Ist bei dem type sort & sortArticlePrice ein Pflichtfeld

Erlaubte Werte: 1, -1 "params":{"data":{"sortArticle":{} } } Feld Typ Beschreibung default String

Standardsortierung innerhalb der Gruppen

Größenbereich: 255 Zeichen offers String

Standardsortierung innerhalb der Angebote

Größenbereich: 255 Zeichen novelties String

Standardsortierung innerhalb der Neuheiten

Größenbereich: 255 Zeichen "params":{"data":{"sortGroup":{} } } Feld Typ Beschreibung default String

Standardsortierung innerhalb der Gruppen

Größenbereich: 255 Zeichen "params":{"data":{"sortGroup1":{} } } Feld Typ Beschreibung default String

Standardsortierung innerhalb der Untergruppen

Größenbereich: 255 Zeichen "params":{"data":{"SEO":{default: {}} } } Feld Typ Beschreibung title String

Titel

Größenbereich: 80 Zeichen description String

Beschreibung

Größenbereich: 200 Zeichen keywords String

Keywords

Größenbereich: 200 Zeichen "params":{"data":{"SEO":{groups: {}} } } Feld Typ Beschreibung title String

Titel

Größenbereich: 80 Zeichen description String

Beschreibung

Größenbereich: 200 Zeichen keywords String

Keywords

Größenbereich: 200 Zeichen "params":{"data":{"SEO":{articles: {}} } } Feld Typ Beschreibung title String

Titel

Größenbereich: 80 Zeichen description String

Beschreibung

Größenbereich: 200 Zeichen keywords String

Keywords

Größenbereich: 200 Zeichen "params":{"data":{"paymentMethods":[{dynamic: {}] } } Feld Typ Beschreibung name String

Name

Größenbereich: 255 Zeichen nameInternal String

Name Intern

Größenbereich: 255 Zeichen description String

Beschreibung

Größenbereich: 255 Zeichen image Array

Die Daten werden über die Schnittstelle "uploads/image" erstellt requiredPriceGroups Array

Zahlungsmethode wird ausschließlich bei diesen Preisgruppen ausgelesen requiredPaymentMethods Array

Zahlungsmethode wird ausschließlich bei den hinterlegten Zahlungsmethoden ausgelesen "params":{"data":{"paymentMethods":[{paypal: {}] } } Feld Typ Beschreibung clientId String

clientId

Größenbereich: 255 Zeichen secret String

secret key

Größenbereich: 255 Zeichen sandbox Boolean name String

Name

Größenbereich: 255 Zeichen nameInternal String

Name Intern

Größenbereich: 255 Zeichen description String

Beschreibung

Größenbereich: 255 Zeichen image Array

Die Daten werden über die Schnittstelle "uploads/image" erstellt requiredPriceGroups Array

Zahlungsmethode wird ausschließlich bei diesen Preisgruppen ausgelesen requiredPaymentMethods Array

Zahlungsmethode wird ausschließlich bei den hinterlegten Zahlungsmethoden ausgelesen "params":{"data":{"paymentMethods":[{stripe: {}] } } Feld Typ Beschreibung publicKey String

public key

Größenbereich: 255 Zeichen secretKey String

Größenbereich: 255 Zeichen name String

Name

Größenbereich: 255 Zeichen nameInternal String

Name Intern

Größenbereich: 255 Zeichen description String

Beschreibung

Größenbereich: 255 Zeichen image Array

Die Daten werden über die Schnittstelle "uploads/image" erstellt requiredPriceGroups Array

Zahlungsmethode wird ausschließlich bei diesen Preisgruppen ausgelesen requiredPaymentMethods Array

Zahlungsmethode wird ausschließlich bei den hinterlegten Zahlungsmethoden ausgelesen "result":{"configs": {"data":{} } } Feld Typ Beschreibung id String configs | 2. configs_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: configs/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: type useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regulären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"configs": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "configs": {"sort": [{}, {}]} expectedData Object

Siehe "configs": {"expectedData": {} "params":{"configs": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Erlaubte Werte: id, type, date direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"configs": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 articleAvailabilities Number

Erlaubte Werte: 1 articleDetailTextTop Number

Erlaubte Werte: 1 articleDetailTextBottom Number

Erlaubte Werte: 1 articleDetailStructures Number

Erlaubte Werte: 1 articleGroupByRelatedArticleGroup Number

Erlaubte Werte: 1 articleListAvailableFilters Number

Erlaubte Werte: 1 articleSearchInFields Number

Erlaubte Werte: 1 currency Number

Erlaubte Werte: 1 customerLoginTextTop Number

Erlaubte Werte: 1 customerShopFields Number

Erlaubte Werte: 1 customerRegisterTextTop Number

Erlaubte Werte: 1 customerRegisterTextBottom Number

Erlaubte Werte: 1 type Number

Erlaubte Werte: 1 countries Number

Erlaubte Werte: 1 dealer Number

Erlaubte Werte: 1 defaultPriceGroup Number

Erlaubte Werte: 1 defaultVisibilityGroups Number

Erlaubte Werte: 1 defaultCountry Number

Erlaubte Werte: 1 disableOrderForArticles Number

Erlaubte Werte: 1 depositTaxRate Number

Erlaubte Werte: 1 depositTaxRateExceptions Number

Erlaubte Werte: 1 dynamicCSS Number

Erlaubte Werte: 1 dynamicJS Number

Erlaubte Werte: 1 emailServer Number

Erlaubte Werte: 1 favicons Number

Erlaubte Werte: 1 layoutHtmlHead Number

Erlaubte Werte: 1 layoutHtmlFood Number

Erlaubte Werte: 1 layoutPrimaryColor Number

Erlaubte Werte: 1 layoutPrimaryColorInvert Number

Erlaubte Werte: 1 layoutSecondaryColor Number

Erlaubte Werte: 1 layoutSecondaryColorInvert Number

Erlaubte Werte: 1 manifest Number

Erlaubte Werte: 1 orderEmailSettings Number

Erlaubte Werte: 1 showArticleRating Number

Erlaubte Werte: 1 shopUrl Number

Erlaubte Werte: 1 sortArticle Number

Erlaubte Werte: 1 sortArticleList Number

Erlaubte Werte: 1 sortGroup Number

Erlaubte Werte: 1 sortGroup1 Number

Erlaubte Werte: 1 SEO Number

Erlaubte Werte: 1 taxRate Number

Erlaubte Werte: 1 paymentMethods Number

Erlaubte Werte: 1 productDBToken Number

Erlaubte Werte: 1 productDBCopyFields Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"configs": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"configs": {"count": {} }} "result":{"configs": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern configs | 3. configs_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: configs/update params Object "params":{"unset":[]} Feld Typ Beschreibung unset Array

Entfernt die Spalten aus der Datenbank

Erlaubte Werte: favicons "params":{"data":{}} Feld Typ Beschreibung id String

Hinweis Paramter sind identisch zu dem command configs/set . Bei einem Update sind alle Felder, abgesehen von der id, optional. Es werden ausschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 24 Zeichen "result":{"configs":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte configs | 4. configs_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: configs/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String "result":{"configs":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge contacts contacts | 1. contacts_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: contacts/set params Object "params":{"data":{}} Feld Typ Beschreibung type Enum

Art der Anfrage

Erlaubte Werte: contact, feedback email Email

E-Mail subject String

Betreff

Größenbereich: 255 Zeichen message String

Nachricht

Größenbereich: 5000 Zeichen company String

Firma

Größenbereich: 255 Zeichen name String

Name

Größenbereich: 255 Zeichen firstName String

Vorname

Größenbereich: 255 Zeichen phone String

Telefon

Größenbereich: 255 Zeichen street String

Straße

Größenbereich: 255 Zeichen postcode String

Postleitzahl

Größenbereich: 255 Zeichen town String

Stadt

Größenbereich: 255 Zeichen "result":{"contacts": {"data":{} } } Feld Typ Beschreibung id String contacts | 2. contacts_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: contacts/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, type, company, email, name, firstName, street, postcode, town useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"contacts": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "contacts": {"sort": [{}, {}]} expectedData Object

Siehe "contacts": {"expectedData": {} "params":{"contacts": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, type, company, email, name, firstName, street, postcode, town direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"contacts": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 type Number

Erlaubte Werte: 1 company Number

Erlaubte Werte: 1 email Number

Erlaubte Werte: 1 name Number

Erlaubte Werte: 1 firstName Number

Erlaubte Werte: 1 street Number

Erlaubte Werte: 1 postcode Number

Erlaubte Werte: 1 town Number

Erlaubte Werte: 1 subject Number

Erlaubte Werte: 1 message Number

Erlaubte Werte: 1 dateCrated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"contacts": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"contacts": {"count": {} }} "result":{"contacts": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern contacts | 3. contacts_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: contacts/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String

Größenbereich: 24 Zeichen "result":{"contacts":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge customers customers | 1. customers_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customers/set params Object "params":{"data":{}} Feld Typ Beschreibung customerNumber String

Kundennummer

Größenbereich: 255 Zeichen color String

color

Größenbereich: 6 Zeichen email String

E-Mail

Größenbereich: 255 Zeichen priceGroup String

Preisgruppe. Falls nicht übergeben, wird die defaultGroup des Händlers hinterlegt.

Größenbereich: 50 Zeichen addresses Array

Siehe "params":{"data":{"addresses":[{}, {}] } } priceMode String

Preismodus

Erlaubte Werte: gross, net group String

Gruppe

Größenbereich: 255 Zeichen industryCategory String

Branche

Größenbereich: 255 Zeichen status Enum

Status

Erlaubte Werte: new, changed, unchanged discountMerchandiseValueInPercent Float

Warenwertrabatt in Prozent numberOfRepresentative String

Vertreternummer

Größenbereich: 255 Zeichen CEO String

Inhaber

Größenbereich: 255 Zeichen buyer String

Einkaufsberechtigter

Größenbereich: 255 Zeichen customerSince String

Kunde seit

Größenbereich: 255 Zeichen classification String

Klassifizierung

Größenbereich: 255 Zeichen dateOfBirth Date

Geburtsdatum defaultDeliveryPeriod String

Vorausgewählter Lieferzeitraum

Größenbereich: 255 Zeichen creditLimit Float

Kreditlimit creditLimitAvailable Float

Kreditlimit verfügbar creditRating Integer visibilityGroups Array

Array aus Strings mit maximal 255 Zeichen favoritesList Array

Favoritenliste Array aus Artikelnummern (Strings) articlesInDelivery Array

Pendente Artikel. Siehe "params":{"data":{"articlesInDelivery": [{}, {}] }} articlePrices Array

Kundensepzifische Preise. Siehe "params":{"data":{"articlePrices": [{}, {}] }} articlePriceChanges Array

Kundensepzifische Preiseänderungen. Siehe "params":{"data":{"articlePriceChanges": [{}, {}] }} articleStocks Array

Artikelbestände des Kunden. Siehe "params":{"data":{"articleStocks": [{}, {}] }} paymentDeadlines Array

Siehe "params":{"data":{"paymentDeadlines": [{}, {}] }} user Object

Siehe "params":{"data":{"user": {} }} . Legt direkt einen User an, welcher mit diesem Kunden verknüpft ist und sich im Shop anmelden kann. dynamicArticleIds Array

Array aus dynamicArticleIds (String mit 24 Zeichen). Sofern die Bedingungen zutreffen, werden die Artikel bei der jeweiligen Tour automatisch dem Warenkorb hinzugefügt. dynamicFields Array

Siehe "params":{"data":{"dynamicFields": [{}] }} . Array aus Objekten. contactPersons Array

Siehe "params":{"data":{"contactPersons": [{}] }} . Array aus Objekten. "params":{"data":{"addresses":[{}, {}] } } Feld Typ Beschreibung addressId String

uniqueId Es gibt die Möglichkeit, dass User ausschließlich für bestimmte Adressen bestellen dürfen. Hierfür wird diese Id verwendet. Sofern nicht übergeben, wird eine id erzeugt

Größenbereich: 50 Zeichen default Bool

Vorausgewählte Adresse, sofern der User keine andere Standardadresse definiert hat gesoftName1 String

gesoftName1 oder gesoftName2 erforderlich

Größenbereich: 255 Zeichen gesoftName2 String

gesoftName1 oder gesoftName2 erforderlich

Größenbereich: 255 Zeichen postcode String

Postleitzahl

Größenbereich: 50 Zeichen town String

Stadt

Größenbereich: 255 Zeichen street String

Straße und Hausnummer

Größenbereich: 255 Zeichen firstName String

Vorname

Größenbereich: 255 Zeichen name String

Name

Größenbereich: 255 Zeichen company String

Firma

Größenbereich: 255 Zeichen salutation String

Anrede

Größenbereich: 255 Zeichen title String

Titel

Größenbereich: 255 Zeichen additionalAddressInformation String

Zusätzliche Adressinformationen

Größenbereich: 255 Zeichen country String

Land

Größenbereich: 3 Zeichen phone String

Telefon

Größenbereich: 50 Zeichen mobile String

Mobiltelefon

Größenbereich: 50 Zeichen floor Integer

Etage elevator Bool

Fahrstuhl type Enum

Rechnungs- oder Lieferadresse.

Erlaubte Werte: billing, delivery deliveryDetails Array

Lieferdetails. Siehe "params":{"data": {"addresses":{"deliveryDetails": [{}, {}] }}) "params":{"data": {"addresses":[{"deliveryDetails": [{}, {}] }]} Feld Typ Beschreibung day Enum

Liefertag 0 = Sonntag, 1 = Montag, 2 = Dienstag, 3 = Mittwoch, 4 = Donnerstag, 5 = Freitag, 6 = Samstag

Erlaubte Werte: 0, 1, 2, 3, 4, 5, 6 "params":{"data":{"articlePrices": [{}, {}] }} Feld Typ Beschreibung articleNumber String

Artikelnummer netPrice Float

Netto-Preis netDeposit Float

Netto-Pfand netFee Float

Netto-Gebühr grossFee Float

Brutto-Gebühr fromArticleQuantity Int

Ab Menge des Artikels fromCartQuantity Int

Ab Menge innerhalb des Warenkorbs validFrom String

Gültig von

Größenbereich: Y-m-d H:i validTo String

Gültig bis

Größenbereich: Y-m-d H:i "params":{"data":{"articlePriceChanges": [{}, {}] }} Feld Typ Beschreibung articleNumber String

Artikelnummer netPrice Float

Netto-Preis Der Preis dient nur als Info für den Kunden und wird nicht in der Preisziehung berücksichtigt!!! fromArticleQuantity Int

Ab Menge des Artikels (nicht Menge im Warenkorb) validFrom String

Gültig ab

Größenbereich: Y-m-d "params":{"data":{"articlesInDelivery": [{}, {}] }} Feld Typ Beschreibung orderDate String

Bestelldatum

Größenbereich: Y-m-d H:i articleNumber String

Artikelnummer amount Integer

Menge "params":{"data":{"articleStocks": [{}, {}] }} Feld Typ Beschreibung articleNumber String

Artikelnummer minimumStock Integer

Mindestbestand availableStock Integer

Ist-Bestand targetStock Integer

Soll-Bestand "params":{"data":{"paymentDeadlines": [{}, {}] }} Feld Typ Beschreibung paymentDeadlineInDays Integer

Zahlungsziel in Tagen paymentFeeInPercent Float

Gebühr in Prozent "params":{"data":{"user": {} }} Feld Typ Beschreibung username String

Mit dem Benutzernamen kann der Kunde sich im Shop anmelden. Hier kann auch die E-Mail-Adresse hinterlegt werden. Der username muss einmalig sein und darf im Shop noch nicht vergeben sein.

Größenbereich: 255 Zeichen password String

Das Passwort wird als Hash in der DB gespeichert (bcrypt)

Größenbereich: 255 Zeichen "params":{"data":{"dynamicFields": [{}] }} Feld Typ Beschreibung label String

Name des Felds

Größenbereich: 255 Zeichen value String

Wert des Felds

Größenbereich: 255 Zeichen "params":{"data":{"contactPersons": [{}] }} Feld Typ Beschreibung salutation String

Anrede

Größenbereich: 255 Zeichen name String

Name

Größenbereich: 255 Zeichen firstName String

Vorname

Größenbereich: 255 Zeichen position String

Position

Größenbereich: 255 Zeichen phone String

Telefon

Größenbereich: 255 Zeichen email String

E-Mail

Größenbereich: 255 Zeichen additionalInformation String

Zusatzinformationen

Größenbereich: 5000 Zeichen "result":{"customers": {"data":{} } } Feld Typ Beschreibung id String "result":{"users": {"data":{} } } Feld Typ Beschreibung id String

Existiert nur, wenn das user array übergeben wurde customers | 2. customers_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customers/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, customerNumber, color, email, priceGroup, addresses.postcode, addresses.town, addresses.firstName, addresses.name, addresses.gesoftName1, addresses.gesoftName2, addresses.company useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterArrayObjects": [{}, {}]} Feld Typ Beschreibung key String

Key des Arrays

Erlaubte Werte: dynamicFields value String

Wert der gefiltert werden soll field String

Felder welches gefiltert werden sollen.

Erlaubte Werte: label, value useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regulären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 or Object

or ist identisch aufgebaut wie filterArrayObjects "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: lastUpdate, dateCreated fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) "params":{"customers": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "customers": {"sort": [{}, {}]} expectedData Object

Siehe "customers": {"expectedData": {} "params":{"customers": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, customerNumber, color, email, priceGroup, addresses.0.gesoftName1, addresses.0.gesoftName2, addresses.0.postcode, addresses.0.town, addresses.0.firstName, addresses.0.name, addresses.0.company, dateCreated direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"customers": {"expectedData": {}} } Feld Typ Beschreibung customerNumber Number

Erlaubte Werte: 1 color Number

Erlaubte Werte: 1 status Number

Erlaubte Werte: 1 email Number

Erlaubte Werte: 1 priceGroup Number

Erlaubte Werte: 1 addresses Number

Erlaubte Werte: 1 numberOfRepresentative Number

Erlaubte Werte: 1 CEO Number

Erlaubte Werte: 1 buyer Number

Erlaubte Werte: 1 customerSince Number

Erlaubte Werte: 1 classification Number

Erlaubte Werte: 1 dateOfBirth Number

Erlaubte Werte: 1 default Number

Erlaubte Werte: 1 defaultDeliveryPeriod Number

Erlaubte Werte: 1 creditLimit Number

Erlaubte Werte: 1 creditLimitAvailable Number

Erlaubte Werte: 1 creditRating Number

Erlaubte Werte: 1 articlePrices Number

Erlaubte Werte: 1 articleStocks Number

Erlaubte Werte: 1 favoritesList Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"customers": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"customers": {"count": {} }} "result":{"customers": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern customers | 2. customers_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customers/update params Object "params":{"data":{}} Feld Typ Beschreibung id String

id oder customerNumber erforderlich

Größenbereich: 24 Zeichen customerNumber String

Kundennummer

Hinweis Den Paramter "user" gibt es bei einem Update nicht. Für Änderungen existieren separate Schnittstellen. Die restlichen Paramter sind identisch zu dem command customers/set . Abweichend zu customers/set sind alle Felder optional (mit Ausnahme der customerNumber). Es werden uasschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 255 Zeichen "result":{"customers":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte customers | 4. customers_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customers/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String

id oder Kundennummer erforderlich customerNumber String

Kundennummer "result":{"customers":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge customers | 5. customerDocuments_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customerDocuments/set params Object "params":{"data":{}} Feld Typ Beschreibung uniqueNumber String

Eindeutige Nummer

Größenbereich: 255 Zeichen customerNumber String

Zugehörige Kundennummer

Größenbereich: 255 Zeichen type Enum

Typ des Dokumentes

Erlaubte Werte: invoice name String

Name des Dokumentes

Größenbereich: 255 Zeichen date Date

Datum des Dokumentes Y-m-d amount Float

Betrag openAmount Float

Offener Betrag filePath String

Pfad zur Datei. Generierung erfolgt über upload/file. Die Visibility muss auf private stehen. "result":{"customerDocuments": {"data":{} } } Feld Typ Beschreibung id String customers | 6. customerDocuments_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customerDocument/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, customerNumber, type, uniqueNumber, date useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"customerDocuments": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "customers": {"sort": [{}, {}]} expectedData Object

Siehe "customers": {"expectedData": {} "params":{"customerDocuments": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, customerNumber, type, uniqueNumber, name, date, amount, openAmount direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"customerDocuments": {"expectedData": {}} } Feld Typ Beschreibung uniqueNumber Number

Erlaubte Werte: 1 customerNumber Number

Erlaubte Werte: 1 type Number

Erlaubte Werte: 1 name Number

Erlaubte Werte: 1 date Number

Erlaubte Werte: 1 amount Number

Erlaubte Werte: 1 openAmount Number

Erlaubte Werte: 1 filePath Number

Erlaubte Werte: 1 fileBase64 Number

Dieser Wert ist ausschließlich enthalten, wenn er in den expectedData gesetzt ist. Sofern die Datei nicht vorhanden ist, ist der Wert null

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"customerDocuments": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"customerDocument": {"count": {} }} "result":{"customerDocuments": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern customers | 6. customerNotes_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customerNotes/set params Object "params":{"data":{}} Feld Typ Beschreibung userId String

Id des Users der den Eintrag vorgenommen hat.

Größenbereich: 24 Zeichen customerNumber String

Kundennummer

Größenbereich: 255 Zeichen title String

Titel

Größenbereich: 255 Zeichen note String

Notiz für den Kunden

Größenbereich: 10000 Zeichen "result":{"customerNotes": {"data":{} } } Feld Typ Beschreibung id String customers | 7. customerDocuments_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customerDocuments/update params Object "params":{"data":{}} Feld Typ Beschreibung uniqueNumber String

Eindeutige Nummer

Hinweis Die Parameter in dem Objekt data sind identisch zu dem command customerDocument/set . Abweichend zu customerDocument/set sind alle Felder optional (mit Ausnahme der uniqueNumber). Es werden uasschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 255 Zeichen "result":{"customerDocuments":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte customers | 8. customerDocuments_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customerDocuments/delete params Object "params":{"data":{}} Feld Typ Beschreibung uniqueNumber String

Eindeutige Nummer des Dokuments "result":{"customerDocuments":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge customers | 9. customerNotes_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customerNotes/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String "result":{"customerNotes":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge customers | 9. customerNotes_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customerNotes/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. fields Array

Felder welches gefiltert werden sollen. Falls nicht übergeben, werden alle Felder für den Filter verwendet

Erlaubte Werte: id, userId, customerNumber, title useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regulären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 or Object

Das Objekt or kann die identischen Werte von filters enthalten. "params":{"customerNotes": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "customerNotes": {"sort": [{}, {}]} expectedData Object

Siehe "customers": {"expectedData": {} "params":{"customerNotes": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, userId, customerNumber, title, dateCreated direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"customerNotes": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 userId Number

Erlaubte Werte: 1 customerNumber Number

Erlaubte Werte: 1 title Number

Erlaubte Werte: 1 note Number

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"customerNotes": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"customerNotes": {"count": {} }} "result":{"customerNotes": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern customers | 9. customerNotes_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: customerNotes/update params Object "params":{"data":{}} Feld Typ Beschreibung uniqueNumber String

Eindeutige Nummer

Hinweis Die Parameter in dem Objekt data sind identisch zu dem command customerDocument/set . Abweichend zu customerDocument/set sind alle Felder optional (mit Ausnahme der uniqueNumber). Es werden uasschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 255 Zeichen "result":{"customerNotes":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte deliveryAreas deliveryAreas | 1. deliveryAreas_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryAreas/set params Object "params":{"data":{}} Feld Typ Beschreibung postcode String

Postleitzahl

Größenbereich: 10 Zeichen town String

Stadt

Größenbereich: 255 Zeichen deliveryTourId String

Zugeordnete Tour

Größenbereich: 24 Zeichen "result":{"deliveryAreas": {"data":{} } } Feld Typ Beschreibung id String deliveryAreas | 2. deliveryAreas_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryAreas/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, postcode, town, dateCreated, lastUpdate useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"deliveryAreas": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "deliveryAreas": {"sort": [{}, {}]} expectedData Object

Siehe "deliveryAreas": {"expectedData": {} "params":{"deliveryAreas": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, postcode, town, dateCreated, lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"deliveryAreas": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 postcode Number

Erlaubte Werte: 1 town Number

Erlaubte Werte: 1 tourId Number

Erlaubte Werte: 1 dateCrated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"deliveryAreas": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"deliveryAreas": {"count": {} }} "result":{"deliveryAreas": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern deliveryAreas | 3. deliveryAreas_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryAreas/update params Object "params":{"unset":[]} Feld Typ Beschreibung unset Array

Entfernt die Spalten aus der Datenbank

Erlaubte Werte: deliveryTourId "params":{"data":{}} Feld Typ Beschreibung id String

Hinweis Die Parameter sind identisch zu dem command deliveryAreas/set . Abweichend zu deliveryAreas/set sind alle Felder optional (mit Ausnahme der id). Es werden ausschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 24 Zeichen "result":{"deliveryAreas":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte deliveryAreas | 4. deliveryAreas_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryAreas/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String

Größenbereich: 24 Zeichen "result":{"deliveryAreas":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge deliveryBlockedDays deliveryBlockedDays | 1. deliveryBlockedDays_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryBlockedDays/set params Object "params":{"data":{}} Feld Typ Beschreibung name String

Name

Größenbereich: 255 Zeichen from Date

Von to Date

Bis txt String

Begründung der Sperrung

Größenbereich: 5000 Zeichen deliveryPeriods Array

Array aus Strings. Sperrt ausschließlich die hinterlegten Periods deliveryTourIds Array

Array aus Strings. Sperrt ausschließlich die hinterlegten Touren customerPriceGroups Array

Array aus Strings. Sperrt ausschließlich die hinterlegten Preisgruppen der Kunden "result":{"deliveryBlockedDays": {"data":{} } } Feld Typ Beschreibung id String deliveryBlockedDays | 2. deliveryBlockedDays_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryBlockedDays/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, deliveryPeriods, deliveryTourIds, customerPriceGroups useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: dateCreated, lastUpdate, from, to greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"deliveryBlockedDays": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "deliveryBlockedDays": {"sort": [{}, {}]} expectedData Object

Siehe "deliveryBlockedDays": {"expectedData": {} "params":{"deliveryBlockedDays": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: name, id, from, to, dateCreated, lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"deliveryBlockedDays": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 txt Number

Erlaubte Werte: 1 name Number

Erlaubte Werte: 1 from Number

Erlaubte Werte: 1 to Number

Erlaubte Werte: 1 deliveryPeriods Number

Erlaubte Werte: 1 deliveryTourIds Number

Erlaubte Werte: 1 customerPriceGroups Number

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"deliveryBlockedDays": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"deliveryBlockedDays": {"count": {} }} "result":{"deliveryBlockedDays": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern deliveryBlockedDays | 3. deliveryBlockedDays_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryBlockedDays/update params Object "params":{"data":{}} Feld Typ Beschreibung id String

Hinweis Den Paramter "deliveryBlockedDays" gibt es bei einem Update nicht. Für Änderungen existieren separate Schnittstellen. Die restlichen Paramter sind identisch zu dem command deliveryBlockedDays/set . Abweichend zu deliveryBlockedDays/set sind alle Felder optional (mit Ausnahme der id). Es werden ausschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 24 Zeichen "result":{"deliveryBlockedDays":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte deliveryBlockedDays | 4. deliveryBlockedDays_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryBlockedDays/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String

Größenbereich: 24 Zeichen "result":{"deliveryBlockedDays":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge deliveryTours deliveryTours | 1. deliveryTours_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryTours/set params Object "params":{"data":{}} Feld Typ Beschreibung name String

Name der Tour

Größenbereich: 255 Zeichen default Bool

Standardtour, wenn keine beim Kunden oder der Postleitzahl hinterlegt ist. position Int

Sofern sich mehrere Touren überschneiden, wird immer die mit der kleinsten Position gewählt days Array

Siehe "params":{"data":{"days": [{}] }} pickupTour Bool

Der Wert true ermöglicht eine freie Eingabe der Postleitzahlen bei der Kundenregistrierung nameDeliveryDate String

Name (Singular) für das Lieferdatum (z.B. Abholdatum)

Größenbereich: 255 Zeichen nameDeliveryDates String

Name (Plural) für die Liefertermine (z.B. Abholtermine)

Größenbereich: 255 Zeichen requiredPriceGroups Array

Array aus Strings der Preisgruppen. Die Tour greift nur, wenn die Preisgruppe hinterlegt ist. requiredDynamicArticleIds Array

Array aus requiredDynamicArticleIds (String mit 24 Zeichen). Die Tour greift nur, wenn der dynamische Artikel im Warenkorb liegt excludedDynamicArticleIds Array

Array aus excludedDynamicArticleIds (String mit 24 Zeichen). Die Tour greift nur, wenn der dynamische Artikel NICHT im Warenkorb liegt disableOrderIfConditionsFailed Boolean

Bestellung deaktvieren, wenn die Bedingungen minimumMerchandiseValue und minimumArticles nicht erfüllt sind minimumMerchandiseValue Object

Siehe "params":{"data":{"minimumMerchandiseValue": {}] }} minimumArticles Object

Siehe "params":{"data":{"minimumArticles": {}] }} dynamicArticleIds Array

Array aus dynamicArticleIds (String mit 24 Zeichen). Sofern die Bedingungen zutreffen, werden die Artikel bei der jeweiligen Tour automatisch dem Warenkorb hinzugefügt. "params":{"data":{"days": {} }} Feld Typ Beschreibung monday Object

Siehe "params":{"data":{"days": {"dayExample": {}} }} tuesday Object

Siehe "params":{"data":{"days": {"dayExample": {}} }} wednesday Object

Siehe "params":{"data":{"days": {"dayExample": {}} }} thursday Object

Siehe "params":{"data":{"days": {"dayExample": {}} }} friday Object

Siehe "params":{"data":{"days": {"dayExample": {}} }} saturday Object

Siehe "params":{"data":{"days": {"dayExample": {}} }} sunday Object

Siehe "params":{"data":{"days": {"dayExample": {}} }} "params":{"data":{"days": {"dayExample": {}} }} Feld Typ Beschreibung available Boolean

Verfügbar latestOrderTimeInDays Integer

Spätester Bestellzeitpunkt in Tagen.Immer abhängig von dem ausgewählten Lieferdatum 23:59Uhr. latestOrderTimeInHours Integer

Späteste Bestellzeit in Stunden. Immer abhängig von dem ausgewählten Lieferdatum 23:59Uhr. latestOrderTimeInMinutes Integer

Späteste Bestellzeit in Minuten. Immer abhängig von dem ausgewählten Lieferdatum 23:59Uhr. note String

Bemerkung zum Liefertag noteVisibilityBeforeDeliveryDateInDays Int|null

Ab dem Lieferdatum 23:59 - Zeit in Tagen wird die Bemerkung eingeblendet. noteVisibilityBeforeDeliveryDateInHours Int|null

Ab dem Lieferdatum 23:59 - Zeit in Stunden wird die Bemerkung eingeblendet. noteVisibilityBeforeDeliveryDateInMinutes Int|null

Ab dem Lieferdatum 23:59 - Zeit in Minuten wird die Bemerkung eingeblendet. deliveryPeriods Array

Siehe "params":{"data":{"days": {"monday": {"deliveryPeriods": []}} }} deliveryPeriodCustomer Object

"params":{"data":{"days": {"monday": {"deliveryPeriodCustomer": []}} }} dateForSecondWeekInterval Date

Startdatum für einen 2 wöchigen Lieferintervall "params":{"data":{"days": {"dayExample": {"deliveryPeriods": []}} }} Feld Typ Beschreibung deliveryPeriod Date

Lieferzeitraum latestOrderTimeInDays Int|null

Späteste Bestellzeit in Tagen. Immer abhängig von dem ausgewählten Lieferdatum 23:59Uhr. latestOrderTimeInHours Int|null

Späteste Bestellzeit in Stunden. Immer abhängig von dem ausgewählten Lieferdatum 23:59Uhr. latestOrderTimeInMinutes Int|null

Späteste Bestellzeit Minuten. Immer abhängig von dem ausgewählten Lieferdatum 23:59Uhr. note String

Bemerkung zum Lieferzeitraum "params":{"data":{"days": {"dayExample": {"deliveryPeriodCustomer": {}}} }} Feld Typ Beschreibung available Bool

Bemerkung zum Lieferzeitraum latestOrderTimeInDays Int|null

Späteste Bestellzeit in Tagen. Immer abhängig von dem ausgewählten Lieferdatum 23:59Uhr. latestOrderTimeInHours Int|null

Späteste Bestellzeit in Stunden. Immer abhängig von dem ausgewählten Lieferdatum 23:59Uhr. latestOrderTimeInMinutes Int|null

Späteste Bestellzeit Minuten. Immer abhängig von dem ausgewählten Lieferdatum 23:59Uhr. note String

Bemerkung zum Lieferzeitraum "params":{"data":{"minimumMerchandiseValue": {}] }} Feld Typ Beschreibung net Integer

Mindestbestellwert Netto gross Integer

Mindestbestellwert Brutto note String

Text der eingeblendet werden soll "params":{"data":{"minimumArticles": {}] }} Feld Typ Beschreibung value Integer

Mindestabnahme an Artikeln note String

Text der eingeblendet werden soll, wenn die Bedingung nicht erfüllt ist. excludedGroups Array

Array aus Strings mit Gruppen die nicht berücksichtigt werden sollen requiredArticlePackages Array

Array aus Strings mit Gruppen die nicht berücksichtigt werden sollen "result":{"deliveryTours": {"data":{} } } Feld Typ Beschreibung id String deliveryTours | 2. deliveryTours_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryTours/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, name, default, requiredPriceGroups useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regulären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"deliveryTours": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "deliveryTours": {"sort": [{}, {}]} expectedData Object

Siehe "deliveryTours": {"expectedData": {} "params":{"deliveryTours": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, position, name, minimumArticles.value, minimumMerchandiseValue, dateCreated., lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"deliveryTours": {"expectedData": {}} } Feld Typ Beschreibung default Number

Erlaubte Werte: 1 position Number

Erlaubte Werte: 1 name Number

Erlaubte Werte: 1 requiredPriceGroups Number

Erlaubte Werte: 1 days Number

Erlaubte Werte: 1 minimumMerchandiseValue Number

Erlaubte Werte: 1 minimumArticles Number

Erlaubte Werte: 1 dynamicArticleIds Number

Erlaubte Werte: 1 dateCrated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"deliveryTours": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"deliveryTours": {"count": {} }} "result":{"deliveryTours": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern deliveryTours | 3. deliveryTours_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryTours/update params Object "params":{"data":{}} Feld Typ Beschreibung id String

Hinweis Die Parameter sind identisch zu dem command deliveryTours/set . Abweichend zu deliveryTours/set sind alle Felder optional (mit Ausnahme der id). Es werden ausschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 24 Zeichen "result":{"deliveryTours":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte deliveryTours | 4. deliveryTours_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: deliveryTours/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String

Größenbereich: 24 Zeichen "result":{"deliveryTours":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge dynamicArticles dynamicArticles | 1. dynamicArticles_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: dynamicArticles/set params Object "params":{"data":{}} Feld Typ Beschreibung name String

Name des Artikels

Größenbereich: 255 Zeichen position Integer

Artikelposition innerhalb der shoppingCart addAutomatically Boolean

Fügt den Artikel automatisch dem Warenkorb hinzu. deletable bool

Vom Kunden löschbar articleAmount Integer

Artikelmenge die in den Warenkorb gelegt werden soll. setArticleAmountFromCart Boolean

Die Artikelmenge soll aus der Anzahl der Artikel innerhalb des Warenkorbs entnommen werden *. articleNumber String

Artikelnummer die an das WaWi übermittelt wird. Der Artikel muss nicht im Shop enthalten sein.

Größenbereich: 255 Zeichen netPrice Number

Netto-Preis

Größenbereich: Float netPricePerArticle Number

Netto-Preis pro Artikel *.

Größenbereich: Float pricePerArticleFromAmount Number

Preis pro Artikel ab Menge

Größenbereich: Int netDeposit Number

Netto-Pfand

Größenbereich: Float grossDeposit Number

Brutto-Pfand

Größenbereich: Float netFee Number

Netto-Gebühr

Größenbereich: Float grossFee Number

Brutto-Gebühr

Größenbereich: Float taxRate Number

Mehrwertsteuer

Größenbereich: Float percentageFromNetMerchandiseValue Number

Prozentualer Wert vom Netto-Warenwert

Größenbereich: Float percentageFromNetTotalSum Number

Prozentualer Wert von der Netto-Summe

Größenbereich: Float category String

Artikelnummer die an das WaWi übermittelt wird. Der Artikel muss nicht im Shop enthalten sein.

Erlaubte Werte: selection, selectionWithOptionalMappingToCustomer, delivery, deliverySelectable, additionalArticle, others description String

Beschreibung des Artikels

Größenbereich: 255 Zeichen fromCartAmount Integer

Ab Artikelmenge innerhalb des Warenkorb *. toCartAmount Integer

Bis Artikelmenge innerhalb des Warenkorb *. fromDate Date

Ab Datum. toDate Date

Bis Datum. fromWeightDate Float

Ab Gewicht. toWeight Float

Bis Gewicht. fromNetMerchandiseValue Number

Ab Netto-Warenwert

Größenbereich: Float toNetMerchandiseValue Number

Bis Netto-Warenwert

Größenbereich: Float fromGrossMerchandiseValue Number

Ab Brutto-Warenwert

Größenbereich: Float toGrossMerchandiseValue Number

Bis Brutto-Warenwert

Größenbereich: Float requiredArticleNumbers Array

Array aus Strings mit den Artikelnummern requiredCustomerNumbers Array

Array aus Strings mit den Kundennummern requiredPriceGroups Array

Array aus Strings mit den Preisgruppen requiredCountries Array

Array aus Strings mit den Ländern excludedGroups Array

Array aus Strings mit den ausgeschlossenen Gruppen excludedCountries Array

Array aus Strings mit den ausgeschlossenen Ländern removeDynamicArticleIds Array

Array mit Ids von dynamischen Artikeln Ids. Die Ids werden automatisch aus dem Warenkorb entfernt, sobald der Artikel hinzugefügt wird. removeDynamicArticleCategories Array

Array mit Kategorien, welche automatisch entfernt werden (ausgeschlossen der Artikel der diese Bedingung enthält). "params":{"data":{"images": [{}] }} Feld Typ Beschreibung filePath String

Die Daten werden über die Schnittstelle "uploads/image" erstellt thumbnails Array "params":{"data":{"images": [{"thumbnails":[{}]}] }} Feld Typ Beschreibung small String

Kleinste Auflösung medium String

Mittlere Auflösung big String

Große Auflösung "params":{"data":{}}){} * Es werden ausschließlich die Artikel mit den hinterlegten Bedingunen berücksichtigt (excludedGroups & requiredArticleNumbers Feld Typ Beschreibung . "result":{"configShoppingCartDynamicArticles": {"data":{} } } Feld Typ Beschreibung id String dynamicArticles | 2. dynamicArticles_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: dynamicArticles/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, name, articleNumber, category useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: fromDate, toDate, lastUpdate, dateCreated greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"dynamicArticles": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 onlyPossibilitiesFromShoppingCartId Array

Ausschließlich Einträge die, die Konditionen aus der übergebenen shoppingCartId erfüllen sort Array

Siehe "dynamicArticles": {"sort": [{}, {}]} expectedData Object

Siehe "dynamicArticles": {"expectedData": {} "params":{"dynamicArticles": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, name, articleNumber, position, fromDate, toDate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"dynamicArticles": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 position Number

Erlaubte Werte: 1 addAutomatically Number

Erlaubte Werte: 1 name Number

Erlaubte Werte: 1 description Number

Erlaubte Werte: 1 articleAmount Number

Erlaubte Werte: 1 setArticleAmountFromCart Number

Erlaubte Werte: 1 articleNumber Number

Erlaubte Werte: 1 netPrice Number

Erlaubte Werte: 1 netPricePerArticle Number

Erlaubte Werte: 1 netDeposit Number

Erlaubte Werte: 1 netFee Number

Erlaubte Werte: 1 taxRate Number

Erlaubte Werte: 1 percentageFromNetMerchandiseValue Number

Erlaubte Werte: 1 percentageFromNetTotalSum Number

Erlaubte Werte: 1 fromCartAmount Number

Erlaubte Werte: 1 toCartAmount Number

Erlaubte Werte: 1 fromDate Number

Erlaubte Werte: 1 toDate Number

Erlaubte Werte: 1 fromNetMerchandiseValue Number

Erlaubte Werte: 1 toNetMerchandiseValue Number

Erlaubte Werte: 1 fromGrossMerchandiseValue Number

Erlaubte Werte: 1 toGrossMerchandiseValue Number

Erlaubte Werte: 1 requiredArticleNumbers Number

Erlaubte Werte: 1 requiredPriceGroups Number

Erlaubte Werte: 1 requiredCountries Number

Erlaubte Werte: 1 excludedCountries Number

Erlaubte Werte: 1 excludedGroups Number

Erlaubte Werte: 1 removeDynamicArticleIds Number

Erlaubte Werte: 1 removeDynamicArticleCategories Number

Erlaubte Werte: 1 deletable Number

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"dynamicArticles": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"dynamicArticles": {"count": {} }} "result":{"dynamicArticles": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern dynamicArticles | 3. dynamicArticles_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: dynamicArticles/update params Object "params":{"data":{}} Feld Typ Beschreibung id String

Id des Eintrags

Hinweis Die Parameter in dem Objekt data sind identisch zu dem command dynamicArticles/set . Abweichend zu dynamicArticles/set sind alle Felder optional (mit Ausnahme des Feldes code). Es werden uasschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 255 Zeichen "params":{"unset":[]} Feld Typ Beschreibung unset Array

Entfernt die Spalten aus der Datenbank

Erlaubte Werte: fromDate, toDate "result":{"dynamicArticles":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte dynamicArticles | 4. dynamicArticles_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: dynamicArticles/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String

Id des Artikels "result":{"dynamicArticles":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge dynamicPages dynamicPages | 1. dynamicPages_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: dynamicPages/set params Object "params":{"data":{}} Feld Typ Beschreibung status Enum

Status

Erlaubte Werte: online, offline linkPositions Array

Erlaubt sind (top | foot_0 | foot_1 | foot_2 | b2b_foot)[] uniqueName String

Eindeutiger Namer der für die URL benutzt wird

Größenbereich: 255 Zeichen pos Number

Position des Eintrags name String

Name der Seite

Größenbereich: 255 Zeichen externalLinkUrl String

Link zu einer externen Seite

Größenbereich: 1000 Zeichen routerLink String

Link zu einer internen Seite

Größenbereich: 1000 Zeichen content String

Inhalt der Seite

Größenbereich: 20000 Zeichen SEO Object "params":{"data":{SEO:{}}} Feld Typ Beschreibung title String

Größenbereich: 80 Zeichen description String

Größenbereich: 200 Zeichen keywords String

Größenbereich: 80 Zeichen "result":{"dynamicPages": {"data":{} } } Feld Typ Beschreibung id String dynamicPages | 2. dynamicPages_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: dynamicPages/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, status, type, uniqueName, name useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regulären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: lastUpdate, dateCreated fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) "params":{"dynamicPages": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "dynamicPages": {"sort": [{}, {}]} expectedData Object

Siehe "dynamicPages": {"expectedData": {} "params":{"dynamicPages": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, status, type, uniqueName, pos, name, dateCreated, lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"dynamicPages": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 status Number

Erlaubte Werte: 1 SEO Number

Erlaubte Werte: 1 type Number

Erlaubte Werte: 1 uniqueName Number

Erlaubte Werte: 1 pos Number

Erlaubte Werte: 1 name Number

Erlaubte Werte: 1 dateCrated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"dynamicPages": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"dynamicPages": {"count": {} }} "result":{"dynamicPages": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern dynamicPages | 3. dynamicPages_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: dynamicPages/update params Object "params":{"data":{}} Feld Typ Beschreibung id String

Hinweis Die Parameter sind identisch zu dem command dynamicPages/set . Abweichend zu dynamicPages/set sind alle Felder optional (mit Ausnahme der id). Es werden ausschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 24 Zeichen "result":{"dynamicPages":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte dynamicPages | 4. dynamicPages_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: dynamicPages/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String

Größenbereich: 24 Zeichen "result":{"dynamicPages":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge errors errors | 1. errors_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: errors/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Erlaubte Werte: id, type, username, message, payload.command, payload.data.articleNumber, payload.data.customerNumber useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: date greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"errors": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "errors": {"sort": [{}, {}]} expectedData Object

Siehe "errors": {"expectedData": {} "params":{"errors": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Erlaubte Werte: id, type, username, message, payload.command, payload.data.articleNumber, payload.data.customerNumber, date direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"errors": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 type Number

Erlaubte Werte: 1 username Number

Erlaubte Werte: 1 input Number

Erlaubte Werte: 1 payload Number

Erlaubte Werte: 1 date Number

Erlaubte Werte: 1 "result":{"errors": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"errors": {"count": {} }} "result":{"errors": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern histories histories | 1. histories_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: histories/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Erlaubte Werte: action, collection, data useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: date greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"histories": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "histories": {"sort": [{}, {}]} expectedData Object

Siehe "histories": {"expectedData": {} "params":{"histories": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Erlaubte Werte: id, action, collection, username, date direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"histories": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 action Number

Erlaubte Werte: 1 collection Number

Erlaubte Werte: 1 username Number

Erlaubte Werte: 1 itemId Number

Erlaubte Werte: 1 data Number

Erlaubte Werte: 1 date Number

Erlaubte Werte: 1 "result":{"histories": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"histories": {"count": {} }} "result":{"histories": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern news news | 1. news_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: news/set params Object "params":{"data":{}} Feld Typ Beschreibung title String

Titel

Größenbereich: 255 Zeichen displayOptions Array

popupWithoutReadOption] Anzeigeoptionen für die News

Standardwert: popup onlineFrom Date

Onlineschaltung von onlineTo Date

Onlineschaltung bis text String

Text

Größenbereich: 5000 Zeichen priceGroups Array

Die News ist ausschließlich sichtbar für die hinterlegten Preisgruppen files Array

Downloads images Array

Bilder "params":{"data":{"files": [{}] }} Feld Typ Beschreibung filePath String

Die Daten werden über die Schnittstelle "uploads/file" erstellt "params":{"data":{"images": [{}] }} Feld Typ Beschreibung filePath String

Die Daten werden über die Schnittstelle "uploads/image" erstellt thumbnails Array "params":{"data":{"images": [{"thumbnails":[{}]}] }} Feld Typ Beschreibung small String

Kleinste Auflösung medium String

Mittlere Auflösung big String

Große Auflösung "result":{"news": {"data":{} } } Feld Typ Beschreibung id String news | 2. news_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: news/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, title useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: dateCreated, lastUpdate, onlineFrom, onlineTo greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"news": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "news": {"sort": [{}, {}]} expectedData Object

Siehe "news": {"expectedData": {} "params":{"news": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, title, onlineFrom, onlineTo, dateCreated., lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"news": {"expectedData": {}} } Feld Typ Beschreibung title Number

Erlaubte Werte: 1 displayOptions Number

Erlaubte Werte: 1 url Number

Erlaubte Werte: 1 onlineFrom Number

Erlaubte Werte: 1 onlineTo Number

Erlaubte Werte: 1 text Number

Erlaubte Werte: 1 priceGroups Number

Erlaubte Werte: 1 images Number

Erlaubte Werte: 1 dateCrated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"news": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"news": {"count": {} }} "result":{"news": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern news | 3. news_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: news/update params Object "params":{"data":{}} Feld Typ Beschreibung id String

Hinweis Den Paramter "news" gibt es bei einem Update nicht. Für Änderungen existieren separate Schnittstellen. Die restlichen Paramter sind identisch zu dem command news/set . Abweichend zu news/set sind alle Felder optional (mit Ausnahme der id). Es werden ausschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 24 Zeichen "result":{"news":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte news | 4. news_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: news/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String

Größenbereich: 24 Zeichen "result":{"news":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge orders orders | 1. orders_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: orders/set params Object "params":{"data":{}} Feld Typ Beschreibung shoppingCartId String

Id der ShoppingCart

Größenbereich: 255 Zeichen token String

Token der ShoppingCart

Größenbereich: 255 Zeichen email String

E-Mail

Größenbereich: 255 Zeichen type Enum

Typ der Bestellung

Erlaubte Werte: order, orderRequest, pickup status Enum

Status

Erlaubte Werte: paymentPending, open, canceled, progressStarted, inProgress, inDelivery, invoiced, finished priceGroups Array

Preisgruppe priceMode Enum

Preismodus

Erlaubte Werte: net, gross address String

Siehe "params":{"data":{"address":{} } }

Größenbereich: 255 Zeichen userId String

Wenn dieser Wert nicht existiert, handelt es sich um eine Gastbestellung

Größenbereich: 255 Zeichen customerId String

Id des Kunden

Größenbereich: 255 Zeichen customerNumber String

Kundennummer

Größenbereich: 255 Zeichen customerStatus Enum

Status des customers

Erlaubte Werte: new, changed, unchanged deliveryAddress String

Siehe "params":{"data":{"deliveryAddress":{} } }

Größenbereich: 255 Zeichen deliveryDate Date

Lieferdatum retoureDate Date

Retourendatum deliveryPeriod String

Lieferzeitraum

Größenbereich: 255 Zeichen paymentMethod Object

Zahlungsart Siehe "params":{"data":{"paymentMethod":{} } } note String

Bemerkung

Größenbereich: 5000 Zeichen randomPinCode String

Zufallscode

Größenbereich: 50 Zeichen "params":{"data":{"address":{} } } Feld Typ Beschreibung gesoftName1 String

gesoftName1 oder gesoftName2 erforderlich

Größenbereich: 255 Zeichen gesoftName2 String

gesoftName2 oder gesoftName2 erforderlich

Größenbereich: 255 Zeichen street String

Straße und Hausnummer

Größenbereich: 255 Zeichen postcode String

Postleitzahl

Größenbereich: 50 Zeichen town String

Stadt

Größenbereich: 255 Zeichen country String

Land

Größenbereich: 255 Zeichen company String

Firma

Größenbereich: 255 Zeichen name String

Name

Größenbereich: 255 Zeichen firstName String

Vorname

Größenbereich: 255 Zeichen salutation String

Anrede

Größenbereich: 255 Zeichen title String

Titel

Größenbereich: 255 Zeichen additionalAddressInformation String

Zusätzliche Adressinformationen

Größenbereich: 255 Zeichen phone String

Telefon

Größenbereich: 50 Zeichen mobile String

Mobiltelefon

Größenbereich: 50 Zeichen floor Integer

Etage elevator Bool

Aufzug "params":{"data":{"deliveryAddress":{} } } Feld Typ Beschreibung gesoftName1 String

gesoftName1

Größenbereich: 255 Zeichen gesoftName2 String

gesoftName2

Größenbereich: 255 Zeichen street String

Straße und Hausnummer

Größenbereich: 255 Zeichen postcode String

Postleitzahl

Größenbereich: 50 Zeichen town String

Stadt

Größenbereich: 255 Zeichen country String

Land

Größenbereich: 255 Zeichen name String

Name

Größenbereich: 255 Zeichen company String

Firma

Größenbereich: 255 Zeichen salutation String

Anrede

Größenbereich: 255 Zeichen title String

Titel

Größenbereich: 255 Zeichen additionalAddressInformation String

Zusätzliche Adressinformationen

Größenbereich: 255 Zeichen phone String

Telefon

Größenbereich: 50 Zeichen mobile String

Mobiltelefon

Größenbereich: 50 Zeichen floor Integer

Etage elevator Bool

Aufzug "params":{"data":{"paymentMethod":{} } } Feld Typ Beschreibung name String

Name

Größenbereich: 255 Zeichen nameInternal String

Interner Name z.B. für die Verwendung im Gesoft

Größenbereich: 255 Zeichen description String

Beschreibung

Größenbereich: 1000 Zeichen externalPaymentId String

externe paymentId

Größenbereich: 1000 Zeichen reference String

Referenz des Zahlungsanbieters

Größenbereich: 1000 Zeichen "result":{"orders": {"data":{} } } Feld Typ Beschreibung id String token String orders | 2. orders_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: orders/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, token, userId, customerId, customerNumber, email, address.postcode, address.town, address.gesoftName1, address.gesoftName2, address.name, address.company, address.phone, address.mobile, deliveryAddress.postcode, deliveryAddress.town, deliveryAddress.gesoftName1, deliveryAddress.gesoftName2, deliveryAddress.name, deliveryAddress.company, deliveryAddress.phone, deliveryAddress.mobile, deliveryPeriod, items.articles.articleNumber, paymentMethod, type, status, randomPinCode useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: dateCreated, lastUpdate, deliveryDate greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"group": [{}, {}]} Feld Typ Beschreibung group String

Die Ergebnisse erscheinen nicht unter data, sondern unter ("result":{"orders": {"group": {"yearMonth": {}}} })

Erlaubte Werte: yearMonth "params":{"orders": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "orders": {"sort": [{}, {}]} expectedData Object

Siehe "orders": {"expectedData": {} "params":{"orders": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, customerId, customerNumber, email, address.gesoftName1, address.gesoftName2, address.street, address.postcode, address.town, address.name, address.company, address.phone, address.mobile, deliveryAddress.gesoftName1, deliveryAddress.gesoftName2, deliveryAddress.street, deliveryAddress.postcode, deliveryAddress.town, deliveryAddress.name, deliveryAddress.company, deliveryAddress.phone, deliveryAddress.mobile, deliveryDate, deliveryPeriod, paymentMethod.name, type, status, dateCreated direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"orders": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 token Number

Erlaubte Werte: 1 priceMode Number

Erlaubte Werte: 1 priceGroup Number

Erlaubte Werte: 1 userId Number

Erlaubte Werte: 1 customerId Number

Erlaubte Werte: 1 customerNumber Number

Erlaubte Werte: 1 customerStatus Number

Erlaubte Werte: 1 email Number

Erlaubte Werte: 1 address Number

Siehe: "result":{"orders": { "data": [{"address": {} }]}}

Erlaubte Werte: 1 address.gesoftName1 Number

Erlaubte Werte: 1 address.gesoftName2 Number

Erlaubte Werte: 1 address.street Number

Erlaubte Werte: 1 address.postcode Number

Erlaubte Werte: 1 address.town Number

Erlaubte Werte: 1 address.company Number

Erlaubte Werte: 1 address.name Number

Erlaubte Werte: 1 address.firstName Number

Erlaubte Werte: 1 address.salutation Number

Erlaubte Werte: 1 address.title Number

Erlaubte Werte: 1 address.additionalAddressInformation Number

Erlaubte Werte: 1 address.phone Number

Erlaubte Werte: 1 address.mobile Number

Erlaubte Werte: 1 address.floor Number

Erlaubte Werte: 1 address.elevator Number

Erlaubte Werte: 1 deliveryAddress Number

Siehe: "result":{"orders": { "data": [{"deliveryAddress": {} }]}}

Erlaubte Werte: 1 deliveryAddress.gesoftName1 Number

Erlaubte Werte: 1 deliveryAddress.gesoftName2 Number

Erlaubte Werte: 1 deliveryAddress.street Number

Erlaubte Werte: 1 deliveryAddress.postcode Number

Erlaubte Werte: 1 deliveryAddress.town Number

Erlaubte Werte: 1 deliveryAddress.company Number

Erlaubte Werte: 1 deliveryAddress.name Number

Erlaubte Werte: 1 deliveryAddress.firstName Number

Erlaubte Werte: 1 deliveryAddress.salutation Number

Erlaubte Werte: 1 deliveryAddress.title Number

Erlaubte Werte: 1 deliveryAddress.additionalAddressInformation Number

Erlaubte Werte: 1 deliveryAddress.phone Number

Erlaubte Werte: 1 deliveryAddress.mobile Number

Erlaubte Werte: 1 deliveryAddress.floor Number

Erlaubte Werte: 1 deliveryAddress.elevator Number

Erlaubte Werte: 1 count Number

Siehe: shoppingCart/set "result":{"shoppingCarts": { "data": ["count": [{}] ] } }

Erlaubte Werte: 1 items Number

Siehe: "result":{"orders": { "data": ["items": [{}] ] } }. Ergänzend existiert bei einem gekauften Gutschein noch ein Array vouchersCreated Siehe: "result":{"orders": { "data": ["items": [{"vouchersCreated": [{}]}] ] } }

Erlaubte Werte: 1 sum Number

Erlaubte Werte: 1 deliveryDate Number

Erlaubte Werte: 1 deliveryPeriod Number

Erlaubte Werte: 1 paymentMethod Number

Erlaubte Werte: 1 type Number

Erlaubte Werte: 1 status Number

Erlaubte Werte: 1 note Number

Erlaubte Werte: 1 randomPinCode Number

Erlaubte Werte: 1 ip Number

Erlaubte Werte: 1 htmlConfirmationCustomer Number

Dieser Wert ist ausschließlich enthalten, wenn er als expectedData übergeben wurde

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"orders": {"group": {"yearMonth": {}}} } Feld Typ Beschreibung year String

Jahr month String

Monat sumOrders Number

Anzahl der Bestellungen sumNetTotal Number

Netto Summe der Bestellungen "result":{"orders": {"data": [{}]}} Feld Typ Beschreibung id String

Id der Bestellung token String type Enum

Bestellung oder Leergut-Taxi

Erlaubte Werte: order, orderRequest, pickup status Enum

Erlaubte Werte: open, canceled, progressStarted, inProgress, inDelivery, finished userId String|null

Ist dieses Feld mit null gefüllt, hat der Kunde sich nicht angemeldet (null + type "order" = Gastbestellung) customerId String customerNumber String|null

Kundennummer email String address Object

Siehe: "result":{"orders": { "data": [{"address": {} }]}} count Object

Siehe: shoppingCart/set "result":{"shoppingCarts": { "data": ["count": [{}] ] } } items Array

Siehe: shoppingCart/set "result":{"shoppingCarts": {"data": {"items": {}} } } sum Array

Siehe: shoppingCart/set "result":{"shoppingCarts": {"data": {"sum": {}} } } priceGroup String

Preisgruppe priceMode Enum

Preismodus

Erlaubte Werte: net, gross deliveryAddress Object

Abweichende Lieferadresse, sofern definiert deliveryDate Date

Lieferdatum (Y-m-d) deliveryPeriod String

Lieferzeitraum paymentMethod Object

Zahlungsart note String

Kommentar zur Bestellung randomPinCode String dateCreated String "params":{"data":{"address":{} } } Feld Typ Beschreibung gesoftName1 String

gesoftName1 oder gesoftName2 erforderlich

Größenbereich: 255 Zeichen gesoftName2 String

gesoftName2 oder gesoftName2 erforderlich

Größenbereich: 255 Zeichen street String

Straße und Hausnummer

Größenbereich: 255 Zeichen postcode String

Postleitzahl

Größenbereich: 50 Zeichen town String

Stadt

Größenbereich: 255 Zeichen company String

Firma

Größenbereich: 255 Zeichen name String

Name

Größenbereich: 255 Zeichen firstName String

Vorname

Größenbereich: 255 Zeichen salutation String

Anrede

Größenbereich: 255 Zeichen title String

Titel

Größenbereich: 255 Zeichen additionalAddressInformation String

Zusätzliche Adressinformationen

Größenbereich: 255 Zeichen phone String

Telefon

Größenbereich: 50 Zeichen mobile String

Mobiltelefon

Größenbereich: 50 Zeichen floor Integer

Etage elevator Bool

Aufzug "params":{"data":{"deliveryAddress":{} } } Feld Typ Beschreibung gesoftName1 String

gesoftName1 oder gesoftName2 erforderlich

Größenbereich: 255 Zeichen gesoftName2 String

gesoftName2 oder gesoftName2 erforderlich

Größenbereich: 255 Zeichen street String

Straße und Hausnummer

Größenbereich: 255 Zeichen postcode String

Postleitzahl

Größenbereich: 50 Zeichen town String

Stadt

Größenbereich: 255 Zeichen company String

Firma

Größenbereich: 255 Zeichen name String

Name

Größenbereich: 255 Zeichen firstName String

Vorname

Größenbereich: 255 Zeichen salutation String

Anrede

Größenbereich: 255 Zeichen title String

Titel

Größenbereich: 255 Zeichen additionalAddressInformation String

Zusätzliche Adressinformationen

Größenbereich: 255 Zeichen phone String

Telefon

Größenbereich: 50 Zeichen mobile String

Mobiltelefon

Größenbereich: 50 Zeichen floor Integer

Etage elevator Bool

Aufzug "result":{"orders": {}} Feld Typ Beschreibung count Object

Siehe "result":{"orders": {"count": {} }} "result":{"orders": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern "result":{"orders": { "data": ["items": [{"vouchersCreated": [{}]}] ] } } Feld Typ Beschreibung status Enum

Status des Gutscheins

Erlaubte Werte: paymentPending, active code String

Gutscheincode value Float

Wert des Gutscheins voucherId String

Id des Gutscheins orders | 3. orders_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: orders/update params Object "params":{"unset":[]} Feld Typ Beschreibung unset Array

Entfernt die Spalten aus der Datenbank

Erlaubte Werte: deliveryTourId "params":{"data":{}} Feld Typ Beschreibung id String

Id der Order

Größenbereich: 255 Zeichen shoppingCartId String

Id der ShoppingCart

Größenbereich: 255 Zeichen token String

Token der ShoppingCart

Größenbereich: 255 Zeichen _ String

Alle anderen Daten sind identisch zu orders/set und optional.

Größenbereich: 255 Zeichen "result":{"orders":{}} Feld Typ Beschreibung updated Object

Siehe: "result":{"orders":{"updated"}} "result":{"orders":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte orders | 4. orders_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: orders/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String

ID "result":{"orders":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge orders | 5. orderConfirmations_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: orderConfirmations/set params Object "params":{"data":{}} Feld Typ Beschreibung id String

ID der order token String

Token von der order email String

E-Mail des Empfängers template String

E-Mail-Template für die Bestellung

Erlaubte Werte: customer, dealer withoutPrices Bool

Bei true wird die Bestellbestätigung ohne Preise generiert.

Erlaubte Werte: false "result":{"orderConfirmations": {"data":{} } } Feld Typ Beschreibung id String payments payments | 1. set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/set params Object "params":{"data":{}} Feld Typ Beschreibung paymentProvider Enum

Zahlsystem

Erlaubte Werte: paypal, paypalExpress, stripe, stripeExpress, klarna externalPaymentId String

externe Id des Zahlungsanbieters

Größenbereich: 255 Zeichen "result":{"payments": {"data":{} } } Feld Typ Beschreibung id String payments | 2. get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: paymentProvider, externalPaymentId useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: dateCreated, lastUpdate greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"payments": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "payments": {"sort": [{}, {}]} expectedData Object

Siehe "payments": {"expectedData": {} "params":{"payments": {"sort": [{}, {}]} } Feld Typ Beschreibung field Enum

Feld das sortiert werden soll

Erlaubte Werte: id, paymentProvider, dateCreated, lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"payments": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 paymentProvider Number

Erlaubte Werte: 1 externalPaymentId Number

Erlaubte Werte: 1 paypalResponse Number

Erlaubte Werte: 1 stripeResponse Number

Erlaubte Werte: 1 dateCrated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"payments": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"payments": {"count": {} }} "result":{"payments": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern payments | 3. paypal_get_payment_url post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/paypal/getPaymentUrl params Object "params":{"data":{}} Feld Typ Beschreibung shoppingCartId String

Id der ShoppingCart

Größenbereich: 255 Zeichen shoppingCartToken String

Token der ShoppingCart

Größenbereich: 255 Zeichen priceMode Enum

Preismodus

Erlaubte Werte: net, gross returnUrl String

URL zu der nach erfolgreichen Kauf zurückgeleitet werden soll

Größenbereich: 255 Zeichen cancelUrl String

URL, wenn Kauf abgebrochen wird

Größenbereich: 255 Zeichen "result":{"payments": {"data":{} } } Feld Typ Beschreibung externalPaymentId String urlToPaymentProvider String payments | 3. paypal_get_payment_url post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/paypal/getPaymentUrlByOrder params Object "params":{"data":{}} Feld Typ Beschreibung orderId String

Id der order

Größenbereich: 255 Zeichen priceMode Enum

Preismodus

Erlaubte Werte: net, gross returnUrl String

URL zu der nach erfolgreichen Kauf zurückgeleitet werden soll

Größenbereich: 255 Zeichen cancelUrl String

URL, wenn Kauf abgebrochen wird

Größenbereich: 255 Zeichen "result":{"payments": {"data":{} } } Feld Typ Beschreibung externalPaymentId String urlToPaymentProvider String payments | 4. paypal_get_payment post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/paypal/getPayment params Object "params":{"data":{}} Feld Typ Beschreibung externalPaymentId String

Id von PayPal

Größenbereich: 255 Zeichen shoppingCartId String

Id der shoppingCart

Größenbereich: 255 Zeichen "result":{"payments": {"data":{} } } Feld Typ Beschreibung payerId String email String authorizedSum Float deliveryAddress Object

Siehe "result":{"payments": {"data":{"deliveryAddress": {}} } } "result":{"payments": {"data":{"deliveryAddress": {}} } } Feld Typ Beschreibung firstName String name String phone String street String additionalAddressInformation String postcode String town String countryCode String birthDate String payments | 5. stripe_get_payment_url post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/stripe/getPaymentUrl params Object "params":{"data":{}} Feld Typ Beschreibung orderId String

Id der order

Größenbereich: 255 Zeichen priceMode Enum

Preismodus

Erlaubte Werte: net, gross returnUrl String

URL zu der nach erfolgreichen Kauf zurückgeleitet werden soll

Größenbereich: 255 Zeichen cancelUrl String

URL, wenn Kauf abgebrochen wird

Größenbereich: 255 Zeichen "result":{"payments": {"data":{} } } Feld Typ Beschreibung externalPaymentId String urlToPaymentProvider String payments | 6. stripe_set_intent post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/stripe/setIntent params Object "params":{"data":{}} Feld Typ Beschreibung shoppingCartId String

Id der ShoppingCart

Größenbereich: 255 Zeichen shoppingCartToken String

Token der ShoppingCart

Größenbereich: 255 Zeichen priceMode Enum

Preismodus

Erlaubte Werte: net, gross "result":{"payments": {"data":{} } } Feld Typ Beschreibung clientSecret String payments | 7. paypal_set_payment post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/paypal/setPayment params Object "params":{"data":{}} Feld Typ Beschreibung externalPaymentId String

Id von PayPal

Größenbereich: 255 Zeichen orderId String

Id der order

Größenbereich: 24 Zeichen shoppingCartId String

Id der ShoppingCart

Größenbereich: 24 Zeichen "result":{"payments": {"data":{} } } Feld Typ Beschreibung externalPaymentId String urlToPaymentProvider String payments | 8. klarna_set_intent post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/klarna/setIntent params Object "params":{"data":{}} Feld Typ Beschreibung shoppingCartId String

Id der ShoppingCart

Größenbereich: 255 Zeichen shoppingCartToken String

Token der ShoppingCart

Größenbereich: 255 Zeichen priceMode Enum

Preismodus

Erlaubte Werte: net, gross "result":{"payments": {"data":{} } } Feld Typ Beschreibung clientToken String sessionRequest Object

   Daten die an die Klarna-Schnittstelle gesendet wurden

payments | 9. klarna_set_payment post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: payments/klarna/setPayment params Object "params":{"data":{}} Feld Typ Beschreibung shoppingCartId String

Id der ShoppingCart

Größenbereich: 255 Zeichen shoppingCartToken String

Token der ShoppingCart

Größenbereich: 255 Zeichen priceMode Enum

Preismodus

Erlaubte Werte: net, gross authorizationToken String

Klarna authorization_token "result":{"payments": {"data":{} } } Feld Typ Beschreibung externalPaymentId String shoppingCarts shoppingCarts | 1. shoppingCarts_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: shoppingCarts/set params Object "params":{"data":{}} Feld Typ Beschreibung priceGroups Array

Bei Übergabe werden explizit diese Presigruppe verwendet. Die Preisgruppe des Customers wird nicht mehr berücksichtigt. Es handelt sich um ein Array aus Strings. customerId String

Id des customers deliveryDate String

Lieferdatum Hier werden Angebotspreise bis zu diesem Datum berücksichtigt. Sofern nicht übergeben wird das aktuelle Datum für die Ermittlung verwendet. articles Array

Array s. "params":{"data":{"articles":[{}]}} vouchers Object

Array aus Strings, die den Gutscheincode enthalten "params":{"data":{"articles":[{}]}} Feld Typ Beschreibung amount Int

Anzahl der Artikel. Bei dem Wert 0 wird der Artikel gelöscht, sofern er im Warenkorb enthalten ist. articleNumber String

Artikelnummer "params":{"data":{"vouchers":[{}]}} Feld Typ Beschreibung amount Int

Bei dem Wert 0 wird der Gutschein gelöscht, sofern er im Warenkorb enthalten ist

Erlaubte Werte: 0, 1 code String

Gutscheincode "result":{"shoppingCarts": {} Feld Typ Beschreibung data Object

Siehe ("result":{"shoppingCarts": {"data":{} } }) notification Array

Siehe ("result":{"shoppingCarts": {"notifications":[{}] } }) "result":{"shoppingCarts": {"data":{} } } Feld Typ Beschreibung id String token String status Enum

Erlaubte Werte: paymentPending priceGroups Array userId Array customerNumber Array deliveryDate String country String count Object

Siehe: "result":{"shoppingCarts": { "data": ["count": {} ] } } items Object

Siehe: "result":{"shoppingCarts": { "data": ["items": {} ] } } sum Object

Siehe: "result":{"shoppingCarts": { "data": ["sum": {} ] } } "result":{"shoppingCarts": { "data": ["count": {} } } Feld Typ Beschreibung articles Object

Anzahl der Artikel im Warenkorb dynamicArticles Object

Anzahl der dynamischen Artikel im Warenkorb "result":{"shoppingCarts": { "data": ["count": {"articles": {}} ] } } Feld Typ Beschreibung items Int

Anzahl der Artikel im Warenkorb itemsForGesoftPriceIdentification Int

Anzahl der Artikel, welche für die Gesoft Preisfindung berücksichtigt werden "result":{"shoppingCarts": { "data": ["count": {"dynamicArticles": {}} ] } } Feld Typ Beschreibung items Int

Anzahl der dynamischen Artikel "result":{"shoppingCarts": { "data": ["items": [{}] ] } } Feld Typ Beschreibung articles Array dynamicArticles Array

Z.B. giveAways oder paymentFees vouchers Array "result":{"shoppingCarts": { "data": ["items": [{"articles": [{}]}] ] } } Feld Typ Beschreibung id String articleNumber String

Artikelnummer name String

Artikelname groups Array quantity Integer

Anzahl unit Integer

Gebinde partOfArticleNumber String

Teil von Artikelnummer unitAddition String

Gebindezusatz z.B. 6x4 unitOfMeasurement String

Maßeinheit der Unit (l, kg o.ä.) availability String

Verfügbarkeit considerQuantityInCart Bool

Relavant für die Preisermittlung taxRate Float

Steuersatz packageType String

Gebindetyp depositPackageType String

Gebindetyp-Leergut amount Integer

Menge netPrice Float

Netto-Preis netDeposit Float

Netto-Pfand netFee Float

Netto-Gebühr netSumPrice Float

Netto-Summe des Preises netSumDeposit Float

Netto-Summe des Pfandes netSumFees Float

Netto-Summe der Gebühr netSumTax Float

Netto-Summe der Steuer netSumTotal Float

Netto-Gesamtsumme des Artikels grossPrice Float

Brutto-Preis grossDeposit Float

Brutto-Pfand grossFee Float

Brutto-Gebühr grossSumDeposit Float

Brutto-Summe des Pfandes grossSumFees Float

Brutto-Summe der Gebühr grossSumTax Float

Brutto Summe des Pfandes grossSumTotal Float

Brutto Gesamtsumme des Artikels "result":{"shoppingCarts": { "data": ["items": [{"articles": [{"groups":[{}] } ] }] ] } } Feld Typ Beschreibung groupName String group1Name String "result":{"shoppingCarts": { "data": ["items": [{"dynamicArticles": [{}]}] ] } } Feld Typ Beschreibung id String deletable Bool

Löschbar articleNumber String

Artikelnummer name String

Artikelnummer description String

Beschreibung amount Integer

Menge netPrice Float

Netto-Preis netDeposit Float

Netto-Pfand netFee Float

Netto-Gebühr netSumPrice Float

Netto-Summe des Preises netSumDeposit Float

Netto-Summe des Pfandes netSumFees Float

Netto-Summe der Gebühr netSumTax Float

Netto-Summe der Steuer netSumTotal Float

Netto-Summe grossPrice Float

Brutto-Preis grossDeposit Float

Brutto-Pfand grossFee Float

Brutto-Gebühr grossSumPrice Float

Brutto Summe des Preises grossSumDeposit Float

Brutto-Summe des Pfandes grossSumFees Float

Brutto-Summe der Gebühr taxRate Float

Steuersatz "result":{"shoppingCarts": { "data": ["items": [{"vouchers": [{}]}] ] } } Feld Typ Beschreibung status Enum

Status des Gutscheins

Erlaubte Werte: paymentPending, active, opened, used, multipleUse code String

Gutscheincode balance Float

Restwert des Gutscheins discountInPercent Float

Rabatt in Prozent netPrice Float

Netto-Preis Bei einem negativen Wert wurde der Gutschein eingelöst. grossPrice Float

Brutto-Preis Bei einem negativen Wert wurde der Gutschein eingelöst. "result":{"shoppingCarts": {"data": {"sum": {}} } } Feld Typ Beschreibung articles Float

Summe der Artikel dynamicArticles Float

Summe der dynamischen Artikel vouchers Float

Summe der dynamischen Artikel total Float

inkl. articles, dynamicArticles & vouchers "result":{"shoppingCarts": {"data": {"sum": {"articles": {} }} } } Feld Typ Beschreibung netPrice Float

Netto-Summe des Preises netDeposit Float

Netto-Summe Pfand netFees Float

Netto-Summe Gebühren netTax Float

Netto-MwSt.-Summe Kann zu Brutto abweichen, weil ggf. das Pfand einen anderen Preis hat netTotal Float

Netto-Gesamtbetrag inkl. Steuer! Der kann vom Brutto-Gesamtbetrag abweichen, weil ggf. das Pfand einen anderen Preis hat. grossPrice Float

Brutto-Summe des Preises grossDeposit Float

Brutto-Summe Pfand grossFees Float

Brutto-Summe Gebühren grossTax Float

Brutto-MwSt.-Summe Kann zu Netto abweichen, weil ggf. das Pfand einen anderen Preis hat grossTotal Float

Brutto-Gesamtbetrag inkl. Steuer! Der kann vom Netto-Gesamtbetrag abweichen, weil ggf. das Pfand einen anderen Preis hat. taxRates Array "result":{"shoppingCarts": {"data": {"sum": {"articles": {"taxRates": [] } }} } } Feld Typ Beschreibung taxRate Float

Steuersatz netTax Float

Netto-Steuer der jeweiligen MwSt netFees Float

Netto-Gebühren der jeweiligen MwSt. grossTax Float

Brutto-Steuer der jeweiligen MwSt. grossFee Float

Brutto-Gebühren der jeweiligen MwSt. "result":{"shoppingCarts": {"data": {"sum": {"dynamicArticles": {} }} } } Feld Typ Beschreibung netPrice Float

Netto-Summe des Preises netDeposit Float

Netto-Summe Pfand netFees Float

Netto-Summe Gebühren netTax Float

Netto-MwSt.-Summe Kann zu Brutto abweichen, weil ggf. das Pfand einen anderen Preis hat netTotal Float

Netto-Gesamtbetrag inkl. Steuer! Der kann vom Brutto-Gesamtbetrag abweichen, weil ggf. das Pfand einen anderen Preis hat. grossPrice Float

Brutto-Summe des Preises grossDeposit Float

Brutto-Summe Pfand grossFees Float

Brutto-Summe Gebühren grossTax Float

Brutto-MwSt.-Summe Kann zu Netto abweichen, weil ggf. das Pfand einen anderen Preis hat grossTotal Float

Brutto-Gesamtbetrag inkl. Steuer! Der kann vom Netto-Gesamtbetrag abweichen, weil ggf. das Pfand einen anderen Preis hat. taxRates Array category String

Kategorie des dynamischen Artikels

Größenbereich: 255 Zeichen "result":{"shoppingCarts": {"data": {"sum": {"dynamicArticles": {"taxRates": [] } }} } } Feld Typ Beschreibung taxRate Float

Steuersatz netTax Float

Netto-Steuer der jeweiligen MwSt netFees Float

Netto-Gebühren der jeweiligen MwSt. grossTax Float

Brutto-Steuer der jeweiligen MwSt. grossFee Float

Brutto-Gebühren der jeweiligen MwSt. "result":{"shoppingCarts": {"data": {"sum": {"vouchers": {} }} } } Feld Typ Beschreibung netPrice Float

Netto-Summe des Preises netTax Float

Netto-MwSt.-Summe Kann zu Brutto abweichen, weil ggf. das Pfand einen anderen Preis hat netTotal Float

Netto-Gesamtbetrag inkl. Steuer! Der kann vom Brutto-Gesamtbetrag abweichen, weil ggf. das Pfand einen anderen Preis hat. grossPrice Float

Brutto-Summe des Preises grossTax Float

Brutto-MwSt.-Summe Kann zu Netto abweichen, weil ggf. das Pfand einen anderen Preis hat grossTotal Float

Brutto-Gesamtbetrag inkl. Steuer! Der kann vom Netto-Gesamtbetrag abweichen, weil ggf. das Pfand einen anderen Preis hat. taxRates Array "result":{"shoppingCarts": {"data": {"sum": {"vouchers": {"taxRates": [] } }} } } Feld Typ Beschreibung taxRate Float

Steuersatz netTax Float

Netto-Steuer der jeweiligen MwSt grossTax Float

Brutto-Steuer der jeweiligen MwSt. "result":{"shoppingCarts": {"data": {"sum": {"total": {} }} } } Feld Typ Beschreibung netPrice Float

Netto-Summe des Preises netDeposit Float

Netto-Summe Pfand netFees Float

Netto-Summe Gebühren netTax Float

Netto-MwSt.-Summe Kann zu Brutto abweichen, weil ggf. das Pfand einen anderen Preis hat netTotal Float

Netto-Gesamtbetrag inkl. Steuer! Der kann vom Brutto-Gesamtbetrag abweichen, weil ggf. das Pfand einen anderen Preis hat. grossPrice Float

Brutto-Summe des Preises grossDeposit Float

Brutto-Summe Pfand grossFees Float

Brutto-Summe Gebühren grossTax Float

Brutto-MwSt.-Summe Kann zu Netto abweichen, weil ggf. das Pfand einen anderen Preis hat grossTotal Float

Brutto-Gesamtbetrag inkl. Steuer! Der kann vom Netto-Gesamtbetrag abweichen, weil ggf. das Pfand einen anderen Preis hat. taxRates Array "result":{"shoppingCarts": {"data": {"sum": {"total": {"taxRates": [] } }} } } Feld Typ Beschreibung taxRate Float

Steuersatz netTax Float

Netto-Steuer der jeweiligen MwSt netFees Float

Netto-Gebühren der jeweiligen MwSt. grossTax Float

Brutto-Steuer der jeweiligen MwSt. grossFee Float

Brutto-Gebühren der jeweiligen MwSt. "result":{"shoppingCarts": {"notifications":[{}]} } } Feld Typ Beschreibung id String

Z.B. Artikelnummer, voucherNumber oder dynamicArticleId message String

Z.B. Artikelnummer existiert nicht shoppingCarts | 2. shoppingCarts_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: shoppingCarts/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, token, customerId, articles.articleNumber, vouchers, role useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: dateCreated, lastUpdate fieldOperator Enum

Operator für die Felder

Standardwert: or

Erlaubte Werte: or, and greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"shoppingCarts": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "shoppingCarts": {"sort": [{}, {}]} expectedData Object

Siehe "shoppingCarts": {"expectedData": {} "params":{"shoppingCarts": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, userId, customerId, customerNumber, dateCreated, lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"shoppingCarts": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 userId Number

Erlaubte Werte: 1 customerNumber Number

Erlaubte Werte: 1 count Number

Erlaubte Werte: 1 items Number

Erlaubte Werte: 1 sum Number

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"shoppingCarts": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. Siehe result "result":{"shoppingCarts": {}" (shoppingCart/set) "result":{"shoppingCarts": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern shoppingCarts | 2. shoppingCarts_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: shoppingCarts/update params Object "params":{"data":{}} Feld Typ Beschreibung id String

Größenbereich: 24 Zeichen token String

Größenbereich: 24 Zeichen status Enum

Erlaubte Werte: paymentPending priceGroups Array

Bei Übergabe werden explizit diese Presigruppe verwendet. Die Preisgruppe des Customers wird nicht mehr berücksichtigt. Es handelt sich um ein Array aus Strings. deliveryDate String

Lieferdatum. Die Angebotspreise zu diesem Lieferdatum werden gezogen. Sofern nicht übergeben wird das aktuelle Datum für die Ermittlung verwendet. "result":{"shoppingCarts":{}} Feld Typ Beschreibung data Object

Identisch zu shoppingCart/set updated Object

Siehe: "result":{"shoppingCarts":{"updated"}} "result":{"shoppingCarts":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte shoppingCarts | 4. shoppingCarts_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: shoppingCarts/delete params Object "params":{"data":{}} Feld Typ Beschreibung id String token String "result":{"shoppingCarts":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge uploads uploads | 1. uploads_image post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: uploads/image params Object "params":{"data":{}} Feld Typ Beschreibung fileBase64 String

Base64-String fileName String

Bildname. Der Name wird um eine uniqid ergänzt. "params":{"data":{"thumbnails": [{}] }} Feld Typ Beschreibung name String

Z.B. small, big width Number height Number "result":{"uploads": {"data":{} } } Feld Typ Beschreibung filePath String

Pfad für die Datenbank. "result":{"uploads": {"data":{"thumbnails": [{}]} } } Feld Typ Beschreibung name String filePath String uploads | 2. uploads_file post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: uploads/file "params":{"data":{}} Feld Typ Beschreibung fileBase64 String

Base64-String fileName String

Der Name wird um eine uniqid ergänzt visibility Enum

public Ist über eine URL erreichbar

private Ist nicht über eine URL erreichbar

Erlaubte Werte: public, private "result":{"upload": {"data":{} } } Feld Typ Beschreibung filePath String

Pfad für die Datenbank. uploadsStorage uploadsStorage | 1. uploadsStorage_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: uploadsStorage/set params Object "params":{"data":{}} Feld Typ Beschreibung path String

Die Daten werden über die Schnittstelle "uploads/image" erstellt

Größenbereich: 1000 Zeichen public Bool "result":{"uploadsStorage": {"data":{} } } Feld Typ Beschreibung id String uploadsStorage | 2. uploadsStorage_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: uploadsStorage/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, path useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: dateCreated, lastUpdate greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"uploadsStorage": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "uploadsStorage": {"sort": [{}, {}]} expectedData Object

Siehe "uploadsStorage": {"expectedData": {} "params":{"uploadsStorage": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, path, public, dateCreated., lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"uploadsStorage": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 path Number

Erlaubte Werte: 1 public Number

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"uploadsStorage": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"uploadsStorage": {"count": {} }} "result":{"uploadsStorage": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern uploadsStorage | 4. uploadsStorage_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: uploadsStorage/delete params Object "params":{"data":{}} Feld Typ Beschreibung username String

Benutzername "result":{"uploadsStorage":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge users users | 1. users/set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: users/set params Object "params":{"data":{}} Feld Typ Beschreibung username String

Eindeutiger Benutzername

Größenbereich: 255 Zeichen password String

Passwort

Größenbereich: 255 Zeichen email String

E-Mail

Größenbereich: 255 Zeichen role String

Funktion

Erlaubte Werte: admin, staff "result":{"users": {"data":{} } } Feld Typ Beschreibung id String users | 1. users_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: users/set params Object "params":{"data":{}} Feld Typ Beschreibung username String

Eindeutiger Benutzername

Größenbereich: 255 Zeichen password String

Passwort

Größenbereich: 255 Zeichen email String

E-Mail

Größenbereich: 255 Zeichen role String

Funktion

Erlaubte Werte: admin, api, staff, customer shopAccessForCustomers Array

Siehe "params":{"data":{"shopAccessForCustomers":[{}, {}] } } "params":{"data":{"shopAccessForCustomers":[{}, {}] } } Feld Typ Beschreibung customerId String

ID des Kunden aus unserer Datenbank

Größenbereich: 50 Zeichen defaultBillingAddressId String

Standard-Adresse für Bestellungen von diesem Kunden

Größenbereich: 255 Zeichen defaultDeliveryAddressId String

Standard-Lieferadresse für Bestellungen von diesem Kunden

Größenbereich: 255 Zeichen permissions Object

Berechtigungen. "params":{"data":{"shopAccessForCustomers": [{"permissions": {} }] }} Feld Typ Beschreibung addressIds Array

Adressen für die der Kunde bestellen darf. grant EnumArray

Der User erhält Berechtigungen für die einzelnen Punkte. Falls nicht angegeben, erhält der User Zugriff auf alle zur Auswahl stehenden Punkte.

Erlaubte Werte: users, customer, prices, invoice "result":{"users": {"data":{} } } Feld Typ Beschreibung id String users | 2. users/get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: users/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, username, email, role useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: dateCreated, lastUpdate greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"users": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "users": {"sort": [{}, {}]} expectedData Object

Siehe "users": {"expectedData": {} "params":{"users": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, username, email, dateCreated., lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"users": {"expectedData": {}} } Feld Typ Beschreibung username Number

Erlaubte Werte: 1 email Number

Erlaubte Werte: 1 role Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"users": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"users": {"count": {} }} "result":{"users": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern users | 2. users_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: users/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: id, username, email, role, shopAccessForCustomers.customerId useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"filterDates": [{}, {}]} Feld Typ Beschreibung fields Array

Feld welches gefiltert werden soll

Erlaubte Werte: dateCreated, lastUpdate greaterThan String

Größer als

Größenbereich: Date (Y-m-d H:i:s) greaterThanEqual String

Größer als oder gleich

Größenbereich: Date (Y-m-d H:i:s) lessThan String

Kleiner als

Größenbereich: Date (Y-m-d H:i:s) lessThanEqual String

Kleiner als oder Gleich

Größenbereich: Date (Y-m-d H:i:s) fieldOperator Enum

Standardwert: and

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filterDates enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"users": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "users": {"sort": [{}, {}]} expectedData Object

Siehe "users": {"expectedData": {} "params":{"users": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, username, email, dateCreated., lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"users": {"expectedData": {}} } Feld Typ Beschreibung username Number

Erlaubte Werte: 1 email Number

Erlaubte Werte: 1 role Number

Erlaubte Werte: 1 shopAccessForCustomers Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"users": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"users": {"count": {} }} "result":{"users": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern users | 3. users/update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: users/update params Object "params":{"data":{}} Feld Typ Beschreibung id String

Hinweis Die Parameter in dem Objekt data sind identisch zu dem command users/set . Abweichend zu users/set sind alle Felder optional (mit Ausnahme von id). Es werden ausschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 24 Zeichen "result":{"users":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte users | 3. users_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: users/update params Object "params":{"data":{}} Feld Typ Beschreibung id String

Hinweis Die Parameter in dem Objekt data sind identisch zu dem command users/set . Abweichend zu users/set sind alle Felder optional (mit Ausnahme von id). Es werden ausschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 24 Zeichen "result":{"users":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte users | 4. users/delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: users/delete params Object "params":{"data":{}} Feld Typ Beschreibung username String

Benutzername "result":{"users":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge users | 4. users_delete post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: users/delete params Object "params":{"data":{}} Feld Typ Beschreibung username String

Benutzername "result":{"users":{"deleted"}} Feld Typ Beschreibung count Number

Anzahl der gelöschten Einträge users | 5. userTokens_set

Die Commands werden an die URL https://api.gesoft.de/v1/ gesendet.

post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: userTokens/set params Object "params":{"data":{}} Feld Typ Beschreibung username String

Größenbereich: 255 Zeichen password String

Bei einem falschen Passwort wird der Zugang beim 2. Versuch für 5 Sekunden gesperrt. Bei jedem weiteren Versuch für weitere 5 Sekunden.

Größenbereich: 255 Zeichen cookie Bool

Schreibt den accessToken und den refreshToken in ein httpOnly-Cookie und entfernt diesen aus der Antwort. source Enum

Standardwert: account

Erlaubte Werte: account, admin "result":{"userTokens": {"data":{} } } Feld Typ Beschreibung accessToken String

JWT. Nur vorhanden, wenn der Wert "cookie" auf false steht refreshToken String

Dieser hat eine Gültigkeit von 30 Tagen. Nur vorhanden, wenn der Wert "cookie" auf false steht tokenType String

Typ des Tokens. Nur vorhanden, wenn der Wert "cookie" auf false steht

Erlaubte Werte: bearer config String

String expiredIn Int

Gültigkeit in Sekunden userId String

String

   Request-Example (body):

{

   "id": "1",
   "command": "userTokens/set",
   "data": {
       "username": "myUsername",
       "password": "myPassword"
   }

}

   Success-Response (body):

   {

"id":"1", "result":{

"userTokens":{
    "data":{
        "accessToken":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MTk3MTI0NTYsInVzZXJJZCI6bnVsbCwidXNlcm5hbWUiOiJhcGlfNDUyNjU0Nl9pY19hZyIsImVtYWlsIjoibWlAaW5kZW53YXJlLmRlIiwicm9sZSI6ImFwaSJ9.ofOorhlkA3RIHkdBrB0WFuyudxJ8v7c28nBctlsndDk",
        "refreshToken":"581a6c36c84bc8823cb8697ed589ecf12c557361a1339db92b1859c28caa",
        "tokenType":"bearer",
        "expiredIn": 10800,
        "config": "demo_gesoft"
        "userId": "g635g452gzh452h452hfd32"
        }
    }
}

}

users | 6. userTokens_generate

Für die Ausführung des Commands muss der User authentifiziert sein und den Status "admin" besitzen

post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: userTokens/get params Object

Diese Schnittstelle können ausschließlich Admins aufrufen "params":{"data":{}} Feld Typ Beschreibung userId String

Größenbereich: 255 Zeichen expiredIn Int

Gültigkeit in Minuten (max. 180 = 3 Stunden)

Erlaubte Werte: 180 "result":{"userTokens": {"data":{} } } Feld Typ Beschreibung accessToken String

JWT. users | 7. userTokens_refresh post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: userTokens/refresh params Object "params":{"data":{}} Feld Typ Beschreibung refreshToken String

Größenbereich: 255 Zeichen cookie Bool

Schreibt ein httpOnly-Cookie und gibt dieses dem Client zurück "result":{"userTokens": {"data":{} } } Feld Typ Beschreibung String

accessToken JWT expiredIn Int

Ablaufzeit in Sekunden users | 8. userEmailVerification_send post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: userEmailVerification/send params Object "params":{"data":{}} Feld Typ Beschreibung username String

Größenbereich: 255 Zeichen "result":{"userTokens": {"data":{} } } Feld Typ Beschreibung email String

E-Mail-Empfänger für die Verifikation vouchers vouchers | 1. vouchers_set post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: vouchers/set params Object "params":{"data":{}} Feld Typ Beschreibung status Enum

paymentPending Gutschein ist noch nicht bezahlt und somit nicht gültig

active Gutschein ist aktiv und kann genutzt werden

opened Gutschein ist angebrochen. Es gibt einen Restwert s. balance

used Gutschein ist komplett aufgebraucht und ungültig

multipleUse Gutscheincode kann mehrfach genutzt werden

Erlaubte Werte: paymentPending, active, opened, used, multipleUse code String

Eindeutige Nummer

Größenbereich: 255 Zeichen value Float

Gesamtwert des Gutscheins balance Float

Restwert des Gutscheins discountInPercent Float

Rabatt in Prozent validTo Date

Gültig bis "result":{"vouchers": {"data":{} } } Feld Typ Beschreibung id String vouchers | 2. vouchers_get post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: vouchers/get params Object "params":{"filters": [{}, {}]} Feld Typ Beschreibung values Array

Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich fields Array

Felder welche gefiltert werden sollen

Erlaubte Werte: id, status, code useRegex Enum

Führt bei dem Wert 1 eine Suche mit einem regulären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.

Standardwert: 0

Erlaubte Werte: 1, 0 fieldOperator Enum

Standardwert: or

Erlaubte Werte: and, or or Object

Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft. "params":{"vouchers": {}} Feld Typ Beschreibung start Number

Startwert

Standardwert: 0 limit Number

Maximale Anzahl an Einträgen

Standardwert: 40 sort Array

Siehe "vouchers": {"sort": [{}, {}]} expectedData Object

Siehe "vouchers": {"expectedData": {} "params":{"vouchers": {"sort": [{}, {}]} } Feld Typ Beschreibung field String

Feld das sortiert werden soll

Erlaubte Werte: id, code, value, dateCreated, lastUpdate direction Number

Richtung der Sortierung

Erlaubte Werte: 1, -1 "params":{"vouchers": {"expectedData": {}} } Feld Typ Beschreibung id Number

Erlaubte Werte: 1 status Number

Erlaubte Werte: 1 code Number

Erlaubte Werte: 1 value Number

Erlaubte Werte: 1 balance Number

Erlaubte Werte: 1 discountInPercent Number

Erlaubte Werte: 1 validTo Number

Erlaubte Werte: 1 dateCreated Number

Erlaubte Werte: 1 lastUpdate Number

Erlaubte Werte: 1 "result":{"vouchers": {}} Feld Typ Beschreibung data Array

Ein Array gem. expectedData. count Object

Siehe "result":{"vouchers": {"count": {} }} "result":{"vouchers": {"count": {} }} Feld Typ Beschreibung total Number

Alle Einträge in der Datenbank filtered Number

Gefundene Einträge mit den übergebenen Parametern vouchers | 3. vouchers_update post

/

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: vouchers/update params Object "params":{"data":{}} Feld Typ Beschreibung code String

Eindeutige Nummer

Hinweis Die Parameter in dem Objekt data sind identisch zu dem command vouchers/set . Abweichend zu vouchers/set sind alle Felder optional (mit Ausnahme des Feldes code). Es werden uasschließlich die übergebenen Felder überarbeitet. Alle anderen Daten bleiben erhalten.

Größenbereich: 255 Zeichen "params":{"unset":[]} Feld Typ Beschreibung unset Array

Entfernt die Spalten aus der Datenbank

Erlaubte Werte: validTo "result":{"vouchers":{"updated"}} Feld Typ Beschreibung matched Number

Gefundene Einträge upserted Number

Hinzugefügte Werte modified Number

Modifizierte Werte vouchers | 4. vouchers_delete post

{} Feld Typ Beschreibung id String command String

Erlaubte Werte: vouchers/delete params Object "params":{"data":{}} Feld Typ Beschreibung code String

Eindeutige Nummer des Dokuments "result":{"vouchers":{"deleted"}} Feld Typ Beschreibung count Number