dpd – pakivedu.ee shipping module for prestashop · dpd server and print out dpd pdf packing...

06/2015

DPD – Pakivedu.ee shipping module for PrestaShop

http://en.e-abi.ee/

Table of contents

Definitions .................................................................................................................................................... 1

Added functionality ..................................................................................................................................... 2

Use cases .................................................................................................................................................... 2

PrestaShop requirements .......................................................................................................................... 2

Third party libraries ..................................................................................................................................... 2

Install procedure.......................................................................................................................................... 3

Setting it up .................................................................................................................................................. 3

DPD Pickup – Pakivedu.ee ................................................................................................................... 3

DPD – Pakivedu.ee – Courier service ................................................................................................. 5

Cash on delivery for DPD ...................................................................................................................... 7

Parcel data sending with DPD API........................................................................................................... 7

Parcel data sending with DPD API for Cash on delivery orders .......................................................... 9

Calling in DPD courier to pick up goods ................................................................................................ 10

License ....................................................................................................................................................... 11

In case of problems .................................................................................................................................. 11

Module is installed, but DPD carriers are not listed in the frontend .............................................. 11

DPD Courier carrier displays empty select menu ............................................................................ 11

Other problems ...................................................................................................................................... 12

Definitions

• DPD – Shipping service provider in Estonia, link: http://www.pakivedu.ee/

• DPD API – Active programming interface, which allows Merchant to send parcel data, print

packing slips from DPD and call courier to pick up parcels without leaving PrestaShop ad-

min panel. Link:

https://docs.google.com/document/d/1dC2vVZPniVaQeCXroUtFW8RSy6XYpnMFCmdbRE

FMvc0/edit?pli=1

• GPLv3 – Software license allowing distribution of free software. Link:

http://www.gnu.org/licenses/gpl-3.0.txt

• DPD Pickup – Network of shops in Estonia, Latvia, Lithuania, allowing customer to pick up

purchased goods near comfortable location.

06/2015


http://en.e-abi.ee/

Added functionality

• Clients can use DPD Pickup service in Estonia, Latvia, Lithuania by selecting preferred

Pickup point from select menu, where they wish to pick up ordered goods.

• Clients can use DPD courier service in Estonia, Baltic states, Europe.

• Auto updates list of Pickup points from DPD server automatically.

• The list of Pickup points is also updated when Merchant saves settings.

• Meant for merchants, who operate mainly in Estonia.

• When DPD API communication contract exists, then Merchants can send parcel data to

DPD server and print out DPD PDF packing slips from PrestaShop admin.

• When DPD API communication contract exists, Merchants can call for courier to pick up

goods from PrestaShop admin.

• When tracking code is supplied to the shipment, then customer can see tracking link when

logging in to account, showing status of the shipment.

• Customer can pay right after order confirmation or with cash on delivery

• Merchant can apply extra fee which shall be added on top of shipping price when customer

decides to pay with cash on delivery

Use cases

• Customer orders goods to DPD Pickup points located in Estonia, Latvia, Lithuania.

• Customer located in Europe orders goods to be delivered to shipping address by courier.

• While merchant manages orders, he can send parcel data to DPD and print out DPD pack-

ing slips without leaving PrestaShop admin panel. When possible parcel data is sent auto-

matically.

• Merchant prints out DPD packing slips without leaving PrestaShop admin.

• Merchant calls courier to pick up goods to be delivered with DPD for one or many orders

simultaneously by being able to specify date and time, when the goods are supposed to be

picked up.

• Customer orders and pays with Cash on Delivery

PrestaShop requirements

Current module works with following PrestaShop versions:

• 1.5.x.x

• 1.6.x.x

Third party libraries

Current module uses jQuery loadTemplate plugin:

06/2015


http://en.e-abi.ee/

https://github.com/codepb/jquery-template

Install procedure

From modules zip file you can find „install“ folder, which contains uploadable .tar file.

From PrestaShop admin panel navigate to:

Modules -> Modules

Pick “Add new module” and upload the contained .tar file.

You can also unzip the .tar file and copy its contents to ~/modules folder in PrestaShop root folder

Setting it up

Correctly installed module yields four new modules, where three are located under “Shipping and Logistics”

tab:

• E-Abi Generic Office Plugin (eabi_postoffice) – General helper plugin, which helps with select menu

generations

• DPD Pickup (eabi_dpd_parcelstore) – Adds carrier DPD Pickup

