PrestaShop Venipak module documentation

Optimize your daily business processes with the Venipak Carrier integration for the PrestaShop platform. One click will send an order to the Venipak system, and you will receive a parcel label. Venipak PrestaShop module is quick, easy, and effective!

This documentation describes the use, installment, and configuration of the elPresta PrestaShop module. The module is for sellers who use Venipak services and the PrestaShop e-commerce content management system.

Changes

Version Comment Date
2.1.0 - Updated Venipak logo
- Compatible with PrestaShop 1.7.8.0
- Removed COD block with picku points
- Updated checkout validation for pickup points
2021.10.21
2.0.4 - Parcel issue fix
- 1.7.x - Carrier call page fixes
- 1.7.x - Statuses fixes
2021.07.14
2.0.3 - 1.7.7.3 support
- Added additional module setting: addded checkboxes for lpexpress, lockers or both options
2021.03.14
2.0.2 - Added additional module setting: show only lockers or lockers with Pickups
2021.03.14
2.0.1 - Important Pickup points fix;
2021.02.17
2.0.0 - Small fixes;
- PrestaShop 1.7.7 support;
2021.01.25
1.0.3 - Added check for updates;
- Fixed Pickup points error;
- New feature: send email to the customer upon receipt of the parcel tracking number;
- Added "Select2" style;
2019.04.15
1.0.2 - Fixed translation issues;
- Added error notifications on label submit table;
- Pickup points prices by country;
- Updated bulk actions in order list;
2019.03.29
1.0.1 Added "Pickup points". 2018.10.10
1.0.0 Primary version of the module. 2018.10.10

Definitions and abbreviations

  1. COD - cash on delivery. Cash collection on delivery. The service is valid in B2C and when you deliver packages directly to the buyer.
  2. B2C - business 2 customer. The package is delivered to the recipient's home.
  3. API - an interface created by a computer, library, or software to allow coders access or data exchange.
  4. Label - automatically generated postage label. The label is put on the package.
  5. Manifest - a document that comes with the package.

You can find more information about services and service descriptions at - Venipak.com.


1 Installation of a module

The installation of a Venipak module is like any other module. Log in to the system and follow instructions.

  • Download the Venipak PrestaShop module.
  • Click on "Modules and Services" on the left.
  • Click "add new module" and choose the .zip file you have downloaded.

  • After adding the module, click "Install."

  • After installation, you will be redirected to the module's configuration page.

2 Configuration of a module

In order to launch the Venipak module, you need to contact your Venipak manager and receive API information:

  • API URL
  • API login
  • API password
  • API ID

Your first configuration window should look like this:

Settings
URL address
You will get login details from Venipak manager
Enter API password
You will get login details from Venipak manager

After you enter all the information, move to the next configuration form. These are various settings that are chosen according to your personal needs. You can find more information about these settings below.

Additional settings

Show "return accompanying documents"

Return of signed documents.

Possible options: Yes / No
Show "Check ID"

Check documents of the receiver before giving the package.

Possible options: Yes / No
Show "Select sender location"

Whether to show the delivery address on the generated label.

Possible options: Yes / No
C.O.D. Modules

Sending package via carrier and would like cash on delivery? Pick COD modules.

Possible options: free choice
Order status after saving

Once the Venipak system receives order information, the order status will be changed to whichever you select. For instance: the package is ready for delivery.

Possible options: it is imperative to select a status. Select "---" in order to not change the status.
Format of labels

Label generating measurements: A4 arba 150x100 mm

Possible options: it is imperative to select a size.
Show available delivery types?

Should you show buyers delivery time options?

Possible options: it is imperative to select a size.
Show door code input?

Should you allow clients to enter their house door code?

Possible options: Yes / No
Show office number input?

Should you allow clients to enter their office number?

Possible options: Yes / No
Show call before delivery input?

Should you show options of contacting the carrier before delivery?

Possible options: Yes / No
Available delivery types

The best delivery time for the clients (customer can choose between available options).

Possible options: yes / no

