Gorgias logo
Gorgias logo

All articles

Magento 2Updated 4 months ago

Magento is an e-commerce platform built on open-source technology that provides online merchants with a flexible shopping cart system, as well as control over the look, content, and functionality of their online store.

The Gorgias plugin for Magento is currently compatible with Magento 2.2, 2.3, and 2.4 for Magento versions: Open Source (CE), Commerce using on-prem (EE), and Adobe Commerce (cloud).

This feature is available on Pro and higher plans. 

The Integration will allow you to:


To connect your Magento 2 store to your Gorgias account, you first need to install the Gorgias plugin on your store - it's completely free and necessary for this installation.

The user that purchased the plugin has to be an Admin and complete the installation, in case you have multiple users on your Magento 2 account.

1. Get the Gorgias plugin from the Magento Marketplace.

2. Connect to your Magento store's server via SSH with your developers' assistance.

3. Run the following commands:

1composer require gorgias/module-magento-connect
2bin/magento se:up
3bin/magento se:di:co

Once done, go to your Gorgias account:

1. Click on Settings -> App Store -> All Apps. 

2. Search for Magento 2 and click on it.

3. Click on Connect Magento 2.

Connect in 1 click

1. Enter the URL of the Admin panel of your Magento 2 store, then click on Connect App

Keep in mind that this should be the public URL through which your users access it and not one that redirects to the store.

2. You'll be redirected to your Magento 2 store, click on Create.
3. You will then be redirected back to your Gorgias account.

Connect Manually

This option is useful if you have a firewall configured on your Magento store that prevents you from adding the integration using the one-click installation process.

1. Go to the Magento admin dashboard.

2. Click on Settings -> Integrations.

3. Click on Add New Integration.

4. Name it something like Gorgias - Manual Integration.

5. Enter your password at the bottom.

6. In the left panel, click on API, and then check these permissions:

  • Sales > Operations > Orders > Actions > View
  • Sales > Operations > Orders > Actions > Edit
  • Sales > Operations > Orders > Actions > Cancel
  • Sales > Operations > Orders > Actions > Credit Memos
  • Sales > Operations > Shipments
  • Sales > Operations > Credit Memos
  • Customers (and then uncheck the All Customers, Now Online and Customer Groups nested permissions)
  • Carts > Manage carts

7. Click on Save in the top right corner.

8. When you're back on the list, in the Gorgias - Manual Integration, click on Activate.

9. Click on Allow.

10. Copy all credentials.

11. Click on Done.

12. Go back to the Gorgias interface and paste all credentials into the form together with the store URL.
13. Click on Add Integration.

From this point on we will do an initial import of all of your customers into the helpdesk. Any new order/customer will also be synced, and data about orders will be updated when there are new shipments or credit memos related to them.

Magento 2 customers' phone data can't be imported at the moment and for that reason, you won't find the customers' phone numbers in your helpdesk.

Magento 2.4

If you're upgrading from an existing installation, you'll have to follow the instructions below. 

Ask your developer to run these instructions when doing the upgrade to avoid any potential lag on your Magento server:

1. SSH into your Magento server.

2. Put your store into maintenance mode.

3. Connect to your database.

4. Run this query: `DELETE FROM gorgias_sync_log WHERE sync_flag = 1 OR sync_fail_count > 5;`.

5. If it takes too long, you can interrupt it and run `DELETE FROM gorgias_sync_log WHERE sync_flag = 1 OR sync_fail_count > 5 LIMIT 10000;` multiple times, until it doesn't delete anything anymore.

Magento tracking URLs

Magento doesn't send us tracking URLs but tracking numbers instead, which is why we generate URLs for you based on the carrier associated with the shipment. 

We can only generate URLs for the following carriers:

  • USPS
  • UPS
  • Canada Post

When the carrier is Other, we aren't able to generate the tracking URL due to API limitations.


The customer link in the widget won't work properly if you have enabled adding a secret key to URLs - if this option is enabled, the link will always take you to the general dashboard.

The secret key is generated at the beginning of the Admin session and it changes each time a new session is opened to prevent any redirect, which is exactly what Gorgias does in the widget. 

If you want their links to redirect to the right page, you have to disable that feature in your Magento Configuration -> Admin -> Add Secret Key to URLs -> No.

Was this article helpful?