Magento Integration

Sync inventory, pull sales information, sync products to and from Magento. Magento can also be used just to process payments without managing inventory. 

NOTE: DEAR supports Magento 2. See Magento 2.0 Integration for more information.


Table of Contents

  1. Magento Integration Setup
  2. Catalog
  3. Orders and Sales

Magento Integration Setup

[back to top]

First you must connect DEAR to your Magento store. You will need admin access to Magento to set up the integration.

Setup in Magento

[back to top]

To prepare for the integration in Magento:

  1. Log in to the admin panel of your Magento store.

  2. Create a new Role in your Magento store. Go to System -> Web Services -> SOAP/XML-RPC – Roles

  3. You will see list of roles in your Magento shop. For a new installation, this list will be empty.
  4. Click Add New Role.

  5. In the Role Info tab, name the role and enter the admin password.

  6. In the Role Resources tab, set Resource Access to All. Click Save Role.

  7. Create a new User and assign it to this Role. Go to System -> Web Services -> SOAP/XML-RPC - Users.

  8. Click Add New User.

  9. In the User Info tab, fill in  the mandatory fields. User Name and API Key will be required to integrate with DEAR Inventory. Al the other fields are just general information required for Magento user registration.

  10. Click on User Role on the left side and select the newly created role for this user. Click on Save User to save changes.

  11. Update permissions for the new role (here, named Guest). Go to System -> Web Services -> REST -Roles.
  12. Click the newly created Guest Role from the list to open permissions.
  13. Set Resource Access is set to All. Click Save Role to save your changes.

Connecting Magento to DEAR

[back to top]

It is possible to link several Magento stores to a single DEAR account. Each linked store has independent catalog, logs and settings.

To connect Magento to DEAR:  

  1. Navigate to Integration -> Magento.

  2. Click the + to connect a new store. 
  3. Enter your Magento shop details and click Connect to Magento.

  4. You will be redirected back to DEAR. Repeat these steps to connect as many Magento accounts as you require.

Integration settings

[back to top]

In the Setup tab, several integration settings can be customised.

Order Capture

This option specifies when a  Magento Order will be captured: when it is created, when it is fulfilled or when it is paid in Magento. This setting is also taken into account when downloads of historical orders from Magento are triggered.

Consolidate Orders

DEAR - Magento Integration allows two options for order consolidation.

  • No Consolidation

  • Daily Consolidation

No Consolidation indicates that sales will be captured from Magento as they occur. Daily Consolidation will consolidate all orders from that day into a single order. When Daily Consolidation is chosen, an additional setting becomes available: Consolidation Time. This is your local time when all pending orders aggregated during the day will be processed.

See Pending Order Processing section for more details below.


For the pending order processing to be successful, an existing customer must be selected.

When Consolidation Type is Daily Consolidation, this customer is used to create a new sale task which will combine all daily sales. A customer can be created in DEAR just for this purpose.

Use Company as a Customer 

This parameter only has an effect when the No Consolidation option is selected.

In Magento, each sale order has optional field Company which can be filled in by a customer. If you would like DEAR to create a customer using the company name (as opposed to the Customer name attached to  the sale order in Magento) this option should be selected.

Price Tier 

Choose which Price Tier to use as the default price when DEAR syncs products with Magento. See Pricing and Price Tiers for more information. 

Pick, Pack and Ship Processing Mode

When pending orders are processed by DEAR new sale tasks are created. This setting tells DEAR if it should try to Auto Pick, Auto Pack and Auto Ship these tasks. If there is not enough stock on hand to pick the full quantity of products in an order, then pick will remain in Draft state and Pack and Ship won’t be completed.

DEAR does not pick up shipment information from Magento if auto-ship is selected and will not create fulfilment in Magento in this scenario (if Auto Ship is enabled).


Magento does not allow use of multiple warehouses. Each Magento store can have a dedicated Location within DEAR which can be selected from the drop down menu. Selecting a particular warehouse will limit the availability of stock in Magento to that location. The default option, All Locations, will display consolidated stock quantities across all of your locations.

Invoice Status

You can control Invoice Status for Sale tasks created as a result of pending order processing. By default, Invoice will not be authorised and will be in Draft state, adjustable and waiting for authorisation. However if this setting is changed to AUTHORISED the invoice will be automatically authorised and pending sync will be created for it to sync with accounting application of your choice.

Gift Card Liability Account 

DEAR will use this Liability account instead of a Revenue account for Gift Card sales. This account should have ability to accept payments. If a sale is made which contains a gift card, this sale will remain in the Pending Orders area until Gift Card Liability Account is specified. 

