24
DPD OpenCart plug-in Documentation for shop administrators Version 1.0

DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

  • Upload
    others

  • View
    5

  • Download
    0

Embed Size (px)

Citation preview

Page 1: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in

Documentation for shop administrators

Version 1.0

Page 2: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 1 of 23

Table of content

1. OpenCart ........................................................................................................................................................ 2

2. Installing and activating the plug in ............................................................................................................ 2

3. General Configuration .................................................................................................................................. 4

3.1 Configuring the Account Settings ........................................................................................................ 4 3.2 Configuring the Sending Address ........................................................................................................ 5 3.3 Configuring for Export.......................................................................................................................... 6 3.4 Deactivating the plug in ....................................................................................................................... 6 3.5 Deleting the plug in .............................................................................................................................. 6

4. Configuration of Shipping Services ............................................................................................................ 6

4.1 Introduction .......................................................................................................................................... 6 4.2 Configuring DPD Predict ..................................................................................................................... 7 4.3 Configuring DPD Parcelshop .............................................................................................................. 8 4.4 Configuring DPD Saturday .................................................................................................................. 8 4.5 Configuring DPD Classic Saturday ................................................................................................... 10 4.6 Configuring DPD Classic ................................................................................................................... 11 4.7 Configuring Guarantee 18:00 ............................................................................................................ 12 4.8 Configuring Express 12:00 ................................................................................................................ 12 4.9 Configuring Express 10:00 ................................................................................................................ 13

5. Usage ............................................................................................................................................................ 13

5.1 Testing the Check Out ....................................................................................................................... 13 5.2 Generating Labels ............................................................................................................................. 14 5.3 Generating the Shipping List ............................................................................................................. 15 5.4 Individual Orders and multiple parcels .............................................................................................. 16 5.5 Errors ................................................................................................................................................. 17 5.6 Order Shipment History ..................................................................................................................... 18 5.7 Batch History ..................................................................................................................................... 19 5.8 Asynchronous requests and status ................................................................................................... 20

6. Export ........................................................................................................................................................... 20

6.1 Introduction ........................................................................................................................................ 20 6.2 Configuring for Export........................................................................................................................ 20 6.3 Entering Product Export Data: DPD Shipping Data .......................................................................... 22 6.4 Attributes ........................................................................................................................................... 23

Page 3: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 2 of 23

1. OpenCart

This manual assumes that you have installed OpenCart successfully and are familiar with the basic pages of

OpenCart: for checkout and the admin pages for entering product data and processing the orders.

Nevertheless, if you are building or customizing a shop theme and want to do export shipments through DPD it

may be useful to read the chapters about Export and Attributes as they are usually combined with some

adaptations of the theme.

2. Installing and activating the plug in

This plug ins requires PHP 5.6 or higher with the json and curl extensions. This plug in does not support a

multi store setup.

Install the ocmod.zip file using the Extension Installer as described here.

Once the file has been installed successfully you need to navigate to Extension > Modifications and verify that

the ‘DPD Benelux Default’ is in the list with status ‘Enabled´:

But the modifications only take effect when you click the blue refresh button at the right top. After successfully

applying the modification the system will notify you with green success message.

Page 4: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 3 of 23

Once the modifications are active the order admin pages will look different but the modifications are not yet

functional. You also need to install and activate the Extension itself under Extensions > Extensions. Choose

extension type ‘Shipping’ and the DPD Parcelservice should appear in the list:

Click on its green install button and after a second it should become red:

Now the extension is installed but still not active. You need to activate it in its settings page, see chapter

‘Configuring the Account Settings’ below.

Page 5: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 4 of 23

3. General Configuration

3.1 Configuring the Account Settings

Under Extensions > Extensions. Choose extension type ‘Shipping’ and the DPD Parcelservice should appear

in the list (last picture above in chapter ‘Installing and activating the plug in’). Click on its blue settings button

and you should see the following page:

