Integration Manual
Contents
1. shipping information which is returned either by an integrated Front End or by REST web services can be stored in your Back office or ERP system and is automatically stored in the systems of bpost This covers information such as shipping address product client name etc It is possible to manage the information through the Shipping Manager Back End which is hosted by bpost E tailers can access it via the bpost portal to manage orders select options and generate labels Generated labels can be printed by the Shipping Manager and can be used to launch the logistic flow It is possible to follow the shipped parcels with the integrated Track amp Trace tool Apart from this solution the bpost Shipping Manager allows the deep integration of its functionalities into ERP or other back office systems This deep integration is thoroughly explained throughout the following sections and in the chapter Web Services Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 6 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww rd bpost 3 Prestashop module 3 1 Before installation In order to have access to the bpost Shipping Manager you must have a bpost contract sign the bpost Shipping Manager License Agreement and obtain2. the appropriate delivery method and options All the information is automatically sent to the bpost systems and all the information is also returned via URL redirect POST parameters to the web shop The consumer then comes back to the web shop to validate and pays the order Afterwards the web shop can send a confirmation to bpost in order to validate the sale after payment via another POST URL redirection or via a REST web service 2 3 2 Back End The bpost Shipping Manager Back End is a web based solution that allows your e business to e Manage shipments e Select additional options e Generate labels e Link web orders to parcel shipping e Access Track amp Trace information e Manage returns Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 5 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww ee bpost bpost shipping manager Back End Solution Shipping Information Manage shipments information storage and options An ic Bpost shipping systems Label printing wS Back office order management Figure 2 bpost Shipping Manager Back End solution In Figure 2 we show you the process in which the Back End is placed The following steps show how the process works The
3. 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww ge bpost 2 Introduction This document describes the installation procedure of the bpost Shipping Manager Prestashop Module Please note that the Shipping Manager Integration Manual does not explain how to use the Back End of the Shipping Manager used for the management of orders and the generation of labels Please refer to the bpost Shipping Manager user guide if you want to work with the Back End interface The plugin has been developed by Produweb commissioned by bpost Parcels Europe in August 2012 For contact details Produweb bpost Parcels Europe 32 4 344 14 00 32 2 276 28 12 Rue de Latin 149 Muntcentrum 4000 Li ge 1000 Brussel http www produweb com http www bpost be shippingmanager 2 1 Required knowledge In order to use this manual you need knowledge of the following topics e Prestashop administration e HTTPS The bpost Shipping Manager is an application that is created for any framework or e Commerce solution For Prestashop a specific module has been created The bpost Shipping Manager runs in an HTTPS environment in order to safeguard the communication of private data bpost strongly recommends using https and does not support integrations in http environments 2 2 Compatibility Compatibility with Prestashop versions The bpost Shipping Manager Prestashop module is tested for following Prestashop versions o 1 4 x 1 5 x
4. 2 3 bpost Shipping Manager solution The bpost Shipping Manager is a plug and play solution that is available for national and international shipping It allows your business to manage shipping and returns and to print labels The bpost Shipping Manager solution contains a Front End and a Back End solution Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 4 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww bpost 2 3 1 Front End The bpost Shipping Manager Front End is an online solution for your e business to offer bpost delivery options to consumers bpost shipping manager Front End Solution Select products Check out Select delivery options Payment Confirmation a Se Figure 1 bpost Shipping Manager Front End solution The Front End fits seamlessly into the order process which is shown in Figure 1 The following steps show how the process works First the consumer selects his desired product s in the web shop Next the consumer enters his credentials and performs a check out During the checkout process when selecting the delivery method address the consumer is redirected via URL POST parameters to the Shipping Manager Front End In the Front End he selects
5. an account ID password to configure the application Please contact the bpost parcels sales team at 32 2 276 28 12 or send an email to shippingmanager bpost be 3 2 Installation Install the module from Prestashop Addons http addons prestashop com or copy files directly from the archive into the modules directory of your Prestashop installation 3 3 Configuration 3 3 1 Configuration of the module Maintenance of the module can be done in the Administrator back end once the module has been installed The configuration of the module will be made accessible via Modules gt Shipping amp Logistics gt Bpost gt Configuration Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 7 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww a bpost Bpost 7 Description Bpost allows you to offer buyers 5 modes of delivery BPACK 24 7 BPACK WORLD BPACK WORLD express BPACK HOME BPACK bpost A Bpost Manager Bpost ID 107419 Id user for back office Bpost Key DEMO_SHM Secure key for back office Bpost Fancybox Y OX If you enable this option the page of Bpost will displayed in a fancybox Save Information Please fill in these t
6. bpost bpost shipping manager Prestashop module User manual Version 0 3 Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 1 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww d bpost Table of Contents 1 Glossary OF TerMSsssssnisisossvsossressisissrossssescssesssoeesensisesnss cors i assaia isise 3 2 Introduction civeceicceciseiceestcesssciansenvovecestsciedeivcestsoceostebenseonesecnesvoceecsusaadeaedssaeas 4 2 1 Required knowledge ives ciciccee cecceseesscsce se sncscceesscccnee seszcseeseedcese seateseostscenseseszeseesate 4 22 Compatibility iss aise cise ives sscicene sexeesee ssei cess seasenee snadense sess OSEE TEETER T 4 2 3 bpost Shipping Manager solution ssssececcsssececcssssceccssssssccsssssccasssssseaneees 4 Zod MENON EMG esecucaceserectcorscecscxeutectcocsasecceustvaseneuce cecteranicessececav O oss 5 PRE T Back Eid iscsi ccvcsscnccisedvaceiceccuesssescSevavtecnsesceevvastincssgueccavbceeviessncdeasdvncebiucce covdes ihevessornesbaeevarssaes 5 3 Prestashop MOGUe issiiisasssssiskessevrssasrssqravesesnaliniissasieiasnissanediiaiensiesesiie 7 3 1 Before installation vncecscsccscsssssssscsesveesesisvssessosvessedscnseecsevseesesiseseessevesssndsenenes sevens 7 BZ WASTANAU OM sessscccs
7. cdvsisccesssccetccnseccndssccevccanesstudescestccensetvdedcessecdasteteecsadestaentccbeceteds 7 3 3 CONMBUL ALON si iissceceteeacisissedcedssseascsassecdedesessssesssnccadisacassaasanededssocediaasandsecssbeassens 7 3 3 1 CONMUFALOMIOT EME MOGUI ES rsss ATE e EE E R EEEa E 7 332 ACCOUNT ID and passphrase ssis rsen useissa ceaesasacdnasvensdaatede condessaessedudeoiaadesacdoucaties 8 3 3 3 REtUMURES saersi ra tae cued stv echoes eE EAs T ch rue suned ate EEEE ETEEN ANEN EEE AENEA 10 3 4 Frontend INtegratiOnisesceccisscssccsccssaccccdessecsncssascsucesaccscccaasesstesacsscccuncconsssaseseuess 10 SAA WAV OUP GES Oiy sete ssececvcuctsscsnnetevnycoasseiesncusecsent codons REA A E A A E E 10 3 4 2 Consumer selects delivery method ccccceccessssecccccecsesneeeeeescessesssaeseeeesceeseeaseeeeeeeeene 11 3 4 3 Order confirmatio Mess icccdsn ccnsdesecenecne enone decdsiekenses vipcnsdsnncdesncsedssincdensvarttscaladenedpsonevedgt teensy 12 BiB AAP E E ANE A A AA N 13 4 Appendix seanina iaae a es aE a Aaaa E aR EEEa Sse 13 4 1 Supported versions of Prestashop ssssssssessesssesessessesssecesosssesssscesesseesseseesess 13 4 2 Unstallation sccsssisvececsavevestscsvesesaeveensedsvvcescsaveesssaneesoonaveensssiveeesoaveenstscsseensaaye 13 Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 2 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entit
8. hree addresses in your Back Office Bpost Confirm url http dev1 dexis be modules bpost validation php Cancel url nttp dev1 dexis be order php Error url http dev1 dexis be modules bpost validation php bpost Shipping Manager Prestashop module parameters Parameter Possible values Description bpost ID String Fill in your bpost account ID 6 digits Key String Fill in the passphrase which is set in the bpost Shipping Manager back end Fancybox Boolean Displays a lightbox instead of being redirected to a seperate bpost page Enable if you prefer your customers to remain in your environment 3 3 2 account ID and passphrase In order to use the module in Prestashop a bpost account ID is required The administrator is able to set a passphrase in the bpost Shipping Manager back end which can be found after login into the bpost portal at https www bpost be portal goLogin After Login go to Shipping Manager gt Admin gt edit shop If the option is greyed out you do not yet have access to the application Please contact your account manager or send an email to shippingmanager bpost be After the bpost Shipping Manager License Agreement was signed you received a user manual In this document more information on how to use and configure the back end is explained Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 bpost limited company under public law Cent
9. ies Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww ge bpost 1 Glossary of Terms Throughout this document the following terms and abbreviations are used They are explained in this table Term Definition ERP Enterprise Resource Planning The technology solutions for large companies or other organizations to manage their resources including customers supplies accounting and other back office activities Lightbox A simple unobtrusive java script used to overlay websites It is easy to setup and works on all modern browsers PUGO Pick up amp Go bpost delivery method For more information please visit www bpost be Bpack 24 7 bpost delivery method For more information please visit www bpost be BPACK bpost The new name of PUGO a delivery method of bpost Consumer End user customer of a webshop Customer back end Prestashop pages available when the shop owner is logged on Administrator Person responsible for sending the parcels Administrator back end Prestashop back end for administrator bpost platform bpost Shipping Manager platform Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 3 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000
10. ing page The customer has to complete the process in the modal box in order to return to the Prestashop checkout process The customer can close the modal box by clicking the close icon in the top right corner of the iFrame canvas This will also deselect bpost as shipping method Select your delivery method O G home or office pick up point bpack 24 7 Delivery at your doorstep or at bpack bpost get your parcel Have your parcels delivered in your office bpack home is delivered in one of our 1 100 one of our parcel automates the most convenient option for pick up points Very convenient centrally you located always open 24 7 10 00 5 00 Image 3 bpost Shipping Manager When the process in the modal box is finished successfully the bpost platform will be closed automatically Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 11 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww a bpost The bpost platform sends the details from the selection back to the Prestashop platform which will trigger an update of the shipping method cost and address The customer will automatically continue to the next step without having to click the button continue It is important that the envir
11. on of colours and logo s Please refer to the User Manual which was received after the bpost Shipping Manager License Agreement was signed Below are shown the default layout and an adapted version Huidige leveringsmethode thuis of op kantoor Fa Currently selected delivery method home or office gt 2 2 bpost thuis of op kantoor in een afhaalpunt in een bpack 24 7 home or office pick up point bpack 24 7 Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 10 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual Pd J bpost 3 4 2 Consumer selects delivery method The bpost module is seamlessly integrated on the Prestashop carrier page If the checkbox is selected the consumer is automatically sent to step 4 and the iFrame as shown in image 12 is opened In the 4 step shipping method the shipping methods are listed per carrier Each carrier can have a single or multiple shipping methods O D With Bpost do you deliver wherever you want bpost Image 2 Default Prestashop way to show shipping methods When the customer clicks the bpost logo a modal box including an iFrame with the bpost Shipping Manager loaded will appear on top of the page disabling all the fields on the underly
12. onments bpost and Prestashop work within the https protocol If not some browsers may report unsecure content on the page because there is a mix of secure and unsecure content on the page bpost does not support the http protocol 3 4 3 Order confirmation On the order confirmation page the selected delivery method and costs associated with it will be available gt Commande n 000032 E Facture E Voir la facture amp Voir le bon de livraison 2 Imprimer la page Facture n FA000011 Cr e le 09 08 2012 09 53 06 09 08 2012 09 53 06 ie Pr paration en cours Informations transporteur Pr paration en cours Modifier Poids total 0 500 kg amp Informations client Transporteur BPost a 0 2 Bon de livraison n L1000007 O ooo gmail com Compte cr le 24 05 2012 09 50 27 D tail de la commande Commandes valid es 10 Total pay depuis la cr ation du compte 8 687 49 Panier original Panier n 000038 Mode de paiement Cash on delivery COD iis Sources cashondelivery Produits 158 07 Grigios sponte Origine prestashop bpost www5 produweb be apo z Vers bpost p dev product php id_product 1 Total 168 07 e 28 06 2012 15 35 11 E Origine prestashop bpost www5 produweb be Emballage recycl Paquet cadeau X Vers bpost p dev order php step 1 Adresse identique Reference BPOST 00038 Method Regular Prix BPOST 10 Prix Total 10 amp Adresse de livraison Ad
13. re Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 8 13 bpost shipping manager Integration Manual ww I bpost Enter the name of your webshop in the Name field and add a Passphrase Be sure to use a Passphrase that follows the password security best practices 105704 New Shop Algemene instellingen Verzend adressen Verzendingsmethodes Layout Accountid 105704 Name New Shop k Confirm url httptest bpostlocal bpost confirm ki Error url httpv testbpostlocal bpost error phy ig Cancel url http test bpostlocal bpost cancel f i Terug naar shop overzicht Image 1 Credentials in bpost Shipping Manager back end The administrator will have to enter the account ID and Passphrase manually in the configuration of the Prestashop backend Important The passphrase can be changed in the bpost platform by the administrator Once done the Prestashop module will not be able to connect to the bpost platform anymore unless the password is likewise modified in the Prestashop back end Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 9 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww bpost 3 3 3 Retu
14. resse de facturation eae 7 Pi Belgique Belgique Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 12 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1 bpost shipping manager Integration Manual ww ge bpost 3 5 Back end integration There is no integration foreseen for the usage of the back end In order to print labels and follow up track amp trace please use the back end of the Shipping Manager For more advanced integrations and automatic emailing of the Track amp Trace number to the customer please contact your preferred Prestashop supplier and your bpost account Manager 4 Appendix 4 1 Supported versions of Prestashop Compatibility with Major releases like for example Prestashop 1 4 0 to 1 4 3 may lead to incompatibility off the module 4 2 Installation The module is available as Prestashop Addons Confidential Copyright 2011 by bpost All rights reserved Version 0 3 31 10 2012 13 13 bpost limited company under public law Centre Monnaie 1000 Brussels VAT BE 0214 596 464 Legal Entities Register Brussels Postal Current Account IBAN BE94 0000 0000 1414 BIC BPOTBEB1
15. rn URL s In the bpost Shipping Manager back end a number of return URL s need to be entered They should be created based on the following structure http BASE URL modules bpost bpost validation php The following actions are available Confirm url confirm http BASE URL modules bpost bpost validation php Error url error http BASE URL modules bpost bpost validation php Cancel url cancel http BASE URL order php Example If your webshop is http www yourwebshop com the following URL s need to be setup Confirm url http www yourwebshop com modules bpost bpost validation php Error url http www yourwebshop com modules bpost bpost validation php Cancel url http www yourwebshop com order php The correct URL s can be found at the bottom of your Prestashop plugin setup page 3 4 Front end integration In this part we will point out what changes to expect during the checkout process when the Shipping Manager shipping method is enabled 3 4 1 Layout design Prestashop is distributed with a default look amp feel which can be customized per installation Therefore the module will be integrated in the out of the box Prestashop theme template and is customisable by following the standardized Prestashop template mechanism For the bpost platform shown in an lightbox inside the Prestashop checkout the styling can be done through the bpost platform administration pages This allows the adaptati
Download Pdf Manuals
Related Search