Caller data exchange API

Inhaltsverzeichnis

Orders

get_orders

This export works incrementally. With each call, all new orders received since the last orders received since the last successful order export are exported.

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_bestellungen
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_bestellungen_out.xml Shop ERP Exportdatei im XML-Format
get_bestellungen_err.xml Shop ERP Statusdatei Fehler
get_bestellungen_tmp.xml Shop Shop Temporäre Ausgabedatei

The structure of the export file is described in the document ‘xml_spezifikation_bestellung.pdf’.

get_orders_from

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_bestellungen_ab&datetime_ab=argument1
Argumente: argument1 Zeitpunkt (yyyy-mm-dd hh:mm:ss), ab dem die Daten exportiert werden
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_bestellungen_ab_out.xml Shop ERP Exportdatei im XML-Format
get_bestellungen_ab_err.xml Shop ERP Statusdatei Fehler
get_bestellungen_ab_tmp.xml Shop Shop Temporäre Ausgabedatei

The structure of the export file is described in the document ‘xml_spezifikation_bestellung.pdf’. https://www.peppershop.com/peppershop_files/xml_spezifikation_bestellung.pdf

Article

set_article

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_artikel
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_artikel_inp.csv ERP Shop Importdatei im CSV-Format
set_artikel_ok.csv Shop ERP Statusdatei Erfolg
set_artikel_err.csv Shop ERP Statusdatei Fehler
set_artikel_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Artikel-Nr varchar(255) [1]
Name varchar(255)
Preis double
Aktionspreis double
Aktion von datetime(jjjj-mm-tt hh:mm:ss)
Aktion bis datetime(jjjj-mm-tt hh:mm:ss)
Aktiv von datetime(jjjj-mm-tt hh:mm:ss) Aktivierung Artikelsichtbarkeit
Aktiv bis datetime(jjjj-mm-tt hh:mm:ss)
Gewicht double
Link varchar(255) Link auf weitere Informationen
MwSt-Satz double optional
Beschreibung text
Kurzbeschreibung text
Bild gross varchar(255) Dateiname grosses Bild
Bild klein varchar(255) Dateiname kleines Bild
Maximalbestellmenge double
Mindestbestellmenge double
Mindestlagermenge double
Lagerbestand int(11) Anlieferung nur mit einem Lager möglich
Lieferbar in varchar(255) Angabe in Shop-Hauptsprache
Lagerverhalten enum('immer_bestellbar’,'nachbestellbar’,'nicht_nachbestellen’) -> uneingeschränkt verfügbar-> nachbestellbar-> wird nicht nachbestellt
Anzahl Einheit varchar(255) z.B. Stück
Anzahl Nachkommastellen int(11) 0 -> Bestellmenge ganzzahlig1 -> Bestellmenge x.x2 -> Bestellmenge x.xx
Anzahl Anzeige enum('Dropdown’,'Eingabefeld’) -> Auswahl Anzahl als Dropdown-> Angabe Anzahl in Textfeld
Anzahl Dropdownwerte varchar(255) Spezialaufbereitung! (z.B. 1-10;20;50;100)
Liefereinheit double Artikel können nur in diesen Mengen bestellt werden. Bsp: 20 => 20,40,60,80 und nicht 21, ..
Gruppierung varchar(255) Gruppierung in der virtuellen dritten Kategorienstufe
Gruppierung-opt varchar(255) Gruppierung als Optionsartikel
Staffelpreis ab 1 double Ab Menge für erste Preisstaffel
Staffelpreis 1 double Preis/Einheit erste Preisstaffel
Staffelpreis ab 2..n double Ab Menge für n-te Preisstaffel
Staffelpreis 2..n double Preis/Einheit n-te Preisstaffel
Zusatzfeld 1 varchar(255) frei verwendbare Zusatzfelder
Zusatzfeld 2..10 varchar(255) frei verwendbare Zusatzfelder
Interne Notizen text
Kategorie-Nr varchar(255) externe Kategorien-Nr (vom ERP) fuer Zuordnung Art -> Kat, Kommagetrennt, falls mehrere Kat pro Artikel.
Promotion enum(‘true’, ‘false’) Promotions-Steuerung
Suchpriorisierung int(11) Kleiner Wert = hohe Priorität
Dateiname-virtuell varchar(255) virtueller Dateiname für Suchmaschinen
Parentartikel-Nr varchar(255) Artikel-Nr. des Parent-Artikels,leer bei Haupt-Artikeln
Gruppierung-parent varchar(255) Gruppierung als Subartikel
Artikel Position int(11) Position des Artikels innerhalb der Kategorie oder des Parent-Artikels (kleinster Wert zu oberst)
Position Opt int(11) Position des Artikels als Optionsartikel
Artikelrabattgruppe varchar(255) Rabattgruppe des Artikels
Hersteller-Artikel-Nr varchar(255) Artikel-Nr vom Hersteller[2]
Artikel-Code varchar(255) normierter Code (z.B. EAN/ISBN) [2]
Hersteller-Nr varchar(255) Hersteller-Nr gemäss set_hersteller [2]
Grundpreis Einheit z.B. 1kg/100g/1m
Grundpreis Faktor Multiplikator Grundpreis Einheit/Gewicht
Kontierungsgruppe-Nr varchar(255) externe Kontierungsgruppe-Nr [7]
E-Content Bezugszeit int(11) Zeitfenster zum Download in Sekunden [6]
E-Content Downloads int(11) maximale Anzahl Downloads pro Kauf [6]
E-Content Datei varchar(255) Download-Datei [6]
Fremdsprachen-Spalten..
fr_Name varchar(255) sprachabhängige Artikelattribute(optional). Der Spaltenname ist immer aus dem Sprach-Prefix (z.B. ‘fr_') und dem Original-Spaltennamen zusammengebaut.
fr_Beschreibung text
fr_Kurzbeschreibung Kurzbeschreibung
fr_Artikeldetails Artikeldetails
fr_Gruppierung varchar(255)
fr_Gruppierung-opt varchar(255)
fr_Gruppierung-parent varchar(255)
fr_Dateiname-virtuell varchar(255)
Spezial-Spalten..
Artikeldetails text nicht verwendeter Zusatztext
Masterartikel enum(‘true’, ‘false’) Master-Slave-Steuerung für Shop-Synchronisation
Zusatfeld_text varchar(255) Shopintern für Texteingabefelder
Zusatzfeld_param varchar(255) Shopintern für Texteingabefelder
Zusatzfeld_titel varchar(255) Shopintern für Texteingabefelder
Haendlerpreis varchar(255) nicht verwendetes Zusatzfeld
Lager {Lagernummer} Int(11) Neuer Lagerbestand bei Multilager

get_article

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_artikel
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_artikel_out.csv Shop ERP Exportdatei im CSV-Format
get_artikel_err.csv Shop ERP Statusdatei Fehler
get_artikel_tmp.csv Shop Shop Temporäre Ausgabedatei

Structure export file like ‘set_artikel’.

get_article_ab

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_artikel_ab&datetime_ab=argument1
Argumente: argument1 Zeitpunkt (yyyy-mm-dd hh:mm:ss), ab dem die Daten exportiert werden
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_artikel_ab_out.csv Shop ERP Exportdatei im CSV-Format
get_artikel_ab_err.csv Shop ERP Statusdatei Fehler
get_artikel_ab_tmp.csv Shop Shop Temporäre Ausgabedatei

Structure export file like ‘set_artikel’.

set_article_incremental

When importing ‘set_artikel_inkrementell’, articles that are not contained in the import file are not deleted after a successful import. are not deleted after a successful import. This also means that only a few attributes of some articles can be updated. It is not possible to assign articles to categories.

Aufruf
Aufruf HTTP https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_artikel_inkrementell
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_artikel_inkrementell_inp.csv ERP Shop Importdatei im CSV-Format
set_artikel_inkrementell_ok.csv Shop ERP Statusdatei Erfolg
set_artikel_inkrementell_err.csv Shop ERP Statusdatei Fehler
set_artikel_inkrementell_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Artikel-Nr varchar(255) [1]
Name varchar(255)
..beliebige weitere Spalten gemäss Definition ‘set_artikel’ (ohne Kategorie-Nr und Hersteller-Nr)

Categories

set_categories

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_kategorien
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_kategorien_inp.csv ERP Shop Importdatei im CSV-Format
set_kategorien_ok.csv Shop ERP Statusdatei Erfolg
set_kategorien_err.csv Shop ERP Statusdatei Fehler
set_kategorien_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Kategorie-Nr varchar(255) Kategorie-ID von ERP[1]
Parentkategorie-Nr varchar(255) Parent-Kategorie-ID von ERP[1]
Position int(11) Position der Kategorie im Baum
Name varchar(255) Name der Kategorie[1]
Beschreibung text Kategorienbeschreibung
Beschreibung anzeigen enum(‘true’,‘false’) Kat-Beschreibung ein/ausschalten
MwSt-Satz double
Kategorie anzeigen enum(‘true’,‘false’) Sichtbarkeit der Kategorie
Promotionskategorie enum(‘true’,‘false’) Kat. enthält Promotionsangebote
Aktionskategorie enum(‘true’,‘false’) Kat. enthält Aktionsangebote
Tab Text varchar(255) Kategorienüberschrift (im Baum)
Bild gross varchar(255) Kategorienbild
Sprache varchar(255) Sprache der Kategorie (de,en,..)Falls Zuweisung an mehrere Sprachen, Komma getrennt
Zusatzfeld 1 varchar(255) frei verwendbare Zusatzfelder
Zusatzfeld 2..5 varchar(255) frei verwendbare Zusatzfelder
Dateiname-virtuell varchar(255) virtueller Dateiname für Suchmaschinen
Metatitel varchar(255) Seitentitel für Suchmaschinen
Metabeschreibung varchar(255) Beschreibung für Suchmaschinen
fr_Name varchar(255) sprachabhängige Kategorienattribute (optional). Der Spaltenname ist immer aus dem Sprach-Prefix (z.B. ‘fr_') und dem Original-Spaltennamen zusammengebaut.
fr_Beschreibung text
fr_Tab Text varchar(255)
fr_Dateiname-virtuell varchar(255)
fr_Metatitel varchar(255)
fr_Metabeschreibung varchar(255)

get_categories

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_kategorien
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_kategorien_out.csv Shop ERP Exportdatei im CSV-Format
get_kategorien_err.csv Shop ERP Statusdatei Fehler
get_kategorien_tmp.csv Shop Shop Temporäre Ausgabedatei

Structure export file like ‘set_categories’.

Customers

get_customers

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_kunden
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_kunden_out.csv Shop ERP Exportdatei im CSV-Format
get_kunden_err.csv Shop ERP Statusdatei Fehler
get_kunden_tmp.csv Shop Shop Temporäre Ausgabedatei
CSV-Spaltenname Datentyp Bemerkungen
Kunden-Nr varchar(255) Wird in ERP gesetzt[1]
Kunden-ID varchar(255) Shop interne ID (optional)
Login varchar(255)
Passwort varchar(255)
Anrede varchar(24)
Vorname varchar(128)
Nachname varchar(128)
Firma varchar(128)
Firma-UID varchar(64)
Firma-MWST-Nr varchar(64)
EORI-Nr Varchar(64)
Abteilung varchar(128)
Strasse varchar(128)
Hausnummer varchar(128)
Hausnummer-Erweiterung varchar(255)
Postfach varchar(16)
PLZ varchar(32)
Ort varchar(128)
Staat varchar(255) Staat/Bundesland/Kanton
Land varchar(128)
Telefon varchar(32)
Fax varchar(32)
Handy varchar(32)
E-Mail varchar(128)
Geburtsdatum date(jjjj-mm-dd)
SSN varchar(255) Sozialversicherungsnummer/AHV-Nr
Anmeldedatum date(jjjj-mm-dd)
letzte Bestellung date(jjjj-mm-dd)
Beschreibung text für Kunde nicht einsehbar
Kontoinhaber varchar(128) Kontodaten Banklastschrift
Bankname varchar(128)
BLZ varchar(128)
Kontonummer varchar(128)
IBAN varchar(128)
BIC varchar(128)
Rechnungslieferung enum(‘true’,‘false’) Steuerung Rechnungslieferung
gesperrt enum(‘true’,‘false’) Sperrung des Kunden
Kundengruppe int(11) nummerische Kundengruppe
Sprache varchar(2) ISO-639-1 Code, z.B. de
Debitorennummer varchar(255)
Debitorenpreisgruppe varchar(255)
Debitorenrabattgruppe varchar(255)

get_customers_off

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_kunden_ab&datetime_ab=argument1
Argumente: argument1 Zeitpunkt (yyyy-mm-dd hh:mm:ss), ab dem die Daten exportiert werden
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_kunden_ab_out.csv Shop ERP Exportdatei im CSV-Format
get_kunden_ab_err.csv Shop ERP Statusdatei Fehler
get_kunden_ab_tmp.csv Shop Shop Temporäre Ausgabedatei

Structure export file like ‘get_kunden’.

set_customers

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_kunden
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_kunden_inp.csv ERP Shop Importdatei im CSV-Format
set_kunden_ok.csv Shop ERP Statusdatei Erfolg
set_kunden_err.csv Shop ERP Statusdatei Fehler
set_kunden_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP

Structure import file like ‘get_kunden’.

Deliver customer passwords to the shop

The customer password is delivered to the shop in plain text. Each data record is recognised during import, whether a plain text password or a password hash was supplied. Plain text passwords are used to a secure hash is created by the shop and stored in the web shop. If an empty string is supplied to the shop as a password, the shop leaves the existing password is retained. This means that password updates can be sent from the ERP to the shop by Only passwords that have been changed by the ERP are sent in the import.

set_customers_associate

This import can be used to combine two customer data records into one (duplicate cleansing). The customer with the customer no. ‘Customer no.’ is deleted, all his orders are assigned to the customer with the customer no. ‘Target customer no.’.

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_kunden_vereinen
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_kunden_vereinen_inp.csv ERP Shop Importdatei im CSV-Format
set_kunden_vereinen_ok.csv Shop ERP Statusdatei Erfolg
set_kunden_vereinen_err.csv Shop ERP Statusdatei Fehler
set_kunden_vereinen_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Kunden-Nr varchar(255) Kunden-Nr die ueberfuehrt wird..
Ziel-Kunden-Nr varchar(255) ..zu dieser Kunden-Nr

Delivery addresses

set_delivery_addresses

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_lieferadressen
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_lieferadressen_inp.csv ERP Shop Importdatei im CSV-Format
set_lieferadressen_ok.csv Shop ERP Statusdatei Erfolg
set_lieferadressen_err.csv Shop ERP Statusdatei Fehler
set_lieferadressen_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Kunden-Nr varchar(255) Wird in ERP gesetzt[1]
Adress-Nr varchar(255) eindeutige Adress-Nr[1]
Anrede varchar(24)
Vorname varchar(128)
Nachname varchar(128)
Firma varchar(128)
Firma-UID varchar(64)
Firma-MWST-Nr varchar(64)
Abteilung varchar(128)
Strasse varchar(128)
Hausnummer varchar(128)
Postfach varchar(16)
PLZ varchar(32)
Ort varchar(128)
Land varchar(128)
Telefon varchar(32)
Fax varchar(32)
Handy varchar(32)
E-Mail varchar(128)

Option article

set_optionsarticle

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_optionsartikel
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_optionsartikel_inp.csv ERP Shop Importdatei im CSV-Format
set_optionsartikel_ok.csv Shop ERP Statusdatei Erfolg
set_optionsartikel_err.csv Shop ERP Statusdatei Fehler
set_optionsartikel_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Artikel-Nr varchar(255) Artikel-Nr[1]
Optionsartikel-Nr varchar(255) Artikel-Nr vom Optionsartikel[1]

Delivery status

set_delivery_status

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_lieferstatus
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_lieferstatus_inp.csv ERP Shop Importdatei im CSV-Format
set_lieferstatus_ok.csv Shop ERP Statusdatei Erfolg
set_lieferstatus_err.csv Shop ERP Statusdatei Fehler
set_lieferstatus_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Rechnungs-Nr varchar(255) Rechnungs-Nummer vom Shop[1]
Bestellung-Status char(4) Bestellungsstatus vierstellig0001 -> offen0002 -> eingegangen0010 -> in Bearbeitung0020 -> versendet0030 -> abgeschl., nicht bezahlt0040 -> abgeschlossen
Tracking-ID int(11) Tracking-ID des Versandunternehmens
Tracking-Nr varchar(255) Tracking-Nr der Sendung
Versanddatum date(jjjj-mm-dd) Versanddatum der Sendung
Teillieferung enum(‘true’,‘false’) Teillieferung
Auftrags-Nr varchar(255) externe Auftrags-Nummer vom ERP
Zusatzinfo text Zusatzinformationen für Kunden
bezahlt enum(‘true’,‘false’) Bestellung bezahlt

Manufacturer

set_manufacturer [2]

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_hersteller
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_hersteller_inp.csv ERP Shop Importdatei im CSV-Format
set_hersteller_ok.csv Shop ERP Statusdatei Erfolg
set_hersteller_err.csv Shop ERP Statusdatei Fehler
set_hersteller_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Hersteller-Nr varchar(255) Hersteller-Nr von ERP
Name varchar(255) Name des Herstellers
Beschreibung text Herstellerbeschreibung
Link varchar(255) Link zum Hersteller
Bild varchar(255) Dateiname Hersteller-Logo
Adresse varchar(300) Hersteller GmbH, Strasse 123, 1234 Ort, Schweiz
Importeur varchar(255) Importer GmbH, Strasse 123, 1234 Ort, Schweiz
Kontakt varchar(255) Kontaktadresse Produktsicherheit (GPSR) von EU-Importeur oder EU-Hersteller: E-Mail oder Webseite
Zusatzfeld 1 varchar(255) frei verwendbares Zusatzfeld 1
Zusatzfeld 2 varchar(255) frei verwendbares Zusatzfeld 2
Zusatzfeld 3 varchar(255) frei verwendbares Zusatzfeld 3

get_manufacturer [2]

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_hersteller
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_hersteller_out.csv Shop ERP Exportdatei im CSV-Format
get_hersteller_err.csv Shop ERP Statusdatei Fehler
get_hersteller_tmp.csv Shop Shop Temporäre Ausgabedatei

Structure export file like ‘set_manufacturer’.

Vouchers

set_vouchers [3]

This import enables the creation of vouchers in the shop. The ‘Discount type’ column is used to whether the price event is for a fixed amount or whether a percentage discount is granted on the item total.

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_gutscheine
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_gutscheine_inp.csv ERP Shop Importdatei im CSV-Format
set_gutscheine_ok.csv Shop ERP Statusdatei Erfolg
set_gutscheine_err.csv Shop ERP Statusdatei Fehler
set_gutscheine_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Kampagne varchar(255) Kampagnen-Name
Gutscheincode varchar(255) Gutschein-Code
Betrag double Gutschein-Betrag oder Prozent
Rabatttyp enum(‘Betrag’,‘Prozent’) Definition Rabatt-Typ
Mindesteinkauf double Einlösbar ab Betrag
Artikel-Nr varchar(255) Einschränkung des Gutscheins aufnur einen Artikel (optional).
Gueltig bis date(jjjj-mm-dd) Verfalldatum
Anzahl Einloesungen int(11) Maximale Anzahl Einlösungen
Typ enum(‘promotion’,‘gutschrift’) promotion: Preisreduktiongutschrift: Kundenguthaben

get_vouchers [3]

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_gutscheine
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_gutscheine_out.csv Shop ERP Exportdatei im CSV-Format
get_gutscheine_err.csv Shop ERP Statusdatei Fehler
get_gutscheine_tmp.csv Shop Shop Temporäre Ausgabedatei

Structure export file like ‘set_gutscheine’.

Customer credit (credits)

set_credits [4]

Set customer credit (requires ‘Credits’ module).

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_credits
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_credits_inp.csv ERP Shop Importdatei im CSV-Format
set_credits_ok.csv Shop ERP Statusdatei Erfolg
set_credits_err.csv Shop ERP Statusdatei Fehler
set_credits_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Kunden-Nr varchar(255) Kundennummer
Betrag double Kunden-Guthaben

get_credits [4]

Read out customer credit (requires ‘Credits’ module).

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_credits
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_credits_ab_out.csv Shop ERP Exportdatei im CSV-Format
get_credits_ab_err.csv Shop ERP Statusdatei Fehler
get_credits_ab_tmp.csv Shop Shop Temporäre Ausgabedatei

Structure export file like ‘set_credits’.

Pricing/debtor prices

set_debitor_prices [5]

Aufruf
Aufruf CLI: php call_peppershop.php set_debitorenpreise
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_debitorenpreise
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_debitorenpreise_inp.csv ERP Shop Importdatei im CSV-Format
set_debitorenpreise_ok.csv Shop ERP Statusdatei Erfolg
set_debitorenpreise_err.csv Shop ERP Statusdatei Fehler
set_debitorenpreise_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Verkaufsart enum(‘Debitor’,‘Debitorenpreisgruppe’,‘Alle Debitoren’ [1]
Verkaufscode varchar(255) Debitorennummer bei Verkaufsart 'Debitor'Debitorenpreisgruppe bei Verkaufsart ‘Debitorenpreisg-ruppe’[1]
Artikel-Nr varchar(255) [1]
Waehrung char(3) chf,usd,eur,..[1]
Mindestbestellmenge double
Preis double [1]
Aktiv von datetime(jjjj-mm-tt hh:mm:ss) ..oder date(jjjj-mm-tt)
Aktiv bis datetime(jjjj-mm-tt hh:mm:ss) ..oder date(jjjj-mm-tt)
Zeilenrabatt erlaubt enum(‘true’, ‘false’)

set_line_discounts [5]

Aufruf
Aufruf CLI: php call_peppershop.php set_zeilenrabatte
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_zeilenrabatte
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_zeilenrabatte_inp.csv ERP Shop Importdatei im CSV-Format
set_zeilenrabatte_ok.csv Shop ERP Statusdatei Erfolg
set_zeilenrabatte_err.csv Shop ERP Statusdatei Fehler
set_zeilenrabatte_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Verkaufsart enum(‘Debitor’,‘Debitorenrabattgruppe’,‘Alle Debitoren’) [1]
Verkaufscode varchar(255) Debitorennummer bei Verkaufsart 'Debitor'Debitorenrabattgruppe bei Verkaufsart ‘Debitorenrabatt-gruppe’ [1]
Art enum(‘Artikel’,‘Artikelrabattgruppe’) [1]
Code varchar(255) Artikel-Nr bei Art ‘Artikel'Artikelrabattgruppe bei Art 'Artikelrabattgruppe’[1]
Waehrung char(3) Währungs-Code chf,eur,usd,..leer für Rabatte unabhaengig vonder Währung [1]
Mindestbestellmenge double
Zeilenrabatt double Rabatt in % (0 bis 100)
Aktiv von datetime(jjjj-mm-tt hh:mm:ss) ..oder date(jjjj-mm-tt)
Aktiv bis datetime(jjjj-mm-tt hh:mm:ss) ..oder date(jjjj-mm-tt)
Rabattyp varchar(255) frei verwendbar

Account assignment groups for articles (account assignment groups)

set_assignment_groups [7]

Set account assignment groups for articles (requires module ‘Account assignment’).

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_kontierungsgruppen
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_kontierungsgruppen_inp.csv ERP Shop Importdatei im CSV-Format
set_kontierungsgruppen_ok.csv Shop ERP Statusdatei Erfolg
set_kontierungsgruppen_err.csv Shop ERP Statusdatei Fehler
set_kontierungsgruppen_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Kontierungsgruppe-Nr varchar(255) Kontierungsgruppe-Nr [1]
Kontierungsgruppe double Name der Kontierungsgruppe

get_assignment_groups [7]

Read out account assignment groups (requires module ‘account assignment groups’).

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_kontierungsgruppen
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_kontierungsgruppen_out.csv Shop ERP Exportdatei im CSV-Format
get_kontierungsgruppen_err.csv Shop ERP Statusdatei Fehler
get_kontierungsgruppen_tmp.csv Shop Shop Temporäre Ausgabedatei

Structure export file like ‘set_accounting_groups’.

Serial numbers/warranty expiry

set_serial_numbers [8]

Set serial numbers and warranty expiry date for sold items (requires ‘Serial numbers’ module).

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_seriennummern
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_seriennummern_inp.csv ERP Shop Importdatei im CSV-Format
set_seriennummern_ok.csv Shop ERP Statusdatei Erfolg
set_seriennummern_err.csv Shop ERP Statusdatei Fehler
set_seriennummern_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Artikel-Nr varchar(255) Artikel-Nr [1]
Bestell-Nr varchar(255) Rechnungs-Nummer der Bestellung
Seriennummer varchar(255) Seriennummer des Geräts
Garantieende date(jjjj-mm-dd) Datum Garantieablauf

Warehouse

set_warehouse [9]

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_lager
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_lager_inp.csv ERP Shop Importdatei im CSV-Format
set_lager_ok.csv Shop ERP Statusdatei Erfolg
set_lager_err.csv Shop ERP Statusdatei Fehler
set_lager_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Lagernummer varchar(255) Lagernummer des Multilagers
Artikel-Nr varchar(255) Artikelnummer
Anzahl int(11) Anzahl des Artikels

get_warehouse [9]

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_lager
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_lager_out.csv Shop ERP Importdatei im CSV-Format
get_lager_err.csv Shop ERP Statusdatei Erfolg
get_lager_tmp.csv Shop Shop Statusdatei Fehler

Payments

get_payments

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=get_zahlungen
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
get_zahlungen_out.csv Shop ERP Exportdatei im CSV-Format
get_zahlungen_err.csv Shop ERP Statusdatei Fehler
get_lager_tmp.csv Shop Shop Temporäre Ausgabedatei
CSV-Spaltenname Datentyp Bemerkungen
UUID varchar(36) Zahlungs-UUID
Rechnungs-Nr varchar(255) Rechnungs-Nr der Bestellung
Source enum(‘POS’, ‘SHOP’) Zahlungsursprung
Zahlungsart varchar(255) Zahlungsart, Bsp: VISA, Vorauskasse
Bezahlung erhalten datetime(jjjj-mm-tt hh:mm:ss) ..oder date(jjjj-mm-tt)
Bezahlung bestaetigt datetime(jjjj-mm-tt hh:mm:ss) ..oder date(jjjj-mm-tt)
Betrag double Betrag der Zahlung
Waehrung varchar(16) Währung der Zahlung
Waehrung Umrechnungsfaktor double Umrechnungsfaktor der Währung
Waehrung Rundungsfaktor double Rundungsfaktor der Waehrung
Erstellungszeit datetime(jjjj-mm-tt hh:mm:ss) ..oder date(jjjj-mm-tt)
Zahlungsversuchbeginn datetime(jjjj-mm-tt hh:mm:ss) ..oder date(jjjj-mm-tt)
Zahlungsende datetime(jjjj-mm-tt hh:mm:ss) ..oder date(jjjj-mm-tt)
Erfolg enum(‘Y’, ‘N’) Erfolgsstatus
Art enum(‘BUY’, ‘CREDIT’, ‘REFUND’, ‘PARTIAL_PAYMENT’) Art der Zahlung. Es gibt maximal eine Teilzahlung die immer barzahlung_kasse als Zahlungsart hat
PSP-Provider varchar(255) Provider, Bsp: saferpay_json
PSP-Transaction-ID varchar(255) Transaction-ID des Providers
PSP-Token varchar(255) Token des Providers
PSP Clearing Extra text Zusatztext des PSP

Article features

In order for an article characteristic to be imported, the corresponding characteristic definition must first be created. This defines the data type (number, text, date, binary value) and the localisation for the characteristic. If a characteristic is localised, the characteristic is supplied for each language used in the shop (e.g. black, noir, black). Non-localised values are only supplied once for each item (e.g. 6 for a printer that prints 6 pages per minute). The common key between the characteristics and the characteristic definition are the two values ‘Group’ and ‘Label’. As of version 9.0 build 67, the mysql ‘LOCK TABLES’ privilege is required (if your shop is hosted by Glarotech, this is already taken into account).

set_definitions_features_article

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_definitionen_merkmale_artikel
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_definitionen_merkmale_artikel_inp.csv ERP Shop Importdatei im CSV-Format
set_definitionen_merkmale_artikel_ok.csv Shop ERP Statusdatei Erfolg
set_definitionen_merkmale_artikel_err.csv Shop ERP Statusdatei Fehler
set_definitionen_merkmale_artikel_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Gruppe varchar(128) Merkmal-Gruppe (z.B. Papier)[1]
Label varchar(128) Merkmal Label[1]
Label Darstellung varchar(255) Label für Darstellung im Shop
Datentyp enum(‘boolean’,‘int’,‘float’,‘varchar’,‘text’,‘timestamp’) Merkmal-Datentyp [1]boolean -> true/falseint -> Ganzzahlfloat -> Fliesskommazahlvarchar -> Text bis 255 Zeichentext -> Text > 255 Zeichentimestamp-> yyyy-mm-dd hh:mm:ss
lokalisiert enum(‘true’, ‘false’) Steuerung Mehrsprachigkeit [1]
Position int(11) Positionsnummer
Kundenzugriff enum(‘read’,‘write’,‘none’) Sichtbarkeit für die Kunden [2]read -> nur Lesen (standard)none -> Kein Zugriffwrite -> Lesen und Schreiben
kundenseitig darstellen enum(‘true’, ‘false’) Merkmal Kundenseitig darstellen
Gruppe Darstellung varchar(255) Merkmal Gruppen darstellen
suchbar enum(‘true’, ‘false’) Nach Merkmal suchbar
varianteneigenschaft enum(‘true’, ‘false’) Benötigt bei den Multivarianten. Hat Artikel eine Eigenschaft für die Varianten
Nummer varchar(255) Merkmalnummer

Languages

For the respective languages e.g. ‘en_Group representation’ or ‘fr_Label representation’

Example import set_definitions_characteristics_article_inp.csv

Gruppe Label Label Darstellung Datentyp lokalisiert Position Kundenzugriff
Papier Farbe Papierfarbe varchar true 1 read
Drucker Duplex Duplexdruck boolean false 2 read

set_features_article

Aufruf
Aufruf HTTP: https://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_merkmale_artikel
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_merkmale_artikel_inp.csv ERP Shop Importdatei im CSV-Format
set_merkmale_artikel_ok.csv Shop ERP Statusdatei Erfolg
set_merkmale_artikel_err.csv Shop ERP Statusdatei Fehler
set_merkmale_artikel_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Artikel-Nr varchar(255) [1]
Gruppe varchar(128) Merkmal-Gruppe (z.B. Papier)[1]
Label varchar(128) Merkmal Label[1]
Wert varchar(255) Merkmal Inhalt[1]
Sprache char(2) Sprache des Merkmal-Werts
Referenz varchar(255) Frei verwendbare Referenzangabe
Merkmal Sprachgruppe-Nr varchar(255) Definiert welche lokalisierten Merkmale zusammen gehören

Example import set_characteristics_article.csv

Artikel-Nr Gruppe Label Wert Sprache
1001 Papier Farbe rot de
1001 Papier Farbe red en
1002 Drucker Duplex true
1003 Drucker Duplex false

Additions/explanations

  • The language column can be left empty for language-independent features
  • Deliver features with binary values ‘true/false’
  • Localisation (translation) feature definitions
  • The feature definitions are localised directly in the shop via localetext.inc.php.
  • Key column for the feature label: Label representation
  • Lead column for the feature group: Group
  • Localisation (translation) features:
  • The feature values are delivered localised.

Article Documents

This import is used to assign files (downloads) to articles. Linked files can be located on the file system of the shop server or on an external web server. An additional designation (label) can be optionally specified. Locally stored files must be located in the directory /shop/resources/downloads/ or any subdirectory thereof. The path information refers to this directory so that so that only the file name needs to be specified for files located directly in this directory.

set_article_documents

Aufruf
Aufruf HTTP: http://www.shopdomain.tld/shop/Admin/caller/caller_aufruf.php?do=set_artikel_dokumente
Argumente: keine
Austauschdateien
Dateiname erstellt löscht Bemerkung
set_artikel_dokumente_inp.csv ERP Shop Importdatei im CSV-Format
set_artikel_dokumente_ok.csv Shop ERP Statusdatei Erfolg
set_artikel_dokumente_err.csv Shop ERP Statusdatei Fehler
set_artikel_dokumente_tmp.csv Shop Shop Temporäre Importdatei fuer den Shop
? ERP ERP Temporäre Upload-Datei fuer ERP
CSV-Spaltenname Datentyp Bemerkungen
Artikel-Nr varchar(255) [1]
Gruppe varchar(128) Download-Gruppe(z.B. Manual)[1]
Label varchar(128) Label für Darstellung [2]
Datei varchar(255) Verlinkte Datei [1]file.pdffolder/sub/file.pdfhttp://www.host.tld/file.pdf
Sprache char(2) Sprache des Merkmal-Werts [2]

Examples

Artikel-Nr Gruppe Label Datei Sprache
1001 Manual Kurzanleitung kurzanleitung.pdf
1001 Manual anleitung.pdf
1001 Broschüre https://www... de

Restrictions/special requirements

  • 1] Mandatory column, this data column must be delivered with the import!
  • [2] Requires the module ‘Manufacturer information on the article’
  • 3] Requires the ‘Vouchers’ module
  • 4] Requires the ‘Credits’ module
  • [5] Requires the ‘Accounts receivable pricing’ module
  • [6] Requires the ‘E-Content’ module
  • 7] Requires the ‘Account assignment’ module
  • 8] Requires the ‘Serial numbers’ module
  • [9] Requires the ‘Multi-warehouse’ module
  • [10] Mandatory column, this data column must be supplied with the import!
  • [11] Optional specification

