Shopware API / WebServices

Connect Shopware with Qapla’

To connect Shopware with Qapla’, follow the steps described below.

1. Obtain the credentials

You will need the following credentials for the connection:

  • Client ID

  • Client Secret

2. Enter the data in Qapla’

Go to Settings > Channels > [Channel Name] > Configure > E-Commerce, select the platform, and enter the previously obtained keys.

After entering them, click “Save and run test.”

3. Activate order import

To activate order import, go to:
Settings > Channels > [Channel Name] > Configure > Imports > Orders

Select the desired import mode:

  • Automatic: Qapla’ will query your platform every hour (at .00, e.g., 9:00, 10:00, 11:00, etc.) to import new orders and update existing ones.
  • Manual: You can start the import at any time from the Labels section by selecting Shopware and clicking Manual import.

Excluded statuses from import

You can exclude specific order statuses (in addition to the default excluded ones) to customize the import flow according to your operational needs.
In Shopware, there are two statuses for an order:

  • General status: defines the overall state of the order.
  • Transaction status: defines the transaction state of the order.

These two statuses are combined to uniquely identify the condition of an order.
To correctly set the statuses to be excluded from the order import, use the syntax:
generalStatus[transactionStatus], for example:                                                                                                                                                               open[refunded_partially]
in_progress[open]

After configuring all exclusions, make sure the settings are saved and up to date. Run an import test or wait for the next automatic import to verify proper functionality.

Custom payment statuses for Cash on Delivery (COD) orders

Some CMS platforms allow you to customize payment statuses in addition to the standard ones.
If you have configured custom payment statuses to identify Cash on Delivery (COD) orders, it is essential to inform Qapla’ Customer Care to ensure proper order import management.                                                                                                                                                            If you only use standard payment statuses, no action is required.
Please write to support@qapla.it, listing the exact names of the custom payment statuses used for COD.
Once confirmed by Qapla’ Customer Care, orders with these statuses will be automatically recognized as COD orders.

Advanced settings

Within the Imports > Orders section, you can enable the following options:

  • Import product images

Set default weight

Apply a predefined weight to imported orders.

Set default parcel number 

Define a default number of parcels for each imported order.

4. Order update on Shopware

To activate automatic updates on Shopware, go to:
Settings > Channels > [Channel Name] > Configure > Updates > E-commerce

Enable the available update options:

  • Do not update the order
  • Update order to “shipped” when the shipment becomes trackable
  • Update order to “shipped” when the goods are actually in the courier’s hands (Statuses for Qapla’: Departed, In transit, Out for delivery)
  • Update shipments on Shopware 6 by inserting the Tracking Number

Not working?

Qapla’ uses Shopware’s official API (Web Services).
If it does not work properly, please contact the administrator managing your Shopware site for verification.