SendCloud OpenCart 2 Extension Documentation

Transcriptie

1 SendCloud OpenCart 2 Extension Documentation Release Comercia 05. July 2017

2

3 Inhoudsopgave 1 GitHub README info Links Versie ondersteuning Hulp van Comercia Hulp van SendCloud Installatie De SendCloud Extensie downloaden De SendCloud Extensie uitpakken vqmod Installeren De SendCloud Extensie uploaden De SendCloud API sleutels bemachtigen Activeren van de SendCloud Extensie De SendCloud Extensie instellen Gebruik Orders transporteren naar SendCloud Orders verwerken in SendCloud Afhaal locatiekiezer gebruiken Foutmeldingen Building the extension package Installing prerequisites Get the repository Building the Extension Releases i

4 ii

5 Deze documentatie is automatisch gegenereerd. Inhoudsopgave 1

6 2 Inhoudsopgave

7 HOOFDSTUK 1 GitHub README info Deze extensie stelt je in staat om orders vanuit OpenCart 2 naar SendCloud te transporteren. Vervolgens kun je de bestellingen verwerken vanuit het SendCloud platform. Deze extensie is officieel ondersteund vanuit SendCloud BV Voel je vrij om mee te helpen aan de verdere ontwikkeling van deze module. Links Module Documentation: English: Nederlands: OpenCart Extension Store: Dutch OpenCart Specialist (OpenCart module support): SendCloud: SendCloud API documentation: SendCloud API Wrapper PHP (Official): SendCloud API Client by Picqer (Unofficial): Versie ondersteuning Deze Extensie is bedoeld voor OpenCart 2.0. Een niet open-source versie van de extensie voor OpenCart 1.5.x kan gedownload worden in de OpenCart Extensie winkel Je webwinkel updaten naar OpenCart 2 is aangeraden om te kunnnen profiteren van de laatste updates. 3

8 Hulp van Comercia Wanneer je ondersteuning nodig hebt op het gebied van OpenCart in zijn algemeen of OpenCartintegratie met SendCloud, neemt u contact op met support@comercia.nl of maak een ticket aan op Hulp van SendCloud Als je hulp nodig hebt dan kun je contact opnemen via: contact@sendcloud.nl 4 Hoofdstuk 1. GitHub README info

9 HOOFDSTUK 2 Installatie Opmerking! Een SendCloud is nodig om deze extensie te gebruiken. Je kunt hier een account aanvragen. 1. De SendCloud Extensie downloaden. De gemakklijkste manier om de extensie te bemachtigen is via de OpenCart Extensie Winkel Dutch OpenCart Specialist (OpenCart module support): 2. De SendCloud Extensie uitpakken Pak het zip bestand uit op een locatie naar keuze op je computer. 5

10 3. vqmod Installeren Als je vqmod al geïnstalleerd hebt kun je deze stap overslaan. Ga verder met stap Download de laatste versie van vqmod voor OpenCart vanaf GitHub: 2. De makkelijkste manier op vqmod te installeren is aan de hand van deze video: 3. Of je kunt deze handleiding volgen: 4. De SendCloud Extensie uploaden Verbind met je webwinkel middels je favoriete FTP client. Als je nog geen FTP client hebt kun je FileZilla gebruiken. Upload de bestanden uit de upload in de extensie map naar je webwinkel. 5. De SendCloud API sleutels bemachtigen Login in het SendCloud Panel met je SendCloud account. Kies Integraties. 6 Hoofdstuk 2. Installatie

11 Op het volgende scherm, klik de groene Connect knop onder het SendCloud logo. Op de volgende pagina kiest u een naam voor uw integratie, bijvoorbeeld OpenCart of de naam van uw webshop en vult u deze in, in het Naam veld. Nadat u op Save heeft geklikt, worden de API keys automatisch gegenereerd De SendCloud API sleutels bemachtigen 7

12 Kopieer de public en secret key. 6. Activeren van de SendCloud Extensie Login in de OpenCart admin. Ga naar Extensies -> Modules en klik op de groene knop bij de SendCloud Extensie. De SendCloud extensie is nu geïnstalleerd. 7. De SendCloud Extensie instellen Klik op de blauwe edit knop. Voer je API public & secret key in. Kies de order status die je wilt instellen na het exporteren en sla de instellingen op. 8 Hoofdstuk 2. Installatie

