MAGENTO YELLOWCUBE CONNECTOR

Transcription

1 Agile Web Development Liip.ch MAGENTO YELLOWCUBE CONNECTOR User Manual Version:

2 TABLE OF CONTENTS ---- About ---- Installation ---- Requirements ---- Installation of the module ---- User Manual ---- Configuration of the module ---- Configuring Shipping Method "SwissPost YellowCube" ---- Configure URL to endpoint ---- Configure Contract Information ---- Certificate ---- Shipping Methods setup ---- Connector Setup ---- Title ---- Shipping Countries ---- Debug ---- YellowCube Stock Management ---- Initialize YellowCube Product Master Data ---- Manually Synchronize YellowCube Stock ---- Logging ---- Factsheet ---- Supported ---- Currently not supported ---- About Liip 2

3 ABOUT YellowCube is a warehouse solutions offered by Swiss Post that is specialized on fully automated storage, picking and packing of small parts. For more information head over to en/yellowcube-connector. INSTALLATION This guide will help you to install and configure the YellowCube Shipping Module for Magento. REQUIREMENTS ---- Magento CE >= 1.6.x to 1.9.x ---- PHP >= PHP Soap, DOM Library, mbstring ---- Cron enabled and configured for Magento (set your Cron at server level to a period of 5 min to launch internal task related to the YellowCube extension */5 * * * * php path/to/ my/magento/cron.php) INSTALLATION OF THE MODULE Please follow the installation manual on GitHub: magento-yellowcube. 3

4 USER MANUAL Make sure you have followed above installation steps and installed the YellowCube PHP Client library. This section will guide you through the configuration of the YellowCube Connector for Magento. CONFIGURATION OF THE MODULE Go to System > Configuration > General > Store Information Make sure you have added a "Store Name" and a "Store Contact Telephone" since it is necessary for the YellowCube module 4

5 In Menu System > Configuration > Shipping Settings set the origin of your shipment 5

6 CONFIGURING SHIPPING METHOD "SWISSPOST YELLOWCUBE" In Menu System > Configuration > Shipping Methods > SwissPost you will need to enter the information from your Post YellowCube contract. General overview: 6

7 CONFIGURE URL TO ENDPOINT The SOAP endpoint depends on the operating mode (see below) and the use of the certificate: Operating Mode P Client Authentication Certificate required (always) Endpoint URL T Certificate T without CONFIGURE CONTRACT INFORMATION ---- YellowCube Sender: this is your shop ID YellowCube Depositor Number: this number will be assigned to your business by Post YellowCube Partner Number: your unique account number in the YellowCube system YellowCube Plant ID: The storage location - this value should be Y006. If in doubt about the account setup, please refer to your Swiss Post YellowCube contract. CERTIFICATE With your YellowCube account at Swiss Post you will be provided with a self signed certificate, which you have to import on to your webserver. If you haven't received it already, please contact the responsible person at YellowCube and provide it with the following information in order to receive a valid certificate: ---- Company name ---- Responsible Person 7

8 ---- City of company ---- Country ---- Cellphone number in order to receive SMS with the password for the certificate ---- Path to Certificate: You will need to upload the certificate to the server. Specify the absolute path including the file name and make sure this path isn't accessible via the internet Certificate Password (optional): The password you have received with your certificate. SHIPPING METHODS SETUP ---- Shipping Methods: Add the shipping methods which are available to you with the desired prices, so the customer can choose in the checkout which shipping method to take Tara Factor:Gross Weight is required for YellowCube. Can be calculated with Tara Factor: Gross Weight = Net Weight x Tara Factor 8

9 CONNECTOR SETUP ---- Operating mode: Defines which YellowCube system environment will be used. There are 3 options: Operating Mode When to use Production Set this mode for your live shop. Products will be delivered by Post. Test Recommended when you setup your shop with YellowCube. Products will not be delivered. Development You can safely ignore this option. It is only relevant for the YellowCube development team. TITLE This is the title of the shipping method which will be shown to the customer in the checkout. SHIPPING COUNTRIES Here you can configure if the specific Shipping Method is available in the country the shipping address is located Ship to Applicable Countries: Specify if you want this shipping method to be available for all countries or just for a subset efined below ---- Ship to Specific Countries: Here you can specify for which countries this shipping method is available. This takes only effect if "Ship to Applicable Countries" is set to "Specific Countries" 9

10 DEBUG ---- Debug: If you set this option to yes, you will get debug information into "yellocube.log" located at //var/log/yellowcube.log. YELLOWCUBE STOCK MANAGEMENT INITIALIZE YELLOWCUBE PRODUCT MASTER DATA When setting up the shop for YellowCube for the first time, it is necessary to send all the product master data to YellowCube. To send the product data this functionality can be used. MANUALLY SYNCHRONIZE YELLOWCUBE STOCK The stock is synchronized automatically once a day (via the Cron jobs). Should it be necessary to trigger the stock synchronization manually, it can be done with this functionality. LOGGING Debug information is written into "yellocube.log" located at //var/log/yellowcube.log. See section Debug, for activation of debug mode. 10

11 FACTSHEET SUPPORTED ---- Automatic forwarding of all orders to YellowCube ---- Inventory synchronization: pending orders will be considered, the new stock will be calculated with YellowCube stock - pending orders = new shop stock ---- Logging of debug information //var/log/yellowcube.log ---- Certificate based authentication ---- Multiple configurable delivery products, displayed in the checkout process. E.g. PostPac Priority, PostPac Economy, etc. CURRENTLY NOT SUPPORTED ---- Splitting an order into multiple shipments ---- Article master data (ART) transactional status feedback GetInsertArticleMasterDataStatus (e.g. if the article could not be added to YellowCube); An error will be sent via alert in this case directly from YellowCube EAN (European Article Numbers) 11

12 ABOUT LIIP Liip is one of Switzerland s leading developers of tailor-made, agile web applications. Content management, E-Commerce, E-Learning, User Experience, Open Data, Mobile Apps, Analytics and API are just a few of the services that Liip offers private and public sector customers. Thanks to its use of state-of-the-art technologies, tried and tested industry standards and opensource software, Liip develops and delivers sustainable digital solutions. With offices in Zurich, Lausanne, Bern, Fribourg and St. Gallen, Liip brings its extensive knowledge, experience and innovative flair to your doorstep. The company is behind many award-winning web applications and its cross-functional teams and transparent communication help customers gain swift entry to the market, with a minimum of risk but a maximum of investment security. This is what Liip is all about. 12