Version History

Documentation of the adjustments in this document.

Vers Datum Autor Methode Änderung
7.0.0 18.03.2019 gla set_/get_artikel Angabe ‘Lieferbar in’ in Shop-Hauptsprache
7.0.0 15.04.2019 hya set_/get_artikel Lager {Lagernummer} Feld wurde entfernt, siehe neue Im-/Exporte: set_/get_lager
8.0.0 11.03.2020 rbl set_/get_kunden Geburtsdatum, Anmeldedatum und Letzte Bestellung im Format jjjj-mm-tt hh:mm:ss
8.0.0 11.03.2020 fjo set_/get_artikel Liefereinheit hinzugefügt

Further help

Do you need further support? PepperShop provides you with various options.

  • It often helps to click on the question mark icon in the top right-hand corner of the administration. Here you can get direct help on the topic in question.
  • Various answers can be found in the FAQ. These can also be accessed in the shop administration via Help&News -> Help archive. Or via our homepage https://www.peppershop.com/de/services/support/faq/
  • In the PepperShop Academy https://www.peppershop.com/de/services/academy/ you can easily and conveniently find various free video tutorials.
  • We are also happy to help you by e-mail or telephone (CHF 195./h) support@glarotech.ch or +41 71 923 08 58
🌶️
🔥
🌶️