SendCloud OpenCart 2 Extension Documentation

Transcription

1 SendCloud OpenCart 2 Extension Documentation Release Comercia November 22, 2017

2

3 Contents 1 GitHub README info Links Version Support Support from Comercia Support from SendCloud Installation Download the SendCloud Extension Extract the SendCloud Extension Installing vqmod Upload the SendCloud Extension Get SendCloud API keys Activate the SendCloud Extension Setup the SendCloud Extension Usage Transport orders to SendCloud Process orders in SendCloud Using the delivery location picker Error messages Building the extension package Installing prerequisites Get the repository Building the Extension Releases i

4 ii

5 iii

6 iv

7 SendCloud OpenCart 2 Extension Documentation, Release This documentation is auto generated. Contents 1

8 SendCloud OpenCart 2 Extension Documentation, Release Contents

9 CHAPTER 1 GitHub README info This extension allows you to transport (export) orders to SendCloud in OpenCart 2. After transporting the order information to SendCloud you can generate shipment labels within the SendCloud platform. The extension is officially supported by Comercia. Feel free to send pull requests to extend the functionality and compatibility of this extension. 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): Version Support This extension supports all OpenCart 2.X-versions. A non-open source extension for OpenCart 1.5.x can be downloaded from the OpenCart extension store: Upgrading to OpenCart 2 is recommended to stay up to date with the latest updates. Support from Comercia Should you need any OpenCart or SendCloud-integration support, please contact us on support@comercia.nl or drop us a ticket at 3

10 SendCloud OpenCart 2 Extension Documentation, Release Support from SendCloud If you need support please contact us: contact@sendcloud.sc 4 Chapter 1. GitHub README info

11 CHAPTER 2 Installation Notice! A SendCloud account is required to use this extension. You can request one for free here. 1. Download the SendCloud Extension The easiest way to to get the module is to get it from the OpenCart extension store: Dutch OpenCart Specialist (OpenCart module support): 2. Extract the SendCloud Extension Extract the OpenCart extension to a location at your computer. 5

12 SendCloud OpenCart 2 Extension Documentation, Release Installing vqmod If you ve already installed vqmod you can skip this step and go to step Download latest version of vqmod for OpenCart from GitHub The easiest way to install vqmod is with this instruction video Or follow this guide on GitHub Upload the SendCloud Extension Connect to your website with your favorite FTP client. If you don t have any you can use FileZilla. Upload the files from the upload folder from the extension package to your website. 5. Get SendCloud API keys Login on the SendCloud Panel with your SendCloud account. Choose Integraties. 6 Chapter 2. Installation

13 SendCloud OpenCart 2 Extension Documentation, Release From the overview page that comes up, click the Connect button underneath the SendCloud logo. On the next screen, type in a name for your integration, for example OpenCart or the name of your webshop. The API keys will be automatically generated after you press Save Get SendCloud API keys 7

14 SendCloud OpenCart 2 Extension Documentation, Release Copy your public and secret key. 6. Activate the SendCloud Extension Login to the OpenCart admin area. Go to Extensions -> Modules and click on the green button from the SendCloud Extension. The SendCloud Extension is activated. 7. Setup the SendCloud Extension Click on the blue edit button. Insert your API public & secret key. Choose your order state and save the settings. 8 Chapter 2. Installation

15 CHAPTER 3 Usage Transport orders to SendCloud The extension is installed. You can now use the SendCloud Extension to transport your orders. In the OpenCart admin go to Sales -> Orders. Select the orders you want to transport to SendCloud and click the button with the SendCloud logo. Process orders in SendCloud Login on the SendCloud Panel with your SendCloud account. In the blue top menu, select the plug icon (if you have multiple integrations, there can be multiple icons in this bar, in this case, select the plug icon that corresponds to the newly set up webshop). 9

16 SendCloud OpenCart 2 Extension Documentation, Release On the overview page that comes up, you will find the orders that have been sent through the SendCloud module from your OpenCart webshop. Using the delivery location picker To use the delivery location picker, open the module settings and click on Choose checkout method. A dropdown menu appears where you can select your preferred checkout method. 10 Chapter 3. Usage

17 SendCloud OpenCart 2 Extension Documentation, Release Currently we are supporting the default Opencart checkout and the Journal Quickcheckout modules, support for other checkouts will be rolled out in the future. After selecting the preferred checkout method, click the green Apply button to roll out the settings, followed by the blue Save button at the right top corner of the screen to save all the settings. Error messages One or more orders have no shipping details. Check the order information if there is shipping information available. Be aware that payment information is not the same as shipping information Error messages 11

18 SendCloud OpenCart 2 Extension Documentation, Release Check the SendCloud Extension s settings. The public key and/or secret key may be blank. If both settings are not blank check if your API keys are correct in the SendCloud Panel. The orders can t be transported to SendCloud. This occurs when you don t have a suitable shipping method configured in your SendCloud account. You should contact the SendCloud support team if you think that you re not having access to the correct shipping methods. 12 Chapter 3. Usage

19 CHAPTER 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

20 SendCloud OpenCart 2 Extension Documentation, Release 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. 14 Chapter 4. Building the extension package

21 CHAPTER 5 Releases Added support for OpenCart 3.x 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 15

22 SendCloud OpenCart 2 Extension Documentation, Release Compatibility fixes for 2.0.x Updated documentation 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. 16 Chapter 5. Releases