13 HOOFDSTUK 3 Gebruik Orders transporteren naar SendCloud Nu de extensie is geïnstalleerd kun je de orders naar SendCloud overzetten. Ga naar je bestellingen in de OpenCart admin. Verkopen -> Orders. Selecteer vervolgens de orders die je wilt overzetten en klik op de knop met het SendCloud logo. Orders verwerken in SendCloud Login in het SendCloud Panel met uw SendCloud account. In het blauwe top menu, selecteer het plug icoontje (als u meerdere integraties actief heeft, kunnen er meerdere icoontjes in deze balk staan, in dit geval kiest u het plug icoontje voor uw nieuw opgezette integratie). 9

14 Op de overzichtspagina die toont nadat u op het plug icoontje heeft geklikt, vindt u de orders die verstuurd zijn via de SendCloud module vanuit uw OpenCart webshop. Afhaal locatiekiezer gebruiken Om de afhaal locatiekiezer te gebruiken opent u de module in OpenCart en klikt u Choose checkout method / Kies een kassa module. Er verschijnt vervolgens een dropdown waarin u uw kassamodule kunt kiezen. 10 Hoofdstuk 3. Gebruik

15 Op dit moment is er support voor de standaard OpenCart module en de Journal Quickcheckout module, ondersteuning voor andere checkouts zal volgen. Na het selecteren van uw gewenste kassamodule klikt u op de groene knop Apply om de instellingen uit te rollen, en vervolgens op de blauwe knop bovenaan om het geheel op te slaan. Foutmeldingen Een of meerdere orders heeft geen verzendgegevens (shipping details). Ga naar het detailoverzicht van de order en kijk of de verzendgegevens zijn ingevuld. Let erop dat betalings gegevens niet hetzelfde zijn als de verzendgegevens Foutmeldingen 11

16 Er is iets mis met de koppeling met SendCloud. de public key en/of secret key zijn misschien niet goed ingevuld. Kijk na of de keys hetzelfde zijn als in het SendCloud Panel. De orders kunnen niet overgezet worden naar SendCloud. Dit gebeurt wanneer er geen geschikte verzendmethode beschikbaar is voor de order. Je kunt contact opnemen met het SendCloud support team om te kijken of het mogelijk is om een geschikte verzendmethode te activeren. 12 Hoofdstuk 3. Gebruik

17 HOOFDSTUK 4 Building the extension package Getting a complete package is not as easy as cloning or downloading the repository. You need to perform serveral steps to build a folder with all files for installing and the documentation. WARNING: If you're using Windows, Cygwin is highly recommended! Installing prerequisites To build the package you need the following: Python 2.7 Linux/UNIX command line or Cygwin (Windows) with CURL and GNU MAKE The documentation is build with Sphinx and rst2pdf. Because rst2pdf is Python 2.x only and because we use >= Python 2.7 commands you need a Python 2.7 interpreter. The best way to setup the Python environment is to setup a correct Python enviroment with all the required packages is to create a virtualenv. 1. Install virtualenv If you don t have virtualenv installed yet install it by using: pip install virtualenv Note: You need pip to install packages. Install pip by following this guide: Guide to install pip 2. Setup a virtualenv for building the Extension and documentation First move to the location where you want to place the virtualenv. You can do this in the root of the project. The env/ directory is ignored by git. Create the virtual environment virtualenv env Activate the environment. (Linux/Mac OSX) env/scripts/activate (Cygwin) or source env/bin/activate Check if your virtualenv is activated. You should see (env) before your command input. Install Sphinx and rst2pdf : pip install -r requirements.txt 13

18 Get the repository You now need to download or git clone the respository. Move it to a location which you prefer to continue with. Building the Extension 1. Move into the extension s folder root. 2. Be sture that you have activated the virtual environment. 3. Execute make build. 4. See if the extension is build in the dist/ folder. Deze pagina is nog niet vertaald en daarom wordt de Engelse versie weergegeven. 14 Hoofdstuk 4. Building the extension package

19 HOOFDSTUK 5 Releases Make location picker compatible with multiple Sendcloud supported countries. Added an option to restrict carriers in the location picker. Made the VQMod more generic to avoid clashes with other modules. Minor bug fixes Fixed issues with parcel creation Added partner header. Minor bug fixes and CSS outlining Added location picker Updated the Comercia Framework Compatibility fixes for 2.0.x Updated documentation. 15

20 1.0.5 Minor bug fixes Added 2.3 support, removed unsupported formats Added OCmod support. GitHub Issue # Fixed notify setting in orderhistory Improved PHP <5.4 compatibility Initial release with transport functionality. TLS 1.x support is required to communicate with SendCloud. Deze pagina is nog niet vertaald en daarom wordt de Engelse versie weergegeven. 16 Hoofdstuk 5. Releases