As you can see the option ‘Disabled’ is selected after ‘DPD Parcelservice status’. Choose ‘Enabled’. Then fill

out the rest of the form:

• Username is the user name you have received for the DPD Connect api. If you have a ‘delisId’for the DPD DIS 2 service that will not work. You need to apply for a user name and password for the DPD Connect api.

• Password is the password for the DPD Connect api. A password for the DPD DIS 2 service will not work.

• Sending Depot is a number supplied by DPD of the depot where you bring your parcels to be sent off

• Environment is to choose between ‘Demo' for just testing and ‘Live' for real life processing. You are advised to start with the ‘Demo’ environment to see if everything works correctly with your configuration of the plug in and your products. Once you are confident that your set up is correct set it to ‘Live’ so that you can use the labels produced from then on for real packages that you really bring to the Sending Depot to be delivered to real customers of your shop.

• DPD Account Type makes you choose between services for delivery to consumers or services for Business to Business deliveries. See the section ‘Configuration of Shipping Services’ below

• Paper Format depends on the printer you want to use. The smaller ones only support A4 pages with labels so you choose A4. The big ones can (also) print big A2 pages so you can choose A2. A3 pages are not supported but most A3 printers can print A4 too.

Page 6: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 5 of 23

• Include Return Labels allows you to automatically produce return labels whenever you produce shipping labels. If set to ‘Enabled’ this setting also changes the behavior of some download buttons to simultaneously download the return labels. If enabled you van still produce return labels separately but not produce just shipment labels.

• Asynchronous is for processing large numbers of labels in the background. If the DPD Connect Api is busy, producing large numbers of labels may take some time and you would like to go on with something else in the mean time. Furthermore the request may take too long causing the entire request to fail. With asynchronous processing your request is queued so that it can return quickly without failing. Then the actual processing will take place later and the labels will be delivered in the background. If you choose ‘Yes; you are advised to test it in the ‘demo’ environment with a large number of labels to see if your configuration works properly with asynchronous.

• Asynchronous From allows you to set a threshold above which labels are requested asynchronously. Smaller amounts will still be produced in the foreground so that can wait a small while and download the labels immediately after the request has been processed.

• Default Weight in kilograms, like 0.01. Is usually left empty so that you get an error if the weight of a product that is shipped is 0. If you do set a value for Default Weight that value is used if a product that is shipped has weight of 0. There will be no more errors for products with missing weights. This is meant for shops with many light products that do not want to enter a weight for each product. Warning: If a parcel is actually heavyer then the weight that was specified, you may have to pay a fine! So if you use the default weight setting, make sure that all products whose actual weight is higher then the default do have their weight set! (NB The weight is rounded in whole decagrams before being sent to dpd. Values lower then 0.005 kilogram may get rounded to zero causing the same errors as 0)

3.2 Configuring the Sending Address

On the same page as the Account Settings (see above) you can configure the address that is passed to DPD

as the sender of the parcels :

The address of the shop that you can configure under Sytem > Settings for each store is not used by the plug

in, so if returns are shipped back to your address it will be to this address.

Page 7: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 6 of 23

You need to fill out all fields except the Eori number, which is only required for export:

• Company Name Name of the company that is sending the parcels

• Street + House Number

• Postal Code Zip code

• Place City

• Country from where the parcels are sent

• Phone will be used by DPD to reach you for urgent communication

• Eori Number Economic Operators Registration and Identification number of the company, see http://www.eori.eu/. Only required for export

3.3 Configuring for Export

See the Export section below. The Export configuration is only required for export, you can save the other

settings now and come back later if you need to.

3.4 Deactivating the plug in

You can disable the plug in itself using the DPD Parcelservice Status field in the Account Settings section of

the General Configuration (see above). This will remove all of the DPD shipping services from the check out

page of your shop. However, the modifications in the admin area of your shop will still be active. You can

disable them using the red button of the DPD Benelux Default extension on the Extension > Modifications

