Magento Integration Suite:Magento DPD MyDPD Connector

From XTENTO Support Wiki
Jump to: navigation, search

Contents

Overview

The XTENTO DPD MyDPD / Ship@Ease / Interlink Connector provides a bidirectional connection between Magento and MyDPD / Ship@Ease / Interlink. The connector consists of two packages:

Using these two packages, you will be able to import your orders into MyDPD, and later on after shipping the parcels, you will be able to import the tracking information (parcel number) back into Magento to provide the customer with the tracking number to track their order, and you'll be able to notify the customer that their order has been shipped, making shipping using MyDPD a breeze.

Exporting shipments into MyDPD and importing tracking information back into Magento has never been easier.

Got questions? Feel free to contact us! Contact Form

Interested in this Magento connector?

Head over to our store to purchase this connector: Magento MyDPD Connector

Setting up the Integration

This guide will help you setting up the MyDPD integration.

Order Export / Shipment Import

Preparing Magento for Export

  1. Open the connector ZIP file downloaded after your purchase. (Located in our store at My Account > My Downloadable Products)
  2. Set up the Order Export Module (located inside the OrderExport folder) following this guide: Installation Guide
  3. Log into the Magento backend and go to System > XTENTO Extensions > Sales Export Configuration and enter the license key you received via email.
  4. After activating the module in the configuration, go to Sales > Sales Export > Tools and import the "DPD_MyDPD_Export_Settings.json" file.
  5. The export has been configured now and is ready to use. Go to Sales > Sales Export and export a couple of orders. If this succeeds, you've successfully installed the export module.

Setting up the MyDPD Import

The following guide explains how MyDPD must be configured.

Delivery address line 1, Delivery address line 3, Delivery post code, Collection on delivery flag, Currency Code, Delivery VAT Number, Ignore Field, Delivery address line 2, Delivery Address line 4, Delivery contact name, Delivery contact telephone number, Delivery country code, Delivery customer ref. 1, Ignore field, Ignore field, Delivery customs value, Delivery description, Ignore field, Ignore field, Delivery notification email address, Delivery organisation/name, Delivery service code, Delivery total weight (kg), Delivery no of packages

Import Directory: C:\orders\ (You can also use any other existing path; this is the path where import files must be dropped into)
Import Extension: .csv
Field Delimiter: Comma
Print Label on Import: Yes/No (as required)
Is Enabled: Yes/checked
Ignore Header: No

From now on, whenever you want to export orders, simply do from the Sales > Orders grid or go to Sales > Sales Export > Manual Export. The file you download must be saved in the C:\orders\ folder (or if you have specified another folder above, use this folder of course). Now log into MyDPD, and when you navigate to either Create Shipment/Shipment Review or Import Activity the polling process will start then and labels should be popping up there automatically.

Tracking Information Export / Magento Import

Provided you have purchased the tracking number import add-on as well, follow this guide to set up the tracking information export from MyDPD to Magento.

Setting up the MyDPD Export

The following guide explains how MyDPD must be configured.

Export Directory: C:\DPDExport\ (You can also use any other existing path; this is the path where tracking files will be saved)
Export Extension: .csv
Field Delimiter: Comma
Auto Create File: Yes

Setting up the Tracking Import in Magento

Installation
  1. Open the "Xtento_TrackingImport" extension ZIP file downloaded after your purchase. (Located in our store at My Downloads)
  2. Set up the Tracking Number Import Module (located inside the Xtento_TrackingImport ZIP file) following this guide: Installation Guide
  3. Log into the Magento backend and go to System > XTENTO > Tracking Import Configuration and enter your license key to activate the module. Eventually enter your email address and enable debug mode to be notified about errors/warnings.
  4. Please make sure the Magento cronjob (cron.php inside the Magento root directory) has been set up to be called every 5 minutes. This is important. Follow this guide if you don't know how to set up the cronjob: Setting up the Magento cronjob
Configuration

The extensions configuration section is located at Sales > Tracking Import. We will now show you how to set up and configure the tracking number import. First of all, go to Sales > Tracking Import > Import Sources and set up a new import source for the type "Local Directory", give it any name, then make the following settings on the next page:

  1. Directory/Path: ./var/trackingimport (spelled out: a dot, slash, var, slash, trackingimport)
  2. Filename Pattern: /csv/i
  3. Archive directory: Leave empty
  4. Delete imported files: Yes

After saving the import source, now you have to set up the import profile.

We will now show you how to set up and configure the tracking number import. Please go to Sales > Tracking Import > Import Profiles, create a new profile for the type "CSV / TXT / Tab", give it any name like "MyDPD Import", and press continue. Then make the following settings on the next page:

General Configuration

  1. Set "enabled" to "Yes"

Settings & Filters

  1. No changes required

File Mapping

  1. Skip header line: No
  2. Field Delimiter: , (this is a comma)
  3. Field Enclosure Character: Leave empty - no value
  4. Field Mapping:
  5. Magento Field: Order Identifier - Enter in the "File Field Name / Index" field: 2
  6. Magento Field: Tracking Number - Enter in the "File Field Name / Index" field: 0
  7. Magento Field: Shipping Carrier Name - Enter in the "Default Value" field: DPD

Actions

  1. Create invoice for imported order: Yes / no - as you prefer
  2. Notify customer about invoice: Yes / no - as you prefer
  3. Import partial invoices: No
  4. Create shipment for imported order: Yes
  5. Notify customer about shipment Yes / no - as you prefer
  6. Import shipments without tracking numbers: Yes
  7. Add tracking numbers to existing shipments & import multiple tracking numbers: Yes
  8. Import partial shipments: No
  9. Change order status after importing partial order: No change
  10. Change order status after import: Complete (Suggested)

Import Sources

  1. Here you have to enable the import source you created a couple steps ago. Simply check the checkbox in the first column of this grid to enable the "Local Directory" import source for this profile.

Automatic Import

  1. Enable Cronjob: Yes
  2. Import Frequency: Every 15 minutes

Now save the profile. You are done.

Usage

From now on, at the end of the day just upload the files from the C:\DPDExport\ folder into the /var/trackingimport/ folder on your FTP server. The cronjob will pick up your tracking files automatically within 5 minutes and will ship the orders, as well as notify your customers.

Questions, Troubleshooting

Got pre-sales questions? Need to change anything in the connector or the output files? A field missing that you want to add? Feel free to contact us! Contact Form

Imports don't start automatically

Please click here and make sure all tests complete successfully: http://www.dpd.co.uk/apps/diagnostics/

Especially the Java check needs to complete successfully in order for the automatic import to work.

Personal tools
Namespaces
Variants
Actions
General Information
Magento 1 Guides
Magento 1 Extensions
Magento 2 Guides
Magento 2 Extensions
Magento Integration Suite
Toolbox