• DPD kulleriga koju või tööle (eabi_dpd_courier) – Adds carrier DPD Courier service

And remaining is located under “Payments and Gateways” tab:

• Tasun lunaga paki kättesaamisel (DpdCodPayment) – Adds cash on delivery payment method

Install listed modules in the following order (eabi_postoffice, eabi_dpd_parcelstore, eabi_dpd_courier,

DpdCodPayment)

If you do not wish to use either of the carriers, then do not uninstall the module, mark it as disabled in-

stead.

If you do not wish to use DPD cash on delivery services, then you can uninstall the module or disable it.

DPD Pickup – Pakivedu.ee

Enables you to set up DPD Pickup availability to customers and if DPD API contract exists then

details of parcel data sending and courier call methods can be configured.

• Title – Title displayed to the customer for current shipping method. For example „DPD –

Choose your pickup location“

• Price – Shipping price for customer with VAT. Price defined here will be applied if there is

no separate shipping price declaration for the customer destination country, but this ship-

ping method is available.

• Tax Id – Tax rate applied for this carrier

• Price per country – You can declare shipping price for each country. If one country is de-

clared multiple times, then latest declaration overrides all previous declarations.

06/2015


http://en.e-abi.ee/

o Country – Country, to which the shipping price must be declared for

o Base shipping price – Flat shipping fee

o Price per additional 10kg over base 10kg – Additional shipping fee on top of base

shipping price per additional 10 kilograms of the cart weight excluding base 10kg in-

cluded in base shipping price. Weight is calculated from products weight field.

o Free shipping from price – Minimal cart subtotal cost without VAT, from which

shipping cost to customer is free. Leaving this field empty disables free shipping for

this country

o Cash on delivery fee – Enables cash on delivery payment option for specified

country when this field is filled with valid number equal or greater than 0. Cash on

delivery needs also to be enabled by activating “DPD cash on delivery” plugin. Fee

specified here would be appended to current shipping fee, even if shipping was pre-

viously free

• Show short office names – „Yes“ – DPD Pickup points list shows only names of DPD

Pickup points. „No“ – DPD Pickup points list shows names of DPD Pickup points, address-

es, phone numbers, opening hours.

• Sort offices by priority – „Yes“ – DPD Pickup points from more populated regions are dis-

played first and rest will be sorted alphabetically. „No“ – Sorting is not applied. Changing

this setting requires rebuild of DPD Pickup points list.

• Disable this carrier if product's short description contains HTML comment  - If this setting is allowed and such a product exists in cart, then this

shipping method is unavailable to customer.

• Maximum allowed package weight for this carrier – Default 31.5 – If such a product ex-

ists in cart, which weighs more than 31.5kg (from products weight attribute) then this ship-

ping method is unavailable to customer. If this field is left empty, then weight limitation is

not applied.

• Handling action –

o Per order – Shipping price equals configured shipping price + extra price by weight.

o Per package –Shipping price equals configured base shipping price multiplied by

number of products in cart + extra price by weight.

• Client groups who can get free shipping – If customer belongs to a group, that is marked

here, then current shipping method to the customer would be free of charge.

• Enable free shipping – When enabled and Free shipping subtotal is less or equal than

carts subtotal excluding VAT then shipping is free for the customer.

• Free shipping subtotal – If carts subtotal excluding VAT is equal or greater than amount

specified here, then customer receives free shipping for this carrier. If amount here is less

than free shipping amount specified in the customers shipping address country then free

shipping amount for the country is ignored and this configuration is used instead.

• Auto send data to DPD server – If you have DPD API contract, then you can configure it

by enabling this setting. Enables you to auto send parcel data to DPD, print DPD packing

slips and call courier to pick up parcels.

• Allow courier pickup – When enabled, you can order DPD courier to pick up parcels from

PrestaShop Sales Order list

• DPD Self-service username – Enter DPD API username here

06/2015


http://en.e-abi.ee/

• DPD Self-service password – Enter DPD API password here

• Pickup address name – First name and last name on pickup address when shipping to

customer fails.

• Pickup address company – Company name on pickup address when shipping to custom-

er fails.

• Pickup address e-mail – E-mail address on pickup address when shipping to customer

fails.

• Pickup address phone –Phone number on pickup address when shipping to customer

fails.

• Pickup address street – Street, house, apartment on pickup address when shipping to