page described under ‘Installing and Activating the plug in’. Once you have disabled the modification you need

to refresh the modification cache using the blue button at the right top.

Disabling the plug in and its modifications will leave your settings and all product- and shipment data stored by

the plug in in the database. You only need to activate the plug in to make them accessible once again.

3.5 Deleting the plug in

You can completely delete the plug in and all data is has stored in the database by pressing its red button at

the Extensions > Extensions page where it show up after choosing type ‘Shipping’. Be aware that this will not

only delete all settings, all labels, shipments and batches from the database but also all DPD Product Export

Data you entered and all parcel shop data for all orders. The orders themselves will remain but if you add and

configure the plug in again you can still not get any labels for any orders that where to be shipped using the

Parcelshop service because the data about the parcel shop your customer selected on check out will be

missing.

You may have to manually refresh the modification cache using the blue button at the right top of the

Extension > Modifications page to get rid of the modifications made by the plug in.

4. Configuration of Shipping Services

4.1 Introduction

After activation and general configuration, if you go back to the Settings of the DPD Parcelservice (see chapter

Configuring the Account Settings) there will be new blue buttons on left corresponding the the DPD Account

Type you chose under Account Settings. Once the plug in is active, if you choose an option the service buttons

Page 8: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 7 of 23

will immediately appear on the left under ‘General’. However, only those services you configured to be active

will appear in the check out page of the shop. The plug in does not support offering combination of Business

to Business and Consumer services simultaneously.

Each service has the following fields that can be configured:

• Title is the leftmost, boldface part of how the service will appear in step 4 of the check out page of your shop. Both parts will be separated by a – (dash). The title of the service will also appear in the admin environment in the Orders list therefore it is important that you give each service you enable a different title.

• Description is the middle part of how the service will appear in step 4 of the check out page of your shop

• Cost Shipping cost. Rightmost part of how the service will appear in step 4 of the check out page of your shop. The cost will be added to the total costs in step 6 of the check out page.

• Tax Class to be applied to the shipping costs

• Geo Zone Geographical zone for which the service will be available (based on the delivery address)

• Sort Order Appears not to be working

4.2 Configuring DPD Predict

DPD Predict is the basic delivery service for consumers. If the plug in is active and the DPD Account Type is

‘B2C’ there should be a ‘DPD Predict’ button below the ‘General’ button on the left. If you click it the following

page appears:

Most of the fields you can fill out are explained in the chapter ‘Introduction’ of this section. This leaves:

• Status If set to Enabled and the DPD Account Type is ‘B2C’ the service will appear in step 4 of the check out page of your shop.

Page 9: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 8 of 23

4.3 Configuring DPD Parcelshop

The DPD Parcelshop service allows consumers to select a parcel shop from where to collect the shipment. If

the plug in is active and the DPD Account Type is ‘B2C’ there should be a ‘DPD Parcelshop’ button below the

‘General’ button on the left.

If you click it the following page appears:

Most of the fields you can fill out are explained in the chapter ‘Introduction’ of this section. This leaves:

• Status If set to Enabled and the DPD Account Type is ‘B2C’ the service will appear in step 4 of the check out page of your shop.

• Google Maps Api Key is required for obtaining the Geographical coordinates of the delivery address. DPD will then return a list of parcel shop nearby those coordinate. The user can choose one of these parcel shops from a Google map or from a list. You can obtain an api key for your shop from google directly.

• Map width The width of the map from which the user can select a parcel shop. If the screen of the user is too small a list will be shown instead of the map.

• Map height in pixes The height of the map from which the user can select a parcel shop.

• Max number of shops shown How many shops are shown (max) on the map and/or in the list. The optimal number depends on the size of the map, we advise to experiment with your settings and the actual map to optimize the user experience. A good starting point is 10. Error messages are limited, see the error log of you shop if an error occurs.

4.4 Configuring DPD Saturday

