InPost UK Limited OpenCart Integration Guide Version 1.0
CONTENTS Purpose of Document... 4 Target Audience... 4 How to access... 4 Other Software Required... 4 Files to Be Uploaded... 5 vqmod... 5 Module... 5 New Files... 5 Activate vqmod... 6 Set up inpost... 7 Switching On The Module... 7 Label Format... 8 Permissions... 9 Switching On The Inpost Shipping Method... 11 Parcel Creation... 15 Review The Parcel... 16 Edit Parcel Details... 17 Edit Parcel Once Parcel Created... 18 Parcel Creation... 19 Creating The Label... 20 Cancelling A Parcel... 21 Filtering The Parcel List... 22 Filtering... 22 Ordering... 23 Page 2 of 23
This page is intentionally left blank Page 3 of 23
PURPOSE OF DOCUMENT This is a user guide that describes the steps necessary to integrate the InPost shipping method with the OpenCart version 2.x online store. It describes the changes that make the InPost shipping method appear in the checkout for customers to pick. TARGET AUDIENCE The target audience are clients using OpenCart who are either technically literate or a developer for such a client. HOW TO ACCESS The OpenCart platform is accessed using an administrative login. It will be of the form http://your_site/admin All pages are viewable in the major browsers with JavaScript switched on in. OTHER SOFTWARE REQUIRED To allow for modifications of the OpenCart software without editing the core code vqmod https://github.com/vqmod/vqmod is used. This will be described in detail below. Page 4 of 23
FILES TO BE UPLOADED VQMOD To prevent the changing of core OpenCart code a smart caching tool called vqmod is needed. There is a version of this specifically for OpenCart. Its latest link is, https://github.com/vqmod/vqmod/releases and there is a link on the page, Figure 1 Download vqmod Take the ZIP file downloaded and extract the code. Follow the instructions provided in the readme provided. Please note that the version number may be higher than the one shown above. MODULE There is also a vqmod module available. Go to http://www.opencart.com/index.php?route=extension/extension/info&extension_id=19501 and download the latest release. This module makes it very easy to apply the vqmod to your system. Simply copy the files into the root directory of your site and allow it to override the two files contained. The instructions below all refer to the vqmod module. NEW FILES To get InPost to show on the checkout of your site you will need to copy the install files into the root folder containing OpenCart. You will need to copy all of the files in the plugin ZIP file into the main folder of the shop. You must extract the files from within the ZIP archive first using Windows Explorer, WinZip or 7 Zip. Once you have extracted the files you should see, Figure 2 Files to be uploaded The contents need to be uploaded onto your web server. One of the easiest tools available to do this is FileZilla. It is a FTP client which is very easy to use. Page 5 of 23
ACTIVATE VQMOD To allow the checkout override to work you must make vqmod rebuild the files. To do this you must go to the main menu -> Modifications. Figure 3 Activate vqmod Changes On the top right hand side there is a button for Refreshing any new made changes. It is the blue one with the two arrows on it. Click on that button, Figure 4 Locate the Refresh Button And a message will show saying that Figure 5 Click the Refresh This shows that the vqmod changes are in place. If any other vqmod files are changed or uploaded, you will need to click on the Refresh button again. Page 6 of 23
SET UP INPOST SWITCHING ON THE MODULE Once the new plugin code is uploaded to the server the module needs to be installed into OpenCart itself. Please note that there are two modules as part of this. One provides a new shipping method for the customer to select, the other provides the back end functionality for the site. You MUST enable both methods. To do this go to the Main Menu -> Modules Figure 6 Find the InPost Module This screen shows a list of all of the modules in the system. Scroll down the list until you get to the InPost Shipping item. Figure 7 List of Shipping Methods Click on the Install button, the green one with the + symbol on it. Once it is installed the icon changes. Page 7 of 23
Figure 8 InPost Shipping Method Active You must then configure the InPost shipping module. Simply click on the Edit blue pencil icon. Here are shown some of the fields. Figure 9 InPost Module Fields One of the fields is the API Key. We will send you that via email and you cannot create parcels without this. Each of the fields shows what a typical value should be. These values should be used. API Key: As supplied URL: https://api-uk.easypack24.net/ Maximum Weight: 15 (kg) Maximum Size A: 8x38x64 (cm) Maximum Size B: 19x38x64 (cm) Maximum Size C: 41x38x64 (cm) Label Format: PDF or EPL2 LABEL FORMAT It is possible to create labels using either PDF or EPL2 format. PDF These need to be printed out using a standard printer. E.g. laser jet or inkjet. EPL2 These need to be printed out using a bar code printer. E.g. Zebra. When you change the label format all subsequent labels produced will be of that type. But you can change back and forward between the two label formats as required. Page 8 of 23
PERMISSIONS After the InPost module is switched on a new menu item will be displayed under the Cart section of the menu. Figure 10 New Menu Item Before you can access this screen you will need to give the appropriate user group permissions to view and edit InPost parcels. To do this go to the User Group menu item off of Settings. Figure 11 Locate the Permisions Form From here select the user group you wish to allow viewing and editing of the InPost parcels. Simply click on the edit button on the right hand side. This will then show a screen with a list of Access and Modify permissions. Either scroll down to the module/inpost or simply click on the select all option. Don t forget to do both Access and Modify. Page 9 of 23
Figure 12 Provide User Permissions Click Save once you have finished editing the permissions. Page 10 of 23
SWITCHING ON THE INPOST SHIPPING METHOD To enable the InPost shipping method you must go to the Shipping menu item. Figure 13 Locating InPost Shipping Method This screen will show a list of all of the shipping method that can be enabled / disabled. Page 11 of 23
Figure 14 Display Before Enabling InPost Shipping Method You must first install the InPost Shipping method. Click on the green + Install symbol on the InPost Shipping row. The symbol will change to, Figure 15 Installation Button Figure 16 After Installation Has Been Processed Then you must setup the information for the shipping method and enable it. Click on the Edit pencil symbol shown in blue. Page 12 of 23
This will then show the InPost shipping options. Figure 17 Screen Showing Shipping Fields The form fields are: Display Delivery Weight Show the estimated weight of the parcel on the checkout or not? Weight Class Which unit should the weight calculation use? Tax Class Is the shipping method a taxable one or not? Geo Zone In which zones is the shipping method to be shown for? Rate What price will be added to the cost of the order for using this shipping method. Status Is the shipping method enabled or not? Sort Order In which order will the various shipping methods be shown? The rate that you charge for the InPost shipping method will be based upon the contract that we negotiate with you. For the InPost shipping method to show in the checkout you must change its status to be Enabled. Click on Save to make your changes. Page 13 of 23
Once the InPost shipping method is enabled it will look like, Page 14 of 23
PARCEL CREATION Once customer have placed orders to be shipped to a locker and paid for the goods, you will then create the parcel. This requires two steps: 1. Create the parcel 2. Create then print the label To do this go to the Shipping Menu and click on InPost Parcels. Figure 18 Sales Menu Showing InPost Parcels Link The system will then display a list of all of the InPost parcels. Page 15 of 23
Figure 19 InPost Parcels Main Form REVIEW THE PARCEL Before creating the parcel it is good practice to review the parcel details. To do this click on the View eye icon. This will then show you all of the information about the pending parcel. Make sure that the size of the parcel selected is large enough for the goods to be shipped. If needed the courier can select a larger sized compartment. Page 16 of 23
Figure 20 InPost Parcel Details You can go to the Edit Parcel page if you need to by clicking on the Edit Parcel pencil icon. See below for editing the parcel details. EDIT PARCEL DETAILS To edit the details of the parcel click on the Edit pencil icon. Please note that once a parcel is created against an order line the number of editable fields is reduced. Only the size of the parcel can be changed after that point. This will then show you the details for a parcel. Page 17 of 23
Figure 21 Editing a Parcel's Details Fields: Order ID The sales order number (read only) Parcel ID The InPost parcel ID (read only) Machine The customer s selected target locker machine Email The email address of the customer Mobile The mobile number of the customer (last nine digits) Size The size of the locker compartment selected. Once you have finished editing the details click on the Save disk icon. EDIT PARCEL ONCE PARCEL CREATED These are the fields that can be edited once a parcel ID has been allocated against an order. Page 18 of 23
Figure 22 Editing a Parcel After It Is Created Only the size is changeable. Once you click on Save the system will attempt to update the InPost central system with the new details and then update the localy held data. PARCEL CREATION To create a parcel once the order is paid for select it by clicking on the checkbox beside the order number. Then on the top right hand side click on Create Parcel. The system will then process the order and put in a request to create a new parcel from InPost s central system. The screen will refresh and new parcel ID will be shown against the order line. Note that the parcel ID may be of a different format. Page 19 of 23
CREATING THE LABEL After you have created the parcel for an order line and verified the size of the parcel you will need to create the label. When you create the label a notification is sent to the carrier that you have a parcel ready to be collected. This will appear on the carriers manifest and they will come and collect the parcel on the next day. To create the label, select the order number that you wish to create the label for by clicking in its check box. Then click on the button at the top right hand side Create Label. If you select more than one parcel to create a label for the PDF will contain two, three or four parcels per label. The form will call the InPost central system and download the label to your computer. A dialog will show asking you where you would like to save the file to. The exact action will depend on the settings you have in your browser. Figure 23 Saving The PDF File A copy of the label is also saved on the server in case that the downloaded label is lost. To access the server label, click on the link that will be shown on the order line. Simply click on Click Here and a new window will open with the label displayed in it. Page 20 of 23
Figure 24 Multiple Labels on One Sticker CANCELLING A PARCEL If you find out that a parcel is no longer to be delivered to an InPost locker or the dimensions are too large you can cancel a parcel. Simply select the order line by clicking on its checkbox and then click on the Cancel Parcel button. The form will then refresh and the status of the parcel will be changed to Cancelled. Please note that once a parcel is cancelled the only way of changing the status back is by calling the UK support team on 033033 50950 and speaking to customer services. Page 21 of 23
FILTERING THE PARCEL LIST FILTERING To help you find the order or parcel ID that you need to look at or process we have put several fields onto the parcel list form. They look like, Figure 25 All Of The Filtering Fields Each field can be filtered upon. Fields Order ID The sales order number Machine ID The locker terminal name Parcel ID The parcel identifier generated by InPost Parcel Status The current parcel status Creation Date The date that the Sales Order was created on Sticker Creation Date The date that the label was produced for the parcel The two date fields when you click on the calendar icon show a date picker. Figure 26 The Date Picker After you have entered the filter criteria you wish to search upon simply click on the Filter Orders button. Note that the date items specify an exact day that the system uses to search for the order to show. Page 22 of 23
Once you are done filtering orders simply empty the field(s) and click on Filter again and all of the orders will be shown. ORDERING Another way of trying to find an order is to re-order the data shown in the form. Each of the column headers, except file name, activates a sort of the data by that column. Clicking once will order descending and then clicking again will change to ascending sort. The column header will show the appropriate arrow indicating the sort order. Figure 27 Ordering by Order ID Page 23 of 23