customer fails.

• Pickup address city, county – City, county, region on pickup address when shipping to

customer fails.

• Pickup address zip code – Zip code on pickup address when shipping to customer fails.

• Pickup address country – Country on pickup address when shipping to customer fails.

This field is also used with zip code to query available courier pickup times from DPD API.

• Show pickup address on packing label – Decides if customer can read the pickup ad-

dress from packing slip or not.

• Labels position on packing slip – Labels position on packing slip.

• Api URL – Destination URL for DPD API. Default:

o Live - http://www.pakivedu.ee/rpc/gateway

o Test - http://dpd.surflink.ee/rpc/gateway/

• You can define the availability of this shipping method by country. By default this shipping

method is enabled in Estonia, Latvia, Lithuania and correspondingly customer can only see

DPD Pickup points from selected country only.

• Show customer one dropdown instead of two – When enabled, then customer is dis-

played with a select menu of all available DPD Pickup points. When disabled customer

must pick region first and then is presented with list of available DPD Pickup points from

previously selected region.

• Width in pixels for city select menu – If you have set up this shipping method up in a way

that customer has to choose region first and then DPD Pickup point from the region, then

with of this region select menu can be regulated here.

• Width in pixels for office select menu – If DPD Pickup points select menu with is not ac-

ceptable then you can regulate it here.

DPD – Pakivedu.ee – Courier service

Enables to set up availability of DPD courier service.

DPD courier takes parcel right to customers preferred address, which can be more comfortable

alternative to DPD Pickup in some situations.

If you have DPD API contract then you can set it up under „DPD Pickup – Pakivedu.ee“ configura-

tion. You can leave DPD Pickup module in a disabled state if you wish to do so.

06/2015


http://en.e-abi.ee/

• Title – Title displayed to the customer for current shipping method. For example „Courier

brings the goods to my address“

• Price – Shipping price for customer with VAT. Price defined here will be applied if there is

no separate shipping price declaration for the customer destination country but this ship-

ping method is available.

• Tax Id – Tax rate applied for this carrier

• Price per country – You can declare shipping price for each country. If one country is de-

clared multiple times, then latest declaration overrides all previous declarations.

o Country – Country, to which the shipping price must be declared for.

o Base shipping price – Flat shipping fee.

o Price per additional 10kg over base 10kg – Additional shipping fee on top of base

shipping price per additional 10 kilograms of the cart weight excluding base 10kg in-

cluded in base shipping price. Weight is calculated from products weight field.

o Free shipping from price – Minimal cart subtotal cost without VAT, from which

shipping cost to customer is free. Leaving this field empty disables free shipping for

this country.

o Cash on delivery fee – Enables cash on delivery payment option for specified

country when this field is filled with valid number equal or greater than 0. Cash on

delivery needs also to be enabled by activating “DPD cash on delivery” plugin. Fee

specified here would be appended to current shipping fee, even if shipping was pre-

viously free

• Disable this carrier if product's short description contains HTML comment  - If this setting is allowed and such a product exists in cart, then this

shipping method is unavailable to customer.

• Maximum allowed package weight for this carrier – Default 31.5 – If such a product ex-

ists in cart, which weighs more than 31.5kg (from products weight attribute) then this ship-

ping method is unavailable to customer. If this field is left empty then weight limitation is not

applied.

• Handling action –

o Per order – Shipping price equals configured shipping price + extra price by weight.

o Per package –Shipping price equals configured base shipping price multiplied by

number of products in cart + extra price by weight.

• Client groups who can get free shipping – If customer belongs to a group, that is marked

here, then current shipping method to the customer would be free of charge.

• Enable free shipping – When enabled and Free shipping subtotal is less or equal than

carts subtotal excluding VAT then shipping is free for the customer.

• Free shipping subtotal – If carts subtotal excluding VAT is equal or greater than amount

specified here, then customer receives free shipping for this carrier. If amount here is less

than free shipping amount specified in the customers shipping address country then free

shipping amount for the country is ignored and this configuration is used instead.

• You can define the availability of this shipping method by country. By default this shipping

method is enabled in Estonia, Latvia, Lithuania.

06/2015


http://en.e-abi.ee/

Cash on delivery for DPD

Enables customers to receive packages with Cash on delivery payment option, when they have chosen DPD

carrier.

Merchant can apply cash on delivery fee under DPD modules “Price per country” field, once fee has been