This service is only for deliveries that arrive on Saturday. If the plug in is active and the DPD Account Type is

‘B2C’ there should be a ‘DPD Saturday’ button below the ‘General’ button on the left.

Page 10: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 9 of 23

Page 11: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 10 of 23

If you click it the following page appears:

Most of the fields you can fill out are explained in the chapter ‘Introduction’ of this section. This leaves:

• Status If set to Enabled and the DPD Account Type is ‘B2C’ the service will appear in step 4 of the check out page of your shop on week days and times within the days and times configured at the ‘Show from’ and ‘Show till’ fields.

• Show from day From which day of the week the service will appear in step 4 of the check out page of your shop. If you do not select any day the service will not appear!

• Show from time From what time on the selected ‘day from’ the service will appear in step 4 of the check out page of your shop. Please enter time in hours (0-21) and minutes (0-59) separated by a colon. The time will be interpreted in the context of the time zone of your server shown below the time entry field*. If you do not enter a time the service will not appear!

• Show till day Until which day of the week the service will appear in step 4 of the check out page of your shop. If you do not select any day the service will not appear!

• Show till time Until what time on the selected ‘day from’ the service will appear in step 4 of the check out page of your shop. Please enter time in hours (0-21) and minutes (0-59) separated by a colon. The time will be interpreted in the context of the time zone of your server shown below the time entry field*. If you do not enter a time the service will not appear!

* Be aware that UTC does not have local summer time. Therefore the the customers of your shop will be given

the option of Saturday delivery one hour later in terms of local summer time. To change your servers time zone

see https://stackoverflow.com/questions/30580254/how-to-change-server-time-zone-in-opencart.

4.5 Configuring DPD Classic Saturday

This service is only for deliveries that arrive on Saturday. If the plug in is active and the DPD Account Type is

‘B2B’ there should be a ‘DPD Classis Saturday’ button below the ‘General’ button on the left.

Page 12: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 11 of 23

If you click it the following page appears:

Most of the fields you can fill out are explained in the chapter ‘Introduction’ of this section. Then there are the

‘Show from’ and ‘Show till’ fields which are explained in the previous chapter ‘Configuring DPD Saturday’. This

only leaves:

• Status If set to Enabled and the DPD Account Type is ‘B2B’ the service will appear in step 4 of the check out page of your shop on week days and times within the days and times configured at the ‘Show from’ and ‘Show till’ fields.

4.6 Configuring DPD Classic

DPD Classic is the basic delivery service for Business to Business deliveries. If the plug in is active and the

DPD Account Type is ‘B2B’ there should be a ‘DPD Classic’ button below the ‘General’ button on the left. If you

click it the following page appears:

Page 13: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 12 of 23

Most of the fields you can fill out are explained in the chapter ‘Introduction’ of this section. This only leaves:

• Status If set to Enabled and the DPD Account Type is ‘B2B’ the service will appear in step 4 of the check out page of your shop.

4.7 Configuring Guarantee 18:00

If the plug in is active and the DPD Account Type is ‘B2B’ there should be a ‘Guarantee 18:00’ button below the

‘General’ button on the left. If you click it the following page appears:

Most of the fields you can fill out are explained in the chapter ‘Introduction’ of this section. This only leaves:

• Status If set to Enabled and the DPD Account Type is ‘B2B’ the service will appear in step 4 of the check out page of your shop.

4.8 Configuring Express 12:00

If the plug in is active and the DPD Account Type is ‘B2B’ there should be an ‘Express 12:00’ button below the

‘General’ button on the left. If you click it the following page appears:

Page 14: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 13 of 23

Most of the fields you can fill out are explained in the chapter ‘Introduction’ of this section. This only leaves:

• Status If set to Enabled and the DPD Account Type is ‘B2B’ the service will appear in step 4 of the check out page of your shop.

4.9 Configuring Express 10:00

