Connect Vtex with Qapla’
In order to connect Vtex to Qapla’, you have to make the following steps:
1. Obtain the access data
The access data below are needed for the connection:
-
- V-TEX Domain
- V-TEX AppToken
- V-TEX AppKey
2. Enter the data in Qapla’
Go to Settings > Channels > [Channel Name] > Configure > E-Commerce, select the platform, and enter the previously provided keys.
After entering them, click on «Save and run test».
3. Enable 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 (on the hour, 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 Vtex and clicking on Manual Import.
Excluded order statuses from import
You can exclude specific order statuses (in addition to those excluded by default), customizing the flow based on your operational needs.
Custom payment statuses for Cash on Delivery (COD)
Some CMS platforms allow you to customize payment statuses in addition to the standard ones provided by the system.
If you have configured custom payment statuses to identify Cash on Delivery (COD) orders, it is essential to notify Qapla’ Customer Care to ensure proper management of order imports.
If you only use standard statuses, no action is required.
Write to support@qapla.it listing the exact wording of the custom payment statuses used for COD.
Once Qapla’ Customer Care confirms the setup, orders with these payment statuses will automatically be recognized as COD orders.
Advanced Settings
Within the section “Import > Orders” you can enable the following options:
- Import product images
- Import weight
- Import address by concatenating the “address” + “number” fields.
In Vtex, the shipping address can be stored in two ways: a single field or two separate fields.
Enabling this option makes Qapla’ automatically concatenate the “address” and “number” fields to obtain a complete address.
Without this option, Qapla’ imports only the content of the “address” field.
Set default weight
Define a default weight to apply to imported orders.
Set default number of parcels
Define a default number of parcels for each imported order.
4. Update the order on Vtex
To enable automatic order updates on Vtex, go to: Settings > Channels > [Channel Name] > Configure > Updates > E-commerce
Enable the available update options:
- Update the order to “Shipped” when the shipment becomes trackable.
- Update the order to “Shipped” when the goods are physically in the hands of the carrier (statuses recognized by Qapla’: Departed, In transit, Out for delivery).
- Update the order to “Delivered” when the shipment is delivered
Not working?
Qapla’ uses the official Vtex APIs (Web Services).
If it doesn’t work, we recommend asking the administrator who manages your Vtex site to perform a verification.