set, cash on delivery payment method becomes available.

Cash on delivery option requires contract with DPD, without it, it makes no sense to enable cash on delivery

payment method.

• Text displayed to the client – When client chooses suitable payment method, then this ti-

tle is displayed

• Description displayed to the client – When client chooses Cash on Delivery payment

method, then this description is displayed.

• New order status for cash on delivery payments – Choose suitable order status for or-

ders, which are placed using cash on delivery payment method. Defaults to pending status.

• Order status for initiating data sending without marking order as paid – Choose suita-

ble order status for orders, when customer is accepted for cash on delivery, but customer

has not paid yet. Defaults to “pending, customer accepted for COD” status. If you apply

same status to new order status, then parcel data would be sent to DPD server right after

order confirmation.

• Allow only for products which are in stock – When enabled, then cash on delivery

method would be additionally checked against product availabilities in cart and if any of

products are out-of-stock then cash on delivery would be unavailable.

Parcel data sending with DPD API

If you have set up automatic parcel data sending with DPD, then you can send parcel data as fol-

lowing:

• In PrestaShop admin panel navigate

Orders -> Orders

• Open up order information by clicking on „View“ icon

• If the order uses DPD carrier, then it is possible to send parcel data by marking the order as

paid.

06/2015


http://en.e-abi.ee/

When payment gets accepted, data is sent to DPD server and result is stored to order comments.

06/2015


http://en.e-abi.ee/

When sending data to DPD server failed, then error messages are added to the comments. Order

comments are not visible for frontend customers.

You can retry sending data to DPD server by marking order as Awaiting payment and thereafter

marking it as paid again. This will allow to re-send carrier data to DPD server.

Packing slip is sent to merchants e-mail address.

In addition Merchant can print out the packing slip by clicking on the “Print packing slip” button at

the order view.

Parcel data sending with DPD API for Cash on delivery orders

When dealing with orders, where customer has chosen cash on delivery payment method, then the order

data should not be sent by marking the order as paid since it causes module to send data like customer has

already paid for the order.

Instead special order status should be assigned under Modules -> Payments & Gateways -> Cash on deliv-

ery for DPD -> “Order status for initiating data sending without marking order as paid.”

When the order is assigned to the status, then parcel data is sent correctly with information, that customer

should pay for the package once it is being received. Sending data this way leaves the order as not-paid

thus allowing merchant to mark the order as paid once the customer has paid for the order.

06/2015


http://en.e-abi.ee/

Calling in DPD courier to pick up goods

If automatic data sending with DPD API has been set up and courier calls are allowed, then you

can call DPD courier as follows:

• In PrestaShop admin navigate

Orders -> Orders

• Locate „Order courier to pick up goods“ button from top right

Clicking on it will open up Order DPD courier menu.

• Pickup date – Choose preferred date, when courier should come pick up the goods.

• Pickup time – Choose preferred time range when courier should come to pick up the goods.

• You can declare how many envelopes, parcels, pallets courier should pick up, make sure

you enter correct amounts.

• You can also enter remark to courier by entering text in text area.

06/2015


http://en.e-abi.ee/

On success you are notified with message indicating when courier is coming to pick up the goods.

Do not forget to print out packing slips and pasting them to parcels. If you have not done that, then

you can print out packing slips by clicking on „Print packing slip“ button on the order.

If you have ordered DPD courier to pick up goods, then next time you can create another pickup

order, when current pickup order has been processed. If you try to order earlier, then you are dis-

played information message about next courier arrival.

License

Module is licensed under GPLv3 license.

In case of problems

Module is installed, but DPD carriers are not listed in the frontend

You may be using third party checkout module in your PrestaShop and may require few changes in the

code, which may result in minor extra expenses in order to make the module compatible.

If you are not using third party checkout module, then uninstall and re-install the module. If it does not

help, then contact developer.

DPD Courier carrier displays empty select menu

When DPD Courier carrier displays empty select menu as on the picture, then navigate to DPD Courier

module settings panel in PrestaShop admin and save settings. This should fix this error.

06/2015


http://en.e-abi.ee/

Other problems

If you are experiencing problems with this module, then please contact developer by contact-us

form located at http://en.e-abi.ee/vota-yhendust/ or by e-mail [email protected]

dpd – pakivedu.ee shipping module for prestashop · dpd server and print out dpd pdf packing...

Documents