If the plug in is active and the DPD Account Type is ‘B2B’ there should be a ‘Express 10:00’ button below the

‘General’ button on the left. If you click it the following page appears:

Most of the fields you can fill out are explained in the chapter ‘Introduction’ of this section. This only leaves:

• Status If set to Enabled and the DPD Account Type is ‘B2B’ the service will appear in step 4 of the check out page of your shop.

5. Usage

5.1 Testing the Check Out

Before you can test the check out you need to activate at least one of the DPD shipping services at the plug in

configuration page. You are advised to start with a simple service like DPD Predict or DPD Classic.

Page 15: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 14 of 23

Add some product(s) to your cart an proceed to check out to see if the DPD shipping service is there:

If you don’t like its description change the service settings and redo the check out. Finish it so that the order is

stored, then test the generation of labels. Finally configure the other services you want to offer and test each of

them. Create some labels for each of them too.

5.2 Generating Labels

Once you have an order using a DPD shipment service you can generate labels for it. In the admin

environment go to Sales > Orders to see the list of orders. The orders using a DPD Parcelservice have the title

of the service in the DPD column ‘Parcels’:

Initially all of the pink buttons at the top are disabled. If you select one (or more) orders the buttons will be

enabled. If you move the mouse pointer above a red button a tool tip will show up explaining its function:

Page 16: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 15 of 23

Press the leftmost button to generate labels. Assuming you did not enable the option to also generate return

labels automatically this should result in the following:

A green message means that the request has succeeded and tells you what has been done. In the Parcels

column the numbers of the parcels appear for which labels are available. The arrow to the right means it is

a sending label. An arrow to the left means a return label. In the Status column you can see the current status

of the labels request.

If you click on a parcel number the labels for the parcels of that order will be downloaded. You can also select

multiple orders and use the second button from the left at the top to download all their labels at once. Or the

equivalent button ‘DPC Return Label to download their return labels.

If you did make the setting to automatically create return labels both the shipment labels and the return labels

for the selected orders should be generated. In that case the ‘DPD Labels’ download button will also work for

both the shipment labels and the return labels.

5.3 Generating the Shipping List

When you deliver your parcels to the DPD depot you will be asked for the shipping list. This list should show all

parcels and can be generated from the Sales > Orders page by selecting the orders and then pressing the

rightmost red button ‘DPD’ at the top:

Page 17: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 16 of 23

This will result in a page like this:

To print it on paper select ‘Print’ from the menu of your browser or the print icon somewhere in a tool bar of

your browser. You may also try Ctrl + p.

To get back to the Orders page use the back button of your browser.

5.4 Individual Orders and multiple parcels

In the Sales > Orders page if you click on the blue button at the right of an order you go to the Info page

of that individual order:

Here there are more red buttons for generating and downloading labels and return labels. Under Order details

you can see the Shipment service, the parcel numbers if labels are available, again with links for downloading.

The label generation buttons in the Order details page support an option that is not available at the Orders list.

Page 18: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 17 of 23

After you click the button you can choose in how many parcels you will ship the order (This option is not

available for export):

After you have set the number of parcels press the ‘Confirm’ button to generate the labels. The weight of the

total order will be spread evenly over all parcels.

There also is link to a page showing the history of label generation of the order. We will get to that in the

chapter ‘Order Shipment History’.

5.5 Errors

If something goes wrong with label generation you get a different result. Look what we got when generating

labels for our order 4:

A red message means something went wrong with the request. The message tells for which orders things went

wrong and what went wrong for each order. If possible it also tells you which field the caused the problem, in

this case the weight of the parcel. Sometimes the errors will be less specific. Sometimes all shipments will be

turned down because of an invalid value the server could not process at all. In that case all orders may be

mentioned though the erroneous value may only be in one order.

Page 19: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 18 of 23

Back to our example: what went wrong? We never filled out a weight when entering the product data under

Catalog > Products :

This resulted in a weight of 0 to be sent to DPD. Does this mean that you need to enter a weight for each and

