DRUPAL COMMERCE YELLOWCUBE CONNECTOR

Transcription

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

2 TABLE OF CONTENTS ---- About ---- Installation ---- Requirements ---- Step-by-Step Instructions ---- User Manual ---- Configuration ---- YellowCube Account ---- Shop setup ---- Connector Setup ---- Order Status Texts ---- 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 Drupal Commerce. REQUIREMENTS ---- PHP > Drupal 7.x ---- Composer ---- YellowCube PHP Client library STEP-BY-STEP INSTRUCTIONS Recommended way: Follow the instructions on Alternative way: 1. Go to the drupal-yellowcube release page and copy the address of the latest `yellowcube-7.x-1.x.gz` release: 2. Go to the Module page at Administer > Modules ( to install and enable it. For general information on installing a Drupal module, please refer to the documentation: 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 Drupal. CONFIGURATION Go to the YellowCube module at Store > Configuration > Shipping > YellowCube to set up the YellowCube parameters. You should now see see a page with the different configuration options. 4

5 YELLOWCUBE ACCOUNT First, you will need to enter the information from your Post YellowCube contract 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. SHOP SETUP ---- Basic Shipping Service: Pick one shipping service that will be used together with YellowCube. This will be shown in the checkout process at the "Shipping" step YellowCube Tara Factor: Gross Weight is required for YellowCube. Can be calculated with Tara Factor: Gross Weight = Net Weight x Tara Factor 5

6 CONNECTOR SETUP ---- Path to certificate: You will need to upload the certificate to the server first. Specify the absolute path here Certificate password: For security reasons, the certificate should be protected by a password 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. 6

7 ---- URL to the Endpoint: The SOAP endpoint depends on the operating mode and the availability of the certificate: Operating Mode Client Authentication Endpoint URL P Certificate required (always) yellowcube/?wsdl T Certificate yellowcube-int/?wsdl T without yellowcube-test/?wsdl ORDER STATUS TEXTS YellowCube Order Status Label can be defined in the following configuration section Order status label: received: Default value "Auftrag in Bearbeitung" Order status label: sending: Default value "Auftrag wird übermittelt" Order status label: failed: Default value "Auftrag muss manuell geprüft werden". 7

8 YELLOWCUBE STOCK MANAGEMENT The stock management is accessible through the menu Store > Configuration > 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. 8

9 LOGGING The YellowCube module will writte the log messages to the standard Drupal logging. The log messages can be accessed through the menu Store > Reports > Recent log messages. Filtering for the type "yellowcube" will only show the relevant messages. 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 Reports Recent log messages Filter: yellowcube ---- Certificate based authentication ---- Only one single delivery product, e.g. PostPac Priority (configurable), displayed in the checkout process. 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) 9

10 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. 10