User Guide For CS-Cart Shopify Connector
Table of Content
- Install the add-on.
- Enter the license key.
- Follow the license activation steps.
CS-Cart Shopify Connector Features:
- Well integrated with CS-Cart Multi-Vendor and Multi-Vendor Plus.
- Admin / Seller can import products from the Shopify store to the CS-Cart store with variations (Product Variation Add-on Required).
- The products get imported with Product name, Cost, Main image, Description, Code, Weight, and variations.
- Admin can import products by collection using both collection smart and custom.
- Product updates in your CS-Cart store, like price, quantity, name, and other details in real-time.
- Admin/Seller can map the Shopify categories with CS-Cart categories.
- Order gets synced to Shopify in real-time when created in your CS-Cart store.
- Admin / Seller can import orders from Shopify to CS-Cart.
- Admin / Seller can handle multiple store accounts from the CS-Cart Panel.
- Additionally, the admin / Seller can draft the Shopify products as Active/Disabled/hidden from CS-Cart.
- Admin / Seller has access to set types of variations before importing the products.
- While adding a Shopify Account in CS-Cart, the Admin / Seller can add an API key/Token and a Password/custom.
- Admins and Sellers can now add the Shopify add-on using the Shopify Developer Dashboard by entering the Client ID, Client Secret, and store domain name.
- Close/cancel/update and delete orders on Shopify when initiated on the CS-Cart store.
- Real-time sync of Shopify orders to CS-Cart store.
- The store status will be shown on the store edit page.
- Added a new order status mapping tab and also added an option to select the default order status.
- Option to change hook setting for product update, a product created, order update, order created, etc.
- The domain has been added to the store management page.
- Option to export product from the product detail page.
- Option to export categories from the categories detail page.
- Admin and seller can export new products on the Shopify store from the CS-Cart admin panel.
- The admin can export multiple products to their Shopify account.
- The admin/seller can import a large number of products from Shopify to Cs-Cart with the help of RabbitMQ.
Flow Of Installation And Configuration:
Step1:

Activate Add-on
Configure the Add-on Settings
- Use Queue Handler: Enable this option for bulk operations. The queue handler is recommended when syncing a large number of products or orders.
Note: The Queue Handler must be installed and running to ensure smooth module functionality.
- Order Status to Stop Sending Products to Shopify: Select the order status that should not be sent to Shopify.
- Allow Automatic Sync (CS-Cart → Shopify): Choose Update, Delete, or Both to allow product synchronization from CS-Cart to Shopify. If no option is selected, products will not sync.
- Allow Automatic Sync (Shopify → CS-Cart): Choose Update, Delete, or Both to allow product synchronization from Shopify to CS-Cart. If no option is selected, products will not sync.
Note: Product synchronization can be enabled in only one direction at a time.
RabbitMQ Configuration
Note: To configure RabbitMQ properly, make sure the CS-Cart Queue Handler is installed and set up. You can refer to the official documentation here:
https://docs.cs-cart.com/latest/developer_guide/core/queue.html
In this section, you need to configure the RabbitMQ settings to enable queue-based processing.
-
Host: Enter the RabbitMQ host details.
-
Port: Enter the RabbitMQ port number.
-
Username: Provide the RabbitMQ username.
-
Password: Enter the RabbitMQ password.
-
Queue Name: Specify the RabbitMQ queue name.
Step2:
Go to the website and click on the Shopify Connector to manage and configure your Shopify account settings.Step3:
First, you have to log in to the Shopify account, if you don’t have the account. You can create the account by clicking hereCreate Account Using API Key / Token
How to get Shopify Credentials:
Here are the steps for generating the credentials. After creating the store on Shopify, you have to click on the Settings option on the left side of the screen.Create Account Using Dev Dashboard
How to get Dev Dashboard Credentials
Set Up Admin API Permissions
Now, you need to configure the required API permissions for your Shopify app.
Fill in the following details:
App URL – Enter the URL where your app is hosted, or the URL Shopify should redirect to after the app is installed or accessed.
After that, assign the necessary permissions to your app:
-
Navigate to the Access Scopes section.
-
Select the required API scopes based on the connector requirements (such as Products, Orders, Inventory, Customers, etc.).
Make sure to enable Read and Write access for the following:
-
Customer information and customer groups
-
Inventory management
-
Orders, transactions, fulfillment details
-
Product data including products, variants, and collections
-
Locations
-
Shipping rates
-
Discounts
-
Online Store pages access through the GraphQL API
Note: While configuring webhook subscriptions, ensure that you select the latest available Event Version.
Retrieve Your API Credentials
Once the app version has been released, navigate to the API Credentials section within your app dashboard. Here, Shopify provides the authentication keys required for integration.
You will be able to find the following details:
-
Client ID (API Key)
-
Client Secret Key
To view the secret key, click on Reveal.
Make sure to copy both credentials carefully and store them securely, as these values will be required during the module configuration.
Install the App
After configuring the required API scopes, the next step is to install the app in order to enable API access.
-
Click on Install App from the app dashboard.
-
Confirm the installation when prompted.
Once installed, Shopify will activate the app and generate the OAuth credentials required for completing the integration.
Step4:
After that, in order settings, select Close Shopify orders, Cancel Shopify Order, Payment Processor, Import order from Shopify to CS-cart, default shipping method, and status for fulfillment.Step5:
Therefore, for product setting, select the desired category to which Shopify products get imported and the currency. Click on the plus icon to select the CS-Cart category.- Default category– You can click on the plus icon to choose the category.
- Shopify Currency– Select the Shopify currency.
- Type of Product variation– Please select yes if you want to create (Variations as one product) and select no for (Variations as separate products).
- Please select the given option to import the Shopify draft product into the Cs-Cart site with the given status.
- Quantity Update- Update the quantity.
- Update Product- Update the product.
- Type of product import- Choose the particular type of product to import.
- Get HTML description– Choose the HTML description.
Step6:
In Webhook settings, a webhook is created for products updated in real-time. After configuring various settings, click on Save.Given below is the step by step processes from Shopify store to CS-Cart:
1. Category Map:
Now, in the category map, the admin/seller can map the Shopify category with the CS-Cart category to import products respectively.2. Manage Shopify Shipping Template:
3. Import Orders:
Admin can import orders from Shopify by clicking on the plus icon. Here, an admin can import products with respect to the selected “Date period” and “Fulfillment status”, by “Order Id” and “Order status”. After the date and order status, click on “Import Order”.4. Manage Shopify Orders:
After that, in this section, you can view the exported Shopify orders.5. Manage Shopify Products:
Furthermore, in this section, to import products from Shopify, click on “Start Import”.6. Managing Shopify Accounts:
After that, in this section, the admin can delete/Edit his account.7. Export Products to Shopify Accounts:
The admin can go to the product page and select the setting option to export the product to the Shopify account, as shown in the image:8. Export categories to Shopify Accounts:
The admin can export the categories to the Shopify account by clicking on Products>Categories and then clicking on setting option from the admin panel.How to use RabbitMQ
First of all, log in to your RabbitMQ account by using your username and password.How to import products from Shopify to RabbitMQ
How to import products from RabbitMQ to CS-cart
curl -k --location --request GET '(url)/index.php?dispatch=wk_shopify_product.list_collection_products'
The log will be created for each of the importing products. In this way, all the products are imported successfully to the CS-Cart.