every product in your catalog? Not necessarily! You may choose to set a default weight in the plug in settings.

If the weight of a product is 0 the plug in will specify the default weight instead of 0. This may come in handy if

you have many light products, but be aware: if a parcel is actually heavyer then the weight that was specified,

you may have to pay a fine! So if you use the default weight setting, make sure that all products whose weight

is higher then the default do have their weight set!

5.6 Order Shipment History

On the Order Info page ( blue button under Sales > Orders) there also is a link to a page showing the

history of label generation of the order. If you click the link you get a page like this:

As you can see we first had two errors before we got labels generated and also generated labels successfully

twice.

In this page you can also search for labels that where requested at a certain date, with a certain status,

specifically for shipment- or return labels and for labels with a certain batch id.

Page 20: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 19 of 23

If you click on a Failed status or on the red button at its right the error message is shown that came with the

failure:

5.7 Batch History

Each time you generate shipment labels, return labels or both for one or more orders a ‘Batch’ is created that

bundles all of them into a single labels request that is sent to DPD Connect. To keep track of what happened

these Batches are stored in the database. You can browse and search the list of all Batches through the

Sales > DPD Parcelservice entry in the admin menu. You will get a page like this:

With the filters on the right you can search for a Batch number, the date that the Batch was started, by order id

and by status. If you click on a parcel number the track and trace status of that individual parcel will be shown

on the DPD website. The button allows you to download all labels at once that where obtained by an

individual batch. The button allows you to drill down into the list of shipments that where part of an

individual Batch.

Page 21: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 20 of 23

This results in the same kind of page as we got when following the history link from an Order Info page, only

now it is searching by batch id instead of by order id. For its description please read the chapter ‘Order

Shipment History’.

5.8 Asynchronous requests and status

For a single user synchronous label request may seem relatively simple: they either succeed resulting in some

labels, or fail with an error. During the request itself nothing seems to happen, the page remains the same until

the request is finished. But if multiple users are working simultaneously, probably the other user would not like

to ask for the same labels as well. Therefore if he retrieves the Orders list those orders will show up with status

‘Pending’.

With asynchronous requests even a single user will see such status information. Once an asynchronous

request is made all orders for which labels where requested will first show status ‘Queued’. This status means

that the request has been accepted but that those labels are still waiting to be generated. After a while the

status of one of the shipments changes to ‘Working’. This means that the labels ere being generated at that

very moment. Another while later that shipment status returns to either ‘Success’ or ‘Failed’ and the next

shipment will get status ‘Working’. This will go on until all shipments have been processed.

6. Export

6.1 Introduction

When you are sending a shipment to a county outside the European Single Market you are exporting so the

plug will have to include customs data with the request. Customs data includes data about the Consignor,

Consignee, the shipment itself and the goods that are exported.

Labels for export can only be created once per order, with a single package per order. If not all data is

available en error will occur.

This documentation only describes some practicalities of supplying Customs information for export using the

DPD services the plug in supports. If you are new to exporting or need more comprehensive documentation

please read

https://www.dpd.com/hr_en/content/download/3090/58489/file/DPD%20Brexit%20Guide_4%20key%20first%2

0steps%20for%20customers.pdf .

For official documentation see

https://www.dpd.com/at_en/content/download/3258/31874/file/Exportrichtlinien_e.pdf

6.2 Configuring for Export

The configuration for export is as the bottom of the General Configuration of the plug in, see ‘General

Configuration’.

Page 22: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 21 of 23

It looks like this:

In the ‘Source’ fields your only option may initially ‘Use DPD Shipping Data’. Of you already have some

attributes they will show up as options too.

The Export section allows you to enter:

• Harmonized System Code Source is where the plug in will retrieve the Harmonized System Code (HS Code) of a product if it is exported. If an attribute is chosen the Harmonized System Code field will still appear in the DPD Shipping Data dialog and it may hold a value and be edited, but its value will not be used when the product is exported. For an explanation of the term HS Code itself see the chapter ‘Entering Product Export Data: DPD Shipping Data’ below

