WC Auto-Ship for WooCommerce

Transcription

1 WC Auto-Ship for WooCommerce Version Published: July 24, Patterns In the Cloud, ( Contact for additional support. Hosting Requirements Operating System: Linux 64-bit or equivalent Web Server: Apache Web Server PHP: PHP Database: MySQL Server Wordpress Version: Wordpress WooCommerce Version: WooCommerce Required PHP extensions php-curl ( php-json ( Minimum PHP settings memory_limit 256M max_execution_time 600 Installation A. Install and configure required plugins 1. Extract the archive to the plugins folder of your Wordpress site (usually /wpcontent/plugins/). 2. Log in to Wordpress as an administrator and navigate to the Plugins list. Find and activate WC Autoship. 3. In the Wordpress dashboard, navigate to WooCommerce > Settings > WC Autoship. Complete the WC Autoship Settings form. See reference sections A and B for field descriptions. 4. Navigate to WooCommerce > Settings > Checkout > WC Autoship PayPal Payments 1 of 7

2 5. Complete the fields in the WC Autoship PayPal Payments settings form. See reference section C for field descriptions. Make sure that this payment gateway is enabled. 6. Edit a product within WooCommerce and open the WC Auto-Ship tab. Select to Enable Autoship and save your changes. B. Install a Payment Gateway Integration WC Autoship requires specialized payment gateway integrations that contain methods to tokenize payment methods and charge customers on a recurring basis. Official WC Autoship payment gateway integrations can be found at ( Basic Use Creating Autoship Products WC Autoship uses the Simple and Variable products that come standard with WooCommerce. If you already have products in your database, skip to the next section. To create a new product, follow the instructions below. 1. Log in to Wordpress as an administrator and navigate to the WooCommerce > Products page. 2. Create a Simple product by following the instructions in the WooCommerce documentation ( Scheduling an Autoship Order 1. Navigate to a product page. 2. Select one of the Auto-Ship options that were created on the plugin s settings page. 3. Add the product to the cart. 4. Complete the checkout process. The products that were added to autoship will appear in the My Autoship Schedules section of the My Account page after a successful checkout. Important Notes Autoship settings must not be changed if customers have scheduled autoship orders in the system. This will cause desynchronization errors and a loss of autoship customer data. Some customers have reported random errors using the WooCommerce USPS Shipping plugin. Adding Payment Gateways 2 of 7

3 Autoship payment gateways must be compatible with both the WooCommerce Payment Gateway API ( and the WC Autoship Payment Gateway API. Implementing the WC Autoship Payment Gateway API 1. Locate the existing WC Autoship PayPal Gateway implementation in the plugin folder woocommerce-autoship-paypal-payments. You may use this plugin as a reference. 2. Locate the file containing the WC_Autoship_Payment_Gateway class at woocommerce-autoship/classes/payment-gateway/wc-autoship-paymentgateway.php. This class will be used to store and retrieve customer payment information and process payments. 3. Write a class that extends the WC Autoship class WC_Autoship_Payment_Gateway. Implement all required methods for WC_Autoship_Payment_Gateway. See the existing WC Autoship PayPal Gateway implementation, WC_Autoship_PayPal_Gateway, located at woocommerce-autoship-paypal-payments/classes/wc-autoship-paypalgateway.php as a reference. See the documentation for the WooCommerce payment gateway API ( for help implementing the WC_Payment_Gateway class. The prototype for WC_Autoship_Payment_Gateway class is shown below. <? php abstract class WC_Autoship_Payment_Gateway extends WC_Payment_Gateway { * Get the field names posted by the payment_fields form string[] abstract public function get_payment_field_names(); * Get the payment method description for a customer in HTML format WC_Autoship_Customer $customer string abstract public functionu n c t i o n get_payment_method_description( WC_Autoship_Custo mer $customer ); * Process an order using a stored payment method WC_Order $order WC_Autoship_Customer $customer WC_Autoship_Payment_Response abstract public functionu n c t i o n process_stored_payment( WC_Order $order, WC_Autos hip_customer $customer ); * Store a payment method WC_Autoship_Customer $customer 3 of 7

4 array $payment_fields boolean abstract public functionu n c t i o n store_payment_method( WC_Autoship_Customer $custo mer, $payment_fields ); }?> Template Overrides WC Auto-Ship allows the current theme to override any template located in the main plugin folder at woocommerce-autoship/templates. To override a template file, create the same relative folder structure within your current theme folder: [your-themefolder]/woocommerce-autoship/templates Example: override the product page auto-ship cart options template 1. Locate the autoship options template in the plugin folder: woocommerce-autoship/templates/product/autoship-options.php 2. Create the template override folder structure in your current theme: [your-theme-folder]/woocommerce-autoship/templates/product 3. Copy the template file woocommerce-autoship/templates/product/autoshipoptions.php to your theme folder at [your-theme-folder]/woocommerceautoship/templates/product/autoship-options.php WC Auto-Ship will now implement the autoship-options.php template file from your theme folder! Reference A. Autoship Settings Enter general system settings for autoship Field Name License Key Management page message (HTML) No Autoship Message (HTML) My Autoship Menu Page The software license key issued to you after purchase. A custom message to display on Autoship management pages. A custom message to display for customers with no autoship schedules. The page displaying the autoship menu. 4 of 7

5 Field Name Autoship Schedules Page The page displaying the autoship schedules. Autoship Billing Page The page displaying the autoship billing form. Autoship Shipping Page The page displaying the autoship shipping form. B. Autoship Product Options Autoship options for individual products. Field Name Enable Autoship Enable autoship for the product. Autoship price (optional) An optional price for this product when autoship is selected Min Autoship Frequency(days) The minimum autoship frequency that can be selected Max Autoship Frequency(days) The maximum autoship frequency that can be selected Default Autoship Frequency The autohip frequency option that is selected by default C. WC Auto-Ship Shortcodes Autoship site content is generated with Wordpress shortcodes. See the documentation for the Wordpress Shortcode API for more information: ( Shortcode The main menu for autoship schedules, billing, and shipping. Autoship schedules management form Autoship billing management form [autoshipmenu] [autoshipschedules] [autoshipbilling] [autoshipshipping] Autoship shipping management form 5 of 7

6 Shortcode [autoshipmessage] A custom message to display on autoship pages from the "Management page message (HTML)" setting D. WC Autoship Wordpress Database Schema {wp_}wc_autoship_customers id BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, payment_gateway_id VARCHAR(100) NOT NULL DEFAULT '', payment_method_id VARCHAR(255) DEFAULT NULL, payment_method_data BLOB DEFAULT NULL, shipping_first_name VARCHAR(20) NOT NULL DEFAULT '', shipping_last_name VARCHAR(20) NOT NULL DEFAULT '', shipping_company VARCHAR(50) DEFAULT NULL, shipping_address_1 VARCHAR(255) NOT NULL DEFAULT '', shipping_address_2 VARCHAR(255) NOT NULL DEFAULT '', shipping_city VARCHAR(20) NOT NULL DEFAULT '', shipping_postcode VARCHAR(10) NOT NULL DEFAULT '', shipping_country CHAR(2) NOT NULL DEFAULT '', shipping_state VARCHAR(20) NOT NULL DEFAULT '', shipping_method VARCHAR(50) NOT NULL DEFAULT '', shipping_method_title VARCHAR(100) NOT NULL DEFAULT '', created_time DATETIME NOT NULL, modified_time DATETIME NOT NULL {wp_}wc_autoship_schedules id BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, customer_id BIGINT(20) UNSIGNED NOT NULL, autoship_option_id VARCHAR(10) NOT NULL, autoship_status TINYINT(1) DEFAULT {\$status_active}, last_order_date DATE NOT NULL, 6 of 7

7 next_order_date DATE NOT NULL, created_time DATETIME NOT NULL, modified_time DATETIME NOT NULL, UNIQUE KEY wc_autoship_user_option (customer_id, autoship_option_id) {wp_}wc_autoship_schedule_items id BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, schedule_id BIGINT(20) UNSIGNED NOT NULL, product_id BIGINT(20) UNSIGNED NOT NULL, variation_id BIGINT(20) UNSIGNED DEFAULT NULL, qty TINYINT(1) UNSIGNED NOT NULL DEFAULT 1, customer_label VARCHAR(255) NOT NULL DEFAULT '', created_time DATETIME NOT NULL, modified_time DATETIME NOT NULL 7 of 7