Diesen Artikel auf Deutsch lesen
In this article you will learn everything about using Komfortkasse with Shopware (version 6).
Read the article Getting started: Setting up and connecting to the shop beforehand.
Setting up the Shopware 6 API
An integration must be created under Settings - System - Integrations in order for Komfortkasse to access the Shopware shop:
You can name the integration "komfortkasse", for example. Activate the write permissions with the Write checkbox (in newer versions of Shopware, activate the Administrator access instead of the Write checkbox).
More information on required roles/permissionsWe recommend using administrator rights for the integration. If a custom role is used, at least the following permissions (in earlier versions: privileges) are required:
|
Save the integration with the Save integration button.
Specify the Access ID and the Security Key in the Shop settings in your Komfortkasse merchant area. To do this, select the shop in the Settings - Shops menu. Click on Edit settings in the API access settings area and then enter the data:
Then click Save settings.
As soon as the API credentials have been saved, Komfortkasse can read out other required settings from the shop, e.g. existing Payment codes, Sales Channels and Order status. While the data is being read out, the ID or technical name of the corresponding entry is displayed (e.g. "open"). You may also see a corresponding display next to the respective field:
API settings
If the data has been successfully read, the correct names (e.g. "Open") are displayed instead of the IDs:
Komfortkasse supports the payment codes Prepayment, Invoice, and Cash on delivery. If you do not use all three payment codes in your shop, click on deactivate or activate for the respective payment code:
Once the desired Payment codes have been activated, click Edit settings again. You can then make the settings for Payment codes, Sales Channels and Status.
For all settings that use data from the shop, you can use the Refresh data button to re-read the data from the shop (e.g. if a new Payment codes has been added to the shop).
Sales Channels
If only one Sales Channels is available (or if all existing Sales Channels are to be used in Komfortkasse), then no selection needs to be made here.
Otherwise, the desired Sales Channels can be selected here:
If Sales Channels represent different shops (i.e. with their own URL, name or logo, for example), then one shop must be created per Sales Channel in Komfortkasse. The assigned Sales Channels must then be selected here for each shop.
The following settings are described using prepayment as an example. The settings for invoice and Cash on delivery are similar, the differences to prepayment are described at the end. Even if you only use invoice payment in your online shop, you should read the following descriptions.
Payment codes ID
Here you can select which Shopware payment codes should be used for "Prepayment" in Komfortkasse. Normally this is the default payment codes "Bank transfer / prepayment" in Shopware:
Order status and Payment status for Open orders
Here you can select which orders Komfortkasse considers "open" and expects payments for. Either the order status, the Payment status or both statuses can be specified. (If, for example, only the order status is specified, the Payment status is ignored)
The order status "Open" and/or the Payment status "Open" is usually specified for prepayment. Other statuses may also be useful, e.g. "Reminded":
Payment status for partially paid orders
Orders for which a partial payment is received are set to this Payment status in Shopware by Komfortkasse. (No order status can be selected):
Order status and Payment status for paid orders
Orders that have been completely paid in Komfortkasse are set to this status in Shopware by Komfortkasse. An Order status and/or a Payment status can be selected. If, for example, only the Payment status is to be changed but the Order status is not to be changed, "Do not change" is selected for the Order status:
Order status and Payment status for orders cancelled
If an order is cancelled in Komfortkasse (e.g. because no payments have been received over a long period), this status is set in Shopware. An Order status and/or a Payment status can be selected. If, for example, only the Payment status is to be changed but the Order status is not to be changed, "Do not change" is selected for the Order status:
Order status and Payment status for refunded orders
If a refund is executed for an order in Komfortkasse, this status can be set in Shopware. An Order status and/or a Payment status can be selected. If, for example, only the Payment status is to be changed but the Order status is not to be changed, "Do not change" is selected for the Order status:
Payment status for Dunning level 1, 2, 3,...
If Komfortkasse sends Pre-collection letters (payment reminders) for an order, the Payment status can be set in Shopware. These settings are optional.
Payment status for Debt collection
If the integrated Debt collection in Komfortkasse is used and an order has been transferred for collection, the following Payment status is set in Shopware.
(Debt collection for orders with Payment codes prepayment is normally not possible, but there are exceptional cases where this may be the case)
Payment methods for monitoring
If the monitoring of other payment codes is used (optional), the payment codes to be monitored are selected here.
Settings for invoice payment
The same settings are available for invoice payment as for prepayment, with one difference: if no payment is received for an order, it is not cancelled but marked as overdue. This is technically the same process, but in practice it usually triggers other follow-up processes: While a prepayment order without payment can simply be cancelled, an overdue order with invoice payment usually has to be reprocessed manually or passed on to Debt collection, for example.
Settings for Cash on delivery
The same settings are available for Last name as for invoice, with the following restrictions:
- Pre-collection letters are not available
- Debt collection is not available
Settings for documents
Komfortkasse automatically processes documents such as invoices and Credit Notes from Shopware. Invoice numbers, for example, are transferred from invoices.
Document types or user-defined fields from Shopware can be specified separately:
Import tracking code
If yes, the tracking code is transferred to Komfortkasse as the shipment number (delivery note number). This is useful, for example, when processing Cash on delivery payments.
Connecting the connection
Once all settings for the API have been fully specified, the shop can be connected to Komfortkasse. To do this, select the actions menu ≡ Connect.