• Harmonized System Code Default can be left empty. If you have many goods with the same HS Code it can be handy to enter that code here. It will be used if the field/attribute selected at Harmonized System Code Source of a product that is exported is empty. Warning: If you enter a Default Harmonized System Code the plug in may without warning provide wrong Customs information if you forgot to fill the source field/attribute of some of the products exported. This may have juridical consequences. DPD takes no responsibility for this.

• Source of Customs Value The value of a product to be declared in the customs information may be different from its price in your shop. Here you can select the field/attribute where the plug in will retrieve this value of products exported. If the value of that field/attribute is empty for a product the total price will be used (product price times amount ordered, includes VAT).

• Source of Origin Country Code is the field/attribute where the plug in will retrieve the 2 letter Country Code from where a product that is exported was produced.

• Default Origin Country Code can be left empty. If you have many goods with the same Orgin Country it can be handy to enter the code of that Country here. It will be used if the field/attribute selected at Source of Origin Country Code of a product that is exported is empty. Warning: If you enter a Default Origin Country Code the plug in may without warning provide wrong Customs information if you forgot to fill the source field/attribute of some of the products exported. This may have juridical consequences. DPD takes no responsibility for this.

Page 23: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 22 of 23

• Source of Consignee VAT Number is the Custom Field where the plug in will retrieve the VAT number of the Consignee (Recipient) of export shipments. You can create Custom Fields under Customers / Custom Fields. The plug in does not care if it is an Account or Address field. Once the field has been added you need to refresh the Settings page of the plug in for it to show up in the options list. For how to add Custom Fields see https://isenselabs.com/posts/custom-fields-in-opencart-2.

6.3 Entering Product Export Data: DPD Shipping Data

To edit the general data of a product, go to Catalog > Products, browse of search for the product and click on

its blue button with the pencil. You will see a page like this:

Now click on the button at the right top. A dialog will open:

Here you can enter export data for the product. This data is only needed for export outside of the European

Single Market. Whether the data of an individual field in the dialog will actually be used if the product is

exported depends on the settings in the Export section of the plug in settings, see above.

Page 24: DPD OpenCart plug-in...DPD OpenCart plug-in Page 7 of 23 will immediately appear on the left under ‘General’. However, only those services you configured to be active will appear

DPD OpenCart plug-in Page 23 of 23

The following data can be entered:

• Harmonized System Code of the product. The HS Code is a systematic list of commodities, which is applied by most trading nations and forms the basis for international trade negotiations. The list is maintained by the World Customs Organization. To look up the HS Codes of your products see http://www.wcoomd.org/en/topics/nomenclature/instrument-and-tools/tools-to-assist-with-the-classification-in-the-hs/hs-online.aspx.

• Customs Value € The value of a product to be declared in the customs information may be different from its price in your shop. Here you can enter the value of the product in EUR to be declared when the product is exported. The value will be multiplied by the amount ordered in the order for which labels are requested.

• Origin Country Code Two letter Country Code (ISO Code) from where a product that is exported was produced

6.4 Attributes

Attributes are named properties that you can first create under Product > Attributes > Attributes and then

assign to a specific product in the Attributes tab on the Product details page you can reach through Product >

Products (the same where the button for the DPD Export data is, see above). All this is described at

http://docs.opencart.com/en-gb/catalog/attribute/.

Once you have created an attribute you can also select it to be used as the source of export data instead of a

field from the DPD Export Data Dialog described above. See in the Export section of the plug in Settings page

described in chapter ‘Configuring for Export’.

Be aware that attributes and their values are by default visible in the front store of your shop. This can be

changed when creating or editing your own custom theme, that is why the plug in offers the option to use them,

but also offers a dialog whose values will not shop up in the front store.