Magento 2 Integration

Order Desk can connect to your Magento 2 store and import your orders. As orders are fulfilled, the tracking can be sent back to Magento 2.

Only Magento 2.1 and greater are supported with this integration.

This integration connects to Magento 2 which is not the same as the original legacy version of Magento. For legacy Magento instructions please see the legacy Magento guide.


Integration Settings
Manual Imports
Custom Features


To connect to Magento 2, click on Manage Integrations under the Integrations menu in the left sidebar. Under the Shopping Carts tab, find and enable Magento 2.

Alternatively, search for Magento 2 from the available integration search. 

To complete the connection, you will need to get an Integration Access Token from Magento.

Create Access Token

Follow the instructions in this guide from Magento for how to generate the right permissions for this token.

In step 4 ( Select the Magento resources the integration can access), assign all Sales Operations and Catalog permissions to the integration, including Orders, Shipments and Inventory.

Inventory Management

If you want to be able to sync inventory details between Order Desk and Magento, an additional permission will be required as well, which you can find at:

Stores > Settings > Configuration > Inventory Sections

Magento 2.2

If you are using Magento 2.2, you must also select the All Stores permission which is found underneath Stores > Settings > All Stores.

Connect Account

Magento will supply a Consumer Key, Consumer Secret, Access Token and Access Token Secret. You will only need the Access Token.

Add your website URL and your Access Token to the Order Desk Magento 2 integration settings and click to connect.

Please note that Order Desk isn’t able to help find or reset your credentials, as they can only be provided by Magento.

Integration Settings

Once connected to Magento 2, set your preferences in the integration settings.

Check for New Orders

Select how often you want Order Desk to pull in new orders from Magento.

Folder for New Orders

Select the folder where newly imported orders from Magento should be placed.

For more information, see the Working with Folders guide.

Orders to Import

Select which orders you want Order Desk to import from Magento.

Store ID List

To only import orders from specific Magento 2 stores, add the IDs here, separated by a comma.

Sync Tracking Numbers

Enable to have shipment information sent back to Magento as tracking is added to orders in Order Desk.

Email to Customer

Enable to have Magento email the customer as tracking information is sent back for orders.

Sync Inventory

Enable to have your inventory counts sent to Magento as they are updated in Order Desk.

The SKU value is used to match the product between Order Desk and Magento.

Any items with a quantity of 0 will be marked as out of stock. Any with a quantity of more than 0 will be marked as in stock.

Inventory Source Code

Target specific inventory sources and only update items tied to the source you enter in this field. 

Country Filter

Use two digit country codes, separated by commas, to only import orders from specific countries. 

Add a - to exclude orders from specific countries.


US,CA,MX will only import orders for the United States, Canada and Mexico.
-US,-CA,-MX (or -US,CA,MX) will import all orders except for the United States, Canada and Mexico.

Order Prefix

You can add a prefix of your choice that will be added to all orders downloaded from Magento.


Download Custom Product Attributes

Order Desk can pull in custom product attributes. To set this up, list the attributes you want brought into Order Desk in this field. For multiple attributes, you must separate each with a comma, but do not put a space after the comma.

Order Desk will look at each product in an order and store any attributes that are found in the item metadata.

Inventory Location Filter

If you only want to download specific orders, you can use the Inventory Location Filter field to specify which ones you want. Enter multiple locations separated by a comma.

The inventory location name must match exactly as it is on your inventory items in Order Desk. When importing new orders from Magento 2, Order Desk will look at the SKUs on the items and compare to the SKUs in your inventory here. Any orders with items for a location that isn't listed in this field will not be imported.

For this to work, your inventory must be added to Order Desk. The inventory Location should be set on each item. For details, please see How to Add Inventory and How to Store Extra Item Details.

Import Parent Products

If you have bundles set up in Magento and would like the parent product to import with the bundled items, enable this setting. The parent product will import with the bundle price set to it, and the individual items that make up the bundle will import with each set to a price of 0. 

Leave this setting disabled for Order Desk to ignore the parent product and import only the individual items that make up the bundle. 

Download Base Prices

Enable this setting if you’d like Magento 2 orders to be imported with base prices for items, discounts and shipping costs instead of actual prices.

Download Custom Options for Order Items

Select if you want to bring in your custom options (variations). If selected, this can slow down the order import.

Verify SSL Connection

Select to verify your SSL.

I'm running Magento 2 with /pub as my document root

If you’re using /pub as your document root in your Magento 2 installation, your media file paths will not have the pub/ prefix on them. For example, media/catalog/product/... instead of pub/media/catalog/product/... Select this checkbox if you’re running Magento 2 with this setup.

Manual Imports

If you need to manually import orders or inventory items from Magento, you can do this from the Magento integration page.

Manually Import Orders

Order Desk can manually pull in orders from the date you set here.

Manually Import Inventory Items

If you need to pull your Magento inventory into Order Desk, click the Import Inventory Items Now button.

For more information on Order Desk inventory, see the How to Work with Inventory Details guide.

Custom Features

Set shipment comments on a Magento 2 order by adding the comments in a checkout data field called MagentoShipmentComments.

If you are unfamiliar with checkout data, please read the How to Work with Checkout Data guide.


Whenever a SKU has a / in it, the Magento 2 API is not able to send that data into Order Desk, causing orders to have missing items. This is not a limitation that Order Desk is able to build a workaround for as it is related to the Magento 2 API. The easiest solution is to remove any forward slashes from SKUs used in your Magento 2 cart.

Still need help? Contact Us Contact Us