Caller Datenaustausch API

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.

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

get_orders_from

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

get_artikel

Structure export file like ‘set_artikel’.

get_article_ab

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.

Categories

set_categories

get_categories

Structure export file like ‘set_categories’.

Customers

get_customers

get_customers_off

Structure export file like ‘get_kunden’.

set_customers

Structure import file like ‘get_kunden’.

Deliver customer passwords to the shop

The customer password is delivered to the shop in plain text. During import, each data record is recognised, 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.’.

Delivery addresses

set_delivery_addresses

Option article

set_optionsarticle

Delivery status

set_delivery_status

Manufacturer

set_manufacturer [2]

get_manufacturer [2]

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. percentage discount is granted on the item total.

get_vouchers [3]

Structure export file like ‘set_gutscheine’.

Customer credit (credits)

set_credits [4]

Set customer credit (requires ‘Credits’ module).

get_credits [4]

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

Structure export file like ‘set_credits’.

Pricing/debtor prices

set_debitorprices [5]

set_linediscounts [5]

Account assignment groups for articles (account assignment groups)

set_assignmentgroups [7]

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

get_assignmentgroups [7]

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

Structure export file like ‘set_accounting_groups’.

Serial numbers/warranty expiry

set_serialnumbers [8]

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

Warehouse

set_warehouse [9]

get_warehouse [9]

Payments

get_payments

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 article (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

Languages

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

Example import set_definitions_characteristics_article_inp.csv

set_features_article

Example import set_characteristics_article.csv

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. 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

Examples

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.

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 185./h) support@glarotech.ch or +41 71 923 08 58