Connect Qapla’ with Magento 2
The connection is made through Magento 2’s official Web Services.
To allow Qapla’ to communicate with your Magento 2 store where Two-Factor Authentication is enabled, please follow the steps below.
1. Create a Role (New Integration)
From the Magento admin panel, go to:
System / Integrations
Select «Add New Integration».
Within the section «Integration Info» fill out the field «Name» with “Qapla Integration” and the field “Your Password” with your own personal password. Then select API.
Click on “Role Resources” and select “All” or select the minimum permissions here below.
Click on «Save & Activate».
Confirm the integration by clicking on «Allow».
Copy the Access Token from this section.
2. Enter the data in Qapla’
On Magento 2, the configuration is complete.
Go to Settings > Channels > [Channel Name] > Configure > E-Commerce, select the platform, and enter the URL and Access Token from Magento 2.
After entering the data, click “Save.”
Note: The Access Token can always be retrieved by selecting “Qapla Integration” in System / Integrations.
3. Activating order import
To enable 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, selecting Magento 2 and clicking Manual Import.
Excluded statuses from import
You can exclude specific order statuses (in addition to the default excluded ones) from the import, customizing the flow according to your operational needs.
Custom payment statuses for Cash on Delivery (COD) orders
Some CMS platforms allow you to customize payment statuses in addition to the system’s standard ones.
If you have configured custom payment statuses to identify COD orders, it is essential to inform Qapla’ Customer Care to ensure correct handling of order import.
If you use only standard statuses, no action is required.
Write to support@qapla.it listing the exact wording of the custom order payment statuses used for COD. Once Qapla’ Customer Care confirms the setup, orders with those payment statuses will be automatically recognized as COD.
Advanced settings
Within “Imports > Orders” you can enable the following options:
- Import product images
- Import weight
- Customs code and Country of origin: lets you import this data from the order’s products, if available in the CMS. Enter the name of the custom attribute to read in the dedicated field.
Courier pre-assignment
You can automatically import the courier selected at checkout on Magento 2. However, for Magento 2 this configuration requires special attention, as the platform does not return structured courier codes via web service.
Unlike other platforms (e.g., PrestaShop), Magento 2 does not provide a unique courier identifier via API, but transmits two generic text fields:
- shipping_method, example: tablerate_bestway
- shipping_description, example: Express Courier
The shipping_description field is the description visible to the customer at checkout and is not a unique code, but a simple string. This value may change over time, depending on the merchant’s configuration in Magento 2.
Multiple shipping methods (shipping_method) can correspond to different couriers, and it is not always possible to determine with certainty which courier was actually selected.
Since these are free-text fields, interpreting the correct courier requires specific mapping.
To configure this feature correctly:
-
Analyze some real orders on your Magento 2 platform (you can use WS Test) to verify the values in the “shipping_description field”.
-
Based on your findings, enter them in the Transcoding Code field in the courier configuration. If you want to associate multiple strings, enter them separated by commas, with no spaces. Example: Express Courier,Standard Shipping,GLS Courier.
-
Write to support@qapla.it to complete the configuration, sending the channel name, all the codes, and the courier to associate them with.
On the next import, orders will be associated with the correct courier.
It is recommended to verify the actual import and correct courier assignment on one or more orders after saving the configuration, to ensure the mapping is correct.
Set default weight
Set a default weight to apply to imported orders.
Set default number of parcels
Define a default number of parcels for each imported order.
4. Order update on Magento 2
To enable automatic updates on Magento 2, go to: Settings > Channels > [Channel Name] > Configure > Updates > E-commerce
Enable the available update options:
-
Complete
- Set the order to “Complete” when the shipment has been dispatched.
- Set the order to “Complete” when the shipment has been picked up by the courier.
- Set the order to “Complete” when the shipment has been delivered.
- Tracking number: Update shipments on Magento 2 by entering the Tracking Number.
- Add the product list to the shipping information (shipping document).
- Generate invoice upon order completion on Magento 2.
5. Activating shipment import
To enable shipment import, go to: Settings > Channels > [Channel Name] > Configure > Imports > Shipments > Connectors > Magento 2 Connector > Set Connector.
In this section, set the time when Qapla’ will import shipments from Magento 2.
- You can configure up to two times per channel.
- If you wish to set more than two times, contact our Customer Care at support@qapla.it.
The import will run automatically at the configured times.
Not working?
Qapla’ uses Magento 2’s official APIs (Web Services).
If it does not work, we recommend requesting a verification from the administrator who manages the Magento 2 site.
Troubleshooting
| Error | Description | Solution |
|---|---|---|
| 401 Unauthorized | Qapla’ is not authorized to access | The key provided is incorrect or was not authorized by following the above procedure. |
| 403 Forbidden | The server blocks access to Qapla’ | Check that the site has no active security strategies (firewall) and ensure Qapla’ IPs are authorized. To request the full and updated list of IPs, contact our support at support@qapla.it. |
| 404 Not Found | The URL or endpoint being accessed does not exist | Verify the site URL is correct and confirm the site is indeed Magento 2. |
| 500 Internal Server Error | Internal server error on the site | Check the cause on your server. |
| Bad HTTP response | The site is unreachable | The site URL is incorrect, offline, or no longer exists. |
| 301 Moved Permanently | The site URL redirects to another | Enter the correct site URL. |
| 302 Found | The site URL redirects to another | Enter the correct site URL. |
| Could not resolve host: www.xxx.xx | The URL does not exist | Enter the correct site URL. |
| OpenSSL SSL_connect: Connection reset by peer in connection to www.xxx.xx:443 | Site certificate issues | Check the site’s HTTPS certificate. |
In general, connections to servers respond with HTTP error codes.