Moving on, you will have to create at least one warehouse (a place from which you ship items) and at least one sender (information about the sender). If necessary, you can create more of warehouses or senders.


3 Functionality

Venipak integration module creates a new carrier in the system, reflects additional information in the order window and provides an extra window for manifest management.

3.1. A configuration of a carrier

A configuration of a carrier is done through the PrestaShop carrier management.

Click on the editing of carriers and apply your choices: the name of the carrier, logo, prices, possible countries/zones of delivery, etc. These are basic PrestaShop carrier settings.

3.2. Order window

After you install Venipak integration module, take care of settings, carrier settings and receive your first order with a Venipak carrier, you will see a new window.

Double-check the information and fill the missing fields:

  • Number of packages
  • Total weight
  • Check whether they picked COD and whether the sum of COD is correct
  • Check whether the delivery address is correct

You can find more information about the main settings used in the table here:

# Variable Description
1 Packets Number of packets in the order. This setting generates the number of labels.
2 Weight Total weight of the package. Venipak module automatically adds weights of all the items.
3 Pickup address Delivery pickup address (your wareohuse).
4 Delivery option Delivery time selection
5 Package preparation time Package preparation time. You can prepare packages 5 days forward. Creating a package forward a new manifest is created.

Extra settings (activated in module settings):

# Variable Description
1 C.O.D Cash on delivery - Yes / No
2 C.O.D Amount Sum of cash (carrier will take this sum from customer)
3 Sender Information of a different sender. Label shows another sender, but the carrier picks the package from your warehouse
4 Comment – door code Door code value
5 Comment - office no Office number value
6 Comment - warehouse number Warehouse number
7 Comment - call before delivery Does the carrier have to call before making a delivery?
8 Return documents Should you return signed documents?
9 Check recipient ID Should you check recipient's ID information?

Extra fields like door code, warehouse number, call before delivery, delivery time, etc. will appear and fill themselves according to the client's information. If the settings are turned off, they will not appear.

After filling the necessary information, click "Save". You will receive a confirmation that the Venipak system received the order. You can print a label by clicking "Print labels".

3.3. Manifests

Previously sent orders and active manifests are available on the manifests page. To find it, go to main menu -> carriers - > venipak.

Using this list, you can print labels and delivery lists.

When in need, you can order a carrier. Click on "Call venipak carrier" and fill the information.

# Variable Descriptions
1 Weight Total weight of the package. Venipak module automatically adds weights of all the items.
2 Pallets Number of pallets. If there aren't any, enter "0."
3 Date of arrival Requested date of carrier's arrival.
4 From - To Arrival time interval must be 2 hours.
5 Comment This field is not imperative. Extra comment for the carrier.

Attention: when ordering a carrier, pick the warehouse. Main warehouse is usually used. You can select a new main warehouse via module settings.


4 Error codes

Facing an error? Specify the meaning and solution of the error.

# Error code Description
1 42: Pack number PACK_NO is in use already Error occurs when you reinstall the module or the module is installed for an old client (API has already been used).
Go to module settings, click on "Pack No. (last 7 digits). Enter new packet number.

5 Frequently asked questions

Frequently asked questions and answers.

The installation of a Venipak module is like any other module. Log in to the system and follow instructions.
  • Download the Venipak PrestaShop module.
  • Click on "Modules and Services" on the left.
  • Click "add new module" and choose the .zip file you have downloaded.
  • After adding the module, click "Install."
  • After installation, you will be redirected to the module's configuration page.
Read more about PrestaShop modules
Like any other module, you can remove the Venipak module by following a standard module removal procedure.

Read more about modules configuration
You can select Venipak carrier's price through the PrestaShop carrier management settings. Click on the editing of carriers and make configuration according to prices or weight, zones, and other settings.

PrestaShop offers a free "cash on delivery" module which is available in the general store. You can install and modify the module, offering your clients COD services.

Extra changes or COD+ payment come separately.


6 Support

Consultations and technical support cost 35 € per hour.