Optional revenue account

Revenue account to be used for all sales downloaded from Magento. This will override settings at the Product/Customer level and any other Account mapping. 

Sales Representative Name

This option allows the shop name to be used as Sales Representative. 

Update Stock Levels in Magento

You may choose to disable automatic stock level update in Magento performed by DEAR at the time available product quantity changes in DEAR. This may be useful if you are managing stock level in Magento manually and do not want DEAR to change it. Please ensure you have the correct stock quantities entered in DEAR before you turn on this option as these values will override the stock quantities in Magento. 

Send email from Magento

When enabled, this sends an email to the customer from Magento when shipping has been authorised.

[back to top]

Tax Rule Mapping

When pending order is processed by DEAR, a sale task is created. Each order and invoice line is assigned a tax rule. The tax rules specified in these settings will be used to create these lines. 

DEAR does not apply the tax rule to recalculate tax and is simply using the actual tax amount from the Magento order. This means that if certain products are not Taxable or with varying tax in Magento, all data and totals in DEAR will look identical to Magento, but with DEAR tax rule name selected in this setting.

The Tax Free tax rule mapping specified in this setting is used to create these lines for non-taxable products. This tax mapping could be useful for accounting.

In case of tax recalculation Tax amount will be overwritten with value calculated by DEAR Taxation rule.

IMPORTANT:  Orders will be skipped on download if Taxation mapping not finished!

NOTE:  For US Magento stores the provided Sales Tax is used instead of Tax Rule mapping.

Payment Account Mapping

DEAR can capture payments made against orders in Magento and is able to automatically add payments to a created sale invoice. To do this, Payment Account Mapping must be completed on this integration settings screen. You must choose an account which is able to receive payments from the chart of accounts. 

This setting is not mandatory - if payment mapping is not completed, orders are still captured and downloaded from Magento, but payments must be manually added to invoices in DEAR. Some customers prefer to keep invoices open and then reconcile them with payouts from Magento. 

Disconnect from Magento store

When you disconnect from Magento store, DEAR removes all associations between DEAR objects and Magento, including Log and Product Catalog.


[back to top]

The DEAR Magento Catalog page allows user to Download products from Magento, break the link between a DEAR product and its Magento listing and update quantities in Magento according to DEAR available stock.

Downloading Products

[back to top]

Products can be loaded from Magento to DEAR in the Catalog tab by clicking Load Products. This operation may take some time.

Each product variation in Magento must have a unique SKU. Configurable products require individual simple products for each variation. These simple products will have individual SKUs in DEAR. 

When a product is created/updated in DEAR during the download process, a link is established between item unique Magento ID and DEAR unique product ID. This link is used when products are matched against sale order lines in Magento and when subsequent product download occurs to update the same products.

Magento supports Product Families but all Product Family variants are downloaded as simple products. This is due to performance issues of Magento SOAP API during loading. 

Magento Product Types are mapped to DEAR categories.

When downloading products, DEAR tries to match existing products first to avoid creating duplicates. Matching is performed by item or variant SKU.

Data mapping for products between DEAR and Magento is as follows:


Listing SKU if defined, otherwise first 50 characters from combination of (Product title + Option 1 Value + Option 2 Value+ Option 3 Value)

NameProduct title + Option 1 Value + Option 2 Value + Option 3 Value
CategoryProduct Type
DescriptionHTML Product Description
WeightWeight (Converted to KG)
Price Tier. Default is Price Tier 1Price
ImagesSmall product image
Product TagsFirst 256 characters of Product Tags
Option 1 ValueOption 1 Value
Option 2 ValueOption 2 Value
Option 3 ValueOption 3 Value

Manage Catalog

[back to top]

There are two possible statuses for products i the Catalog: Not Listed and Listed. To be listed, every item needs to have a description, item image and default location specified. 

NOTE: Updating products from the catalog will update the stock level in Magento regardless of Update Stock Levels in Magento setting status. 

To list a product on Magento: 

  1. Click on the product in the Catalog tab. 
  2. In the pop-up window, specify an Attribute Set (this is required). It is required to specify Magento Attribute Set in order to create a product in Magento. DEAR products must have an Attribute Set specified to be listed. 
  3. You can enable or disable stock level syncing at the individual product level.
  4. Click List on Magento.
  5. Save your changes.

To unlist a product on Magento: 

  1. Click on the product in the Catalog tab. 
  2. Click Unlink.
  3. Save your changes.

To remove a product from Magento: 

  1. Click on the product in the Catalog tab. 
  2. Click Remove from Magento.
  3. Save your changes.

Bulk Listing

[back to top]

