​
Installation Instructions

1

Set the Configuration

  1. Open your terminal or command prompt and navigate to the root directory of your Magento 2 installation.

  2. Execute the following command to set the oauth/consumer/enable_integration_as_bearer configuration option to 1.

bash
bin/magento config:set oauth/consumer/enable_integration_as_bearer 1
2

Verify the Configuration

  1. To ensure that the configuration has been set correctly, you can check the value using the following command:
bash
bin/magento config:show oauth/consumer/enable_integration_as_bearer
  1. The output should confirm that the value is set to 1.
3

Navigate to your Magento Integration Settings

  1. Navigate to your Magento Admin Dashboard.
  2. From the Menu Sidebar, navigate to the System > Extensions > Integrations submenu.
4

Generate your Magento Admin Access Token

  1. Choose to generate a new key, and choose Sales/Operations/Orders/Actions/View as your scope.
  2. Copy the generated access token, you will need it in the next step.
5

Create a new Server-side source in Converge

  1. In Converge, click on Create a new source
  2. Pick Server-side from the modal
  3. Name your source: e.g. {Storename} Store Backend
  4. Choose the Magento v2 app from the dropdown menu.
6

Connect the Source to Magento

  1. Enter the full URL of the REST API of your Magento 2 store in the API URL-field, including https://, e.g. https://myshop.com/rest
  2. If your storefront is hosted on a different domain than your API, please provide the domain in the Storefront domain. This domain should match the domain on which the Magento Storefront Module was installed. For example, myshop.com. Feel free to leave this blank if your store is hosted on the same domain.
  3. Paste in the Admin Access Token you retrieved in the previous section in the Admin Access Token.
  4. Optionally, filter out orders by store view or modify the start date. You should leave these fields blank if you do not have a good reason to use them.
You should see the Source syncing all historical order data, you should wait until it’s fully synced to create destinations

​
Configuration

​
Storefront domain

If your storefront is hosted on a different domain than your API, please provide the domain in the Storefront domain. This domain should match the domain on which the Magento Storefront Module was installed. For example, www.example.com.

Pay attention to provide the full domain here. Depending on your setup, it might be necessary to include www., or not. You can inspect the full domain in the browser’s address bar when you visit your storefront. Click on the address bar to see the full URL.

​
Filter by store view name

You can scope your Magento integration to only include orders from a specific store view. This may be useful if you have multiple store views in your Magento installation and want to separate them out in Converge.

​
Only track orders once they reach a status

You can customize where in the order lifecycle Converge starts tracking orders. This can be useful if you want to exclude unconfirmed orders or only track orders that have been paid for.

The default order status lifecycle is documented by Magento here

.

Converge will track the order whenever it reaches any of the specified status. The order may still go through multiple transitions after this point.

Depending on your Magento installation, the order lifecycle may have been customized. Make sure to consult on any changes with your Magento developer.

​
Event Spec

This integration auto-tracks the following events on the server with all properties available according to the Converge Event Spec.

Event NameEvent Description
Placed OrderWhen a customer places an order.