Products from your DEAR inventory can be listed on Magento individually as well as in bulk. 

To list products on Magento in bulk: 

  1. Go to the Bulk Listing tab.
  2. Select products to upload in bulk. You can select products by Category, Family, Product Tag, Price Tier, Listing Status and through manual search.
  3. Click Start to upload all selected products to Magento.

Orders and Sales

[back to top]

Processing Pending Orders

[back to top]

When a Magento store is connected to DEAR, automatic notifications are triggered when orders are created, when their status is changed, and when they are cancelled or deleted. 

Depending on the Order Capture setting selected, DEAR will capture a Magento Order and save it as pending order when the Order is created, fulfilled or paid. Sometimes it takes up to 10 minutes for the order to be picked up by DEAR because Magento may send notifications with some delay.

Whenever a sale is captured from Magento it is first placed into Pending Orders, and stock is allocated immediately. DEAR imports new orders immediately as individual sale orders (if No Consolidation is selected in the Integration Settings) or once a day as a consolidated sale order (if Daily Consolidation is selected). 

If No Consolidation is selected, each Magento sale is converted into an identical sale in DEAR, keeping the same customer and shipping information. If Daily Consolidation is selected, the single daily sale task will use the customer selected in the integration settings, and customer, billing and shipping information imported from Magento will be ignored.

When a Magento order is canceled or deleted, DEAR automatically find and voids the corresponding sale task if created or removes associated pending order if the order has not yet processed.

When processing orders, the logic is identical to that of the DEAR UI. DropShipping, Kitting and other important scenarios are implemented in the same was as through the DEAR UI.

Pending Orders can be processed manually by clicking Process. They can then be viewed in the Log tab.

Downloading Customers

[back to top]

The Load Customers button can be found next to Load Products

This function downloads all customers from Magento to DEAR. If the customer already exists in DEAR, this function updates any details that have been changed in Magento. As DEAR automatically creates customers when processing sale orders (if No Consolidation option is selected), this function is generally only used for testing purposes. 

This function creates a customer in DEAR with Contact, Billing and Business addresses captured from Magento. Customers cannot be uploaded from DEAR to Magento.

Downloading Orders and Payments

[back to top]

Orders are automatically downloaded if their status in Magento is changed (for example, a customer pays for an order). 

NOTE: Generally, you do not need to trigger manual order download, however if an order was not captured by DEAR or to load historical sales you can use manual Load Order option.

Any imported order is saved to the Pending Orders section. It is a temporary storage of all sales and payments in DEAR. If an order already has an entry in the Log (i.e. was imported previously) it will be skipped. This guarantees that no duplicate sales will be created by DEAR.

While saving orders, DEAR captures customer information, billing and shipping addresses. All line items are captured together with quantities, prices and totals. Total order discounts are applied as are additional charges to the whole order, without distribution by lines to reduce the chance of discrepancy.

Shipping and handling are also saved as additional charges in the Sale invoice under Shipping.

If a Payment Account has been specified in the Integration Settings, DEAR will always assign associated payments to the captured Magento orders.

When a Magento order is cancelled, DEAR automatically finds and voids the corresponding sale task if already created as a Sale Order or just removes the associated pending order if not yet processed.

The final step in the order download is to trigger update of stock levels in other Magento stores and other connected eCommerce channels.

Updating Fulfilment in Magento

[back to top]

When Shipment is authorised in DEAR and the carrier specified, DEAR will try to create order shipment information in Magento. This will only work in No Consolidation processing mode.


[back to top]

Each captured Magento order once saved to Pending Orders creates a Log entry to track the link between the Sale in DEAR and in Magento. This eliminates the possibility of creating duplicated orders when capturing the same order several times during manual order load. 

Each Log entry has a link to the sale task in DEAR. Depending on the settings selected by the user in the Setup tab, this sales task could be draft or authorised, one or more of the Pick, Pack and Ship tabs could be authorised, and payment could have been applied to the invoice. 

Log entries allow you to see which Sale task reflects a particular Magento sale. You also have the option to delete a Log entry manually. This will allow to reprocess an order if required. Deleting a log entry will not void or delete its associated sale task.

Reloading Orders from Magento

[back to top]

If for any reason you need to reload an order from Magento, this can be managed from DEAR.

To reload an order from Magento:

  1. Void the sale task. A record of this will be kept in DEAR for reconciliation purposes but the transactional data will be deleted. 
  2. Return to the Magento integration Log tab and delete the Log entry. This will allow the order to be recaptured from Magento.
  3. Navigate to the Pending Orders tab and click Load Orders, making sure the date is set to before when the order to reload was made. 

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.