Open-Source Shopping Cart Solutions Installation information for integrating a shopping cart with Checkout by Amazon using open-source solutions
2008-10 Amazon.com, Inc. or its Affiliates Table of Contents 1 Open-source Cart Solutions... 1 1.1 Other Documentation...1 1.2 What s New in This Document... 2 2 oscommerce Plug-in V 1.0... 3 2.1 Updates... 3 2.2 README.txt... 3 2.3 INSTALLATION_GUIDE.txt... 8 3 Zen Cart... 13 3.1 Updates... 13 3.2 README.txt... 13 3.3 INSTALLATION_GUIDE.txt... 18 ii
Open-Source Shopping Cart Solutions 1 Open-source Cart Solutions You can integrate with the third-party cart integration solution of your choice. For your convenience, we provide code samples for two open-source cart providers, oscommerce and Zencart. You can download zipped files using the links below: oscommerce solution (v 2008_11_11_1.11) (http://www.oscommerce.com/) Zencart solution (v 2008_12_03_1.10) (http://www.zen-cart.com/index.php) The following pages contain basic instructions for using these cart solutions. Notes If you use these plugins, remember that you will use Seller Central for your order management. When you integrate your cart with Checkout by Amazon, you will need to use your Merchant ID in your cart. Your Merchant ID is a 14-character string, similar to this: A1B2C3D4E5F6G7. Here are the steps to view your Merchant ID in Seller Central: 1. Click the Settings tab. 2. Click Checkout Order Pipeline. 3. View your Merchant ID. Your Merchant ID is not the same as your Merchant Token, which is used for applications such as ASON. 1.1 Other Documentation You can read our downloadable files (PDF) to understand more about Checkout by Amazon. 1
2008-11 Amazon.com, Inc. or its Affiliates Resource Getting Started Guide (PDF) Implementation Guide Using the Create Checkout Button Feature (PDF) Implementation Guide Using HTML-based Button Code and Shopping Carts (PDF) Implementation Guide Using XML-based Button Code and Shopping Carts (PDF) Best Practices Guide (PDF) Launch Checklist (PDF) Callback API Guide (PDF) Instant Order Processing Notifications API Guide (PDF) Using Custom Data Fields (PDF) Open-Source Shopping Cart Solutions (PDF) Installing and Configuring the oscommerce Plug-in (PDF) Audience, Purpose, and Goals For merchants who want to use a simple, step-by-step approach in setting up Checkout by Amazon on their websites, from start to finish. The Getting Started Guide walks merchants through the process, from gathering the required information for signing up for an account setting up a button on their websites. For merchants who want detailed information about integrating their website with Checkout by Amazon using the Create Checkout Button feature in Seller Central. Designed for a simple copy-and-paste HTML solution for your webpages. For merchants and developers who want detailed information about integrating their website with Checkout by Amazon using HTML-based buttons and shopping carts. Designed for HTML-based integration. For merchants and developers who want detailed information about integrating their website with Checkout by Amazon using XML-based buttons and shopping carts. Designed for XML-based integration. Contains the best tips for merchants who want to set up their websites to use Amazon Payments, with advice for planning, setting up, and day-to-day operations. For merchants and developers planning to set up and use Checkout by Amazon on their site. For developers who want to build their own applications to calculate shipping and tax rates as well as promotional discounts and then send these results to Checkout by Amazon. For developers who want to automate order notifications with Amazon Payments. For merchants and developers who want to include custom data fields in their carts. For developers interested in open-source carts that support Checkout by Amazon (currently oscommerce 1.x and Zen Cart). For developers interested in the oscommerce open source cart, v. 2.0 and greater. 1.2 What s New in This Document Ver Date Changes 2.1 2014-06-03 Updated references to a menu option Access Key to MWS Access Key. Updated, or removed out dated, broken links. 1.8 2014-03-27 Clarification of access and secret access keys. 1.7 2011-10-31 Updated to reflect current functionality. 1.6 2010-08-09 Updated Zen Cart Plug-in to support several new features. 1.5 2009-03-05 Updated the oscommerce Plug-in V 1.0 section to include link to newer 2.0 solution. 1.0 2008-07-29 Initial release. 2
Open-Source Shopping Cart Solutions 2 oscommerce Plug-in V 1.0 This section describes how to use the oscommerce Plug-in V 1.0. If you want to use the newer version of this plug-in, download and read Installing and Configuring the oscommerce Plug-in (PDF). 2.1 Updates Update version Problem Change 2014_03-27 Access and Secret Key information unclear. Updated README.txt information. 2008_11_12_1_11 Cart allows description field of greater than 255 characters. Long descriptions are cut off before being sent to Checkout by Amazon. Path found to bypass Checkout by Amazon. Added Checkout by Amazon to login page. 2008_09_29_1_10 Plug-in allows 4-digit price. Only 2-digit price allowed. Cart sets weight to 0 and "LB" or drops weight value entirely. Sets weight to specified value and lb, not LB. Here is the Readme and Installation Guide for the oscommerce Plug-in V 1.0: 2.2 README.txt CHECKOUT BY AMAZON PAYMENT MODULE FOR OSCOMMERCE Author: Allison Naaktgeboren Copyright: 2007-2008 Amazon Technologies, Inc. CONTENT SECTIONS (in order of appearance) INTRODUCTION NOTICES FOR CERTAIN SOFTWARE COMPONENTS REQUIREMENTS RELEASE NOTES SETUP ON ADMIN UI SUPPORT & PROJECT HOME LINKS INTRODUCTION Please understand that by installing Checkout by Amazon Payment Module for oscommerce, you are agreeing to understand and abide by the terms of the license, as written in LICENSE.txt. Important links are grouped together in a separate section for your convenience. The most current documentation on Checkout by Amazon can be found on its website. NOTICES FOR CERTAIN SOFTWARE COMPONENTS 1. Notices for Software Components Licensed Under the GNU General Public License. The following are notices for software components that are free software licensed under version 2 of the GNU General Public License (the GPL ), the full text of which is set forth in the LICENSE.TXT file accompanying 3
2008-11 Amazon.com, Inc. or its Affiliates this package, as published by the Free Software Foundation (such software, collectively, the GPL Software ). Portions of these software components have been modified by Amazon.com in order to function with Amazon's Checkout by Amazon service. a. Modification Notice. The GPL Software has been modified [2007-2008]. b. Terms Applicable to the GPL. The full text of the GPL is set forth in the LICENSE.TXT file accompanying this package. You may redistribute the GPL Software and/or modify it under the terms of the GPL. The GPL Software is distributed WITHOUT ANY WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. You may, for a period of up to three years, obtain, for a charge equal to the cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code. See the terms of the GPL for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. c. Name and Copyright Notice. The following are the names of the GPL Software and the applicable copyright notices: - oscommerce Online Merchant (c) 2000-2008 oscommerce - Zen Cart (c) 2003-2008 Zen Ventures LLC - XmlBuilder.php (c) 2006 Google Inc. 2. Notices for Software Components Licensed Under the PHP license. The following are notices for software components that are free software licensed under the PHP License version 3.0 (such software, collectively, the PHP Software ). a. Terms Applicable to the PHP Software. The PHP Software includes PHP, freely available from http://www.php.net/. Redistribution and use of the PHP Software, in source and binary forms, with or without modification, is permitted provided that the following conditions are met: 1. Redistributions of source code must retain the following copyright notice, this list of conditions and the following disclaimer. "Copyright (c) 1999-2006 The PHP Group. All rights reserved." 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name "PHP" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact group@php.net. 4. Products derived from this software may not be called "PHP", nor may "PHP" appear in their name, without prior written permission from group@php.net. You may indicate that your software works in conjunction with PHP by saying "Foo for PHP" instead of calling it "PHP Foo" or "phpfoo" 4
Open-Source Shopping Cart Solutions 5. The PHP Group may publish revised and/or new versions of the license from time to time. Each version will be given a distinguishing version number. Once covered code has been published under a particular version of the license, you may always continue to use it under the terms of that version. You may also choose to use such covered code under the terms of any subsequent version of the license published by the PHP Group. No one other than the PHP Group has the right to modify the terms applicable to covered code created under this License. 6. Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes PHP, freely available from <http://www.php.net/>". THIS SOFTWARE IS PROVIDED BY THE PHP DEVELOPMENT TEAM ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PHP DEVELOPMENT TEAM OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. b. Name and Copyright Notice. The following is the name of the PHP Software and the relevant copyright notices. - HMAC.php (c) 1997-2005 The PHP Group. All rights reserved. REQUIREMENTS (1) oscommerce 2.2rc2a must be installed Other versions are untested. (2) Seller account from Amazon.com Please see Seller Central website in "LINKS" section of this document. RELEASE NOTES (1) Carefully follow all instructions in INSTALLATION_GUIDE.txt (2) You must have set up an Amazon Seller account & have your merchantid. (a) Log in to Seller Central (b) Click Settings > Checkout Pipeline Settings (c) View your Merchant ID on the Checkout Pipeline Settings page. (3) It is strongly encouraged to generate keys from Seller Central, and have your key ready to enable signed orders. Unsigned orders are very vulnerable to fraud. (4) Note that Checkout by Amazon standards do not allow weights of products to be 0 at this time. Thus, a weight tag = 0 will be removed from the XML cart before the order is processed (5) Please note that if you choose to use your own checkout success page, as discussed below, YOU are responsible for clearing the contents of the 5
2008-11 Amazon.com, Inc. or its Affiliates customer cart, as identified by ClientRequestId. If you wish to create your own success return page and use the popup order summary from Checkout by Amazon, you will need to include the necessary scripts. (6) The orders that are processed through Checkout by Amazon will not appear in the oscommerce records or database. Please log in to Seller Central to review the orders processed though Checkout by Amazon. (7) Checkout by Amazon does not at this time support the tax or shipping settings in oscommerce. You, the seller, will need to be sure that your desired tax and shipping rates are configured in Seller Central. (8) The price that is included in the XML carts sent to Checkout by Amazon from oscommerce includes promotion prices set in oscommerce,.i.e. the promotion has already been applied to the item. If you, the seller, also configure promotions in Seller Central, these will be applied in addition to the promotion from oscommerce. (9) Please note that the SKU, Title, & Description fields of products may be truncated when building the Checkout by Amazon cart. This is to comply with the standards set by Checkout by Amazon. Please see the Checkout by Amazon documentation in "LINKS" section below. SETUP ON ADMIN UI --Login in as the Administrator --click on 'Modules" tab on left hand side menu --click on "Checkout by Amazon" in the module list --click the "install" button the right hand side --click on the "edit" button --enter the following fields: ----Checkout button size This determines size of the Checkout icon. ----Button style This option determines style & color of the Checkout icon ----Enable Checkout by Amazon module This must be set to "true" to use Checkout by Amazon ----Sort Order display This determines how displays should be sorted ----Checkout by Amazon Merchant ID This field is required to enable Checkout by Amazon. You receive this ID when you sign up for an Amazon Seller account. ----Enable order signing We strongly encourage you to use signed orders. Unsigned orders are vulnerable to fraud. This is required if you wish to enable Fulfillment by Amazon. (Please see "Fulfillment by Amazon section below) ----Secret Key This value is required for creating signed orders. Please treat the secret key like a password. It is paired with the MWS Access Key. You must sign up for a key with Amazon Marketplace Web Services (MWS) website. Please see the "LINKS" section below. ----Access Key This value is required for creating signed orders. This key is paired to the Secret Key, but does not need to be protected like a password. You must sign up for your keys with Amazon Marketplace Web Services (MWS) website. Please see the "LINKS" section below. ----Operating Environment Sandbox - testing environment for your convenience. Transactions are not actually processed. You are encouraged to test Checkout by Amazon on your site before fully enabling the module. When in Sandbox mode, a 6
Open-Source Shopping Cart Solutions warning will appear below the Checkout by Amazon icon on the shopping cart page. Production - fully enabled environment. Transactions will be processed ----Cart Expiration Time This is an optional setting. It is the amount of time before a customer's cart expires, and is reset. If you choose not to set this value, the cart will not expire. ----Fulfillment by Amazon Select whether you, the seller, will fill your orders, or participate in "Fulfillment by Amazon" program. Please see Amazon's Seller Central for more information. ----Cancelation Return Page The page you would like customers to return to if they choose the cancel the order in the Checkout by Amazon pipeline. The default setting will return your customers to the catalog index page. This will not clear the customer cart. ----Success Return Page The page you want customers to return when they successfully complete an order in the Checkout by Amazon pipeline. The default setting will return your customers to the index page in your oscommerce store. This assumes that you have modied index.php as per the INSTALLATION_GUIDE to include the Amazon code. Redirecting to the oscommerce page 'checkout_success.php' will not work because oscommerce requires customers to have logged in, which they do not do in the Checkout by Amazon process. Please note that if you choose to use your own checkout success page, YOU are responsible for clearing the contents of the customer cart, which is identified by ClientRequestID. If you want to create your own success return page and use the popup order summary from Checkout by Amazon, you will need to include the necessary scripts. --Click the "Update" button at bottom of page --Review your site --You are strongly encouraged to test a couple of orders in the "Sandbox" environment before enabling "Production" environment SUPPORT & PROJECT HOME The latest documentation on Checkout by Amazon can be found at in the LINKS section below. Documentation for oscommerce integration can be found on the Amazon Seller Community website, under Amazon Payments Forums, titled "Integrating with oscommerce Cart" The latest version of Checkout by Amazon for oscommerce can be downloaded from the link below. LINKS Checkout by Amazon Documentation & Seller Central https://sellercentral.amazon.com/gp/help/ Amazon Marketplace Web Services (Amazon MWS) https://developer.amazonservices.com/index.html/186-5510975-5406814 Amazon Web Services http://www.amazon.com/webservices Amazon Seller Community Website http://www.amazonsellercommunity.com/forums/ Download Checkout by Amazon Payment Module for oscommerce http://amazonpayments.s3.amazonaws.com/documents/oscommerce_ checkoutbyamazon_plugin_2008_07_29.zip Fulfillment by Amazon https://sellercentral.amazon.com/gp/help/200144670 7
2008-11 Amazon.com, Inc. or its Affiliates 2.3 INSTALLATION_GUIDE.txt INSTALLATION INSTRUCTIONS: CHECKOUT BY AMAZON MODULE PAYMENT MODULE FOR OSCOMMERCE Author: Allison Naaktgeboren Copyright: 2007-2008 Amazon Technologies, Inc. INSTALLATION OPTIONS Please note that by installing Checkout by Amazon Payment Module for oscommerce, you are agreeing to understand and abide by the terms of the license, as written in LICENSE.txt. You have two options for installing the Checkout by Amazon Payment module within oscommerce. If you have a fresh installation, please follow the directions in "FRESH INSTALLATION" below. If you already have an existing copy of oscommerce, please follow the directions in the section marked "EXISTING INSTALLATION". Please note, if you already have Google Checkout installed, the last step of the EXISTING INSTALLATION is different, please read the directions carefully. FRESH INSTALL Once you have a fresh installation of oscommerce, please copy the following files to the following directories: Copy /checkout_by_amazon/ & its contents to OSC_DIR/catalog/checkout_by_amazon/ Copy index.php to OSC_DIR/catalog/ This will overwrite the existing copy Copy shopping_cart.php to OSC_DIR/catalog/ This will overwrite the existing copy Copy checkout_payment.php to OSC_DIR/catalog/ This will overwrite the existing copy Copy login.php to OSC_DIR/catalog/ This will overwrite the existing copy PLEASE NOTE THAT THE FOLLOWING TWO FILES ARE DIFFERENT, BUT HAVE SAME NAME AND BELONG DIFFERENT PLACES. Copy checkout_by_amazon.php to OSC_DIR/catalog/includes/modules/payments/ Copy the english/modules/checkout_by_amazon.php to OSC_DIR/catalog/includes/languages/english/modules/payments/ Log in as Administrator in oscommerce's Administrator UI and follow the instructions, in README.txt. Please be sure to read the "Requirements" section as well. EXISTING INSTALLATION, (INCLUDING WITH GOOGLE CHECKOUT INSTALLED) To modify an existing installation to support Checkout by Amazon, you will need to install several new files and modify a few existing oscommerce files. New files: Copy /checkout_by_amazon/ & its contents to OSC_DIR/catalog/checkout_by_amazon/ Copy checkout_by_amazon.php to OSC_DIR/catalog/includes/modules/payments/ Copy the english/checkout_by_amazon.php to OSC_DIR/catalog/includes/languages/english/modules/payments/ Modifications to OSC_DIR/catalog/index.php: There are two changes needed in index.php. The first is the portion 8
Open-Source Shopping Cart Solutions of code which clears the customer carts in oscommerce. The second calls the scripts which present the customer with the Checkout by Amazon pop up containing their order details. Add, ~line 26 (before the closing?> tag) the following code: // BEGIN CHECKOUT BY AMAZON CODE require_once("checkout_by_amazon/checkout_by_amazon_constants.php"); //emptying the cart if($http_get_vars['amznpmtsreqid'] ){ $cart->reset(); } // END CHECKOUT BY AMAZON CODE Add, ~line 43, (before the </head> tag), the following code: <!-- BEGIN CHECKOUT BY AMAZON CODE --> <!-- Produces the javascript popup from amazon with order summary--> <script src=<?php echo(cba_jquery_setup);?> type="text/javascript"></script> <link href= <?php echo(cba_style_sheet);?> media="screen" rel="stylesheet" type="text/css"/> <script src=<?php if(module_payment_checkoutbyamazon_operating_environment == 'Production'){echo(PROD_POPUP_ORDER_SUMMARY);} else {echo(sandbox_popup_order_summary);}?> type="text/javascript"></script> <!-- end of order summary pop up --> <!-- END CHECKOUT BY AMAZON CODE --> Modifications to OSC_DIR/catalog/shopping_cart.php: There are two changes, one is adding code, and the other is replacing a snippet of code. Add, ~line 42 (before the </head> tag), the following code: <!-- BEGIN CHECKOUT BY AMAZON CODE --> <!-- Produces the javascript popup from amazon with order summary--> <script src=<?php echo(cba_jquery_setup);?> type="text/javascript"></script> <link href=<?php echo(cba_style_sheet);?> media="screen" rel="stylesheet" type="text/css"/> <link type="text/css" rel="stylesheet" media="screen" href=<?php echo(cba_popup_style_sheet);?>/> <script src=<?php if(module_payment_checkoutbyamazon_operating_environment == 'Production'){echo(PROD_1_CLICK);} else {echo(sandbox_1_click);}?> type="text/javascript"></script> <!-- end of order summary pop up --> <!-- END CHECKOUT BY AMAZON CODE --> Replace ~line 197, the following code: <td align="right" class="main"><?php echo '<a href="'. tep_href_link(filename_checkout_shipping, '', 'SSL'). '">'. tep_image_button('button_checkout.gif', IMAGE_BUTTON_CHECKOUT). '</a>';?></td> <td width="10"><?php echo tep_draw_separator('pixel_trans.gif', '10', '1');?></td> </table></td> </table></td> With the following code: 9
2008-11 Amazon.com, Inc. or its Affiliates <td align="right" class="main"><?php echo '<a href="'. tep_href_link(filename_checkout_shipping, '', 'SSL'). '">'. tep_image_button('button_checkout.gif', IMAGE_BUTTON_CHECKOUT). '</a>';?></td> <td width="10"><?php echo tep_draw_separator('pixel_trans.gif', '10', '1');?></td> </table></td> </table></form></td> <tr> <td> <?php // CHECKOUT BY AMAZON CODE // add Checkout by Amazon button to page if Checkout by Amazon module is enabled if (defined('module_payment_checkoutbyamazon_status') && MODULE_PAYMENT_CHECKOUTBYAMAZON_STATUS == 'True') { include_once('checkout_by_amazon/checkout_by_amazon_main.php'); } // END CHECKOUT BY AMAZON CODE?> </td> Modifications to OSC_DIR/catalog/login.php There are three changes, all are adding code. Add, ~line 14 (after require('includes/application_top.php'); ), the following code: require_once("checkout_by_amazon/checkout_by_amazon_constants.php"); Add, ~line 85 (before the </head> tag), the following code: <!-- BEGIN CHECKOUT BY AMAZON CODE --> <!-- Produces the JavaScript popup from Amazon with order summary--> <script src=<?php echo(cba_jquery_setup);?> type="text/javascript"></script> <link href=<?php echo(cba_style_sheet);?> media="screen" rel="stylesheet" type="text/css"/> <link type="text/css" rel="stylesheet" media="screen" href=<?php echo(cba_popup_style_sheet);?>/> <script src=<?php if(module_payment_checkoutbyamazon_operating_environment == 'Production'){echo(PROD_1_CLICK);} else {echo(sandbox_1_click);}?> type="text/javascript"></script> <!-- end of order summary pop up --> <!-- END CHECKOUT BY AMAZON CODE --> Add, ~line 220 (before body_text_eof): Code before: <td colspan="2"><table border="0" width="100%" cellspacing="0" cellpadding="2"> <tr> <td width="10"><?php echo tep_draw_separator('pixel_trans.gif', '10', '1');?></td> <td align="right"><?php echo tep_image_submit('button_login.gif', IMAGE_BUTTON_LOGIN);?></td> <td width="10"><?php echo tep_draw_separator('pixel_trans.gif', '10', '1');?></td> 10
Open-Source Shopping Cart Solutions </table></td> </table></td> </table></td> </table></td> </table></form> Code to add: <?php // BEGIN CHECKOUT BY AMAZON CODE // add Checkout by Amazon button to page if module is enabled if (defined('module_payment_checkoutbyamazon_status') && MODULE_PAYMENT_CHECKOUTBYAMAZON_STATUS == 'True') { include_once('checkout_by_amazon/checkout_by_amazon_main.php'); } // END CHECKOUT BY AMAZON CODE?> Code after: </td> <!-- body_text_eof //--> <td width="<?php echo BOX_WIDTH;?>" valign="top"><table border="0" width="<?php echo BOX_WIDTH;?>" cellspacing="0" cellpadding="2"> <!-- right_navigation //--> <?php require(dir_ws_includes. 'column_right.php');?> <!-- right_navigation_eof //--> Modifications to OSC_DIR/catalog/checkout_payments.php: Replace ~ line 222: $selection = $payment_modules->selection(); With the following code IF YOU DO NOT HAVE GOOGLE CHECKOUT INSTALLED: // CHECKOUT BY AMAZON CODE // Skip Checkout by Amazon in payment option list because it is selected from shopping cart page $selection = $payment_modules->selection(); for($i=0, $n=sizeof($selection); $i<$n; $i++) { if($selection[$i]['id'] == 'checkout_by_amazon') { array_splice($selection, $i, 1); break; } } // END CHECKOUT BY AMAZON CODE With the following code IF YOU HAVE GOOGLE CHECKOUT ALREADY INSTALLED: Replace: // ** GOOGLE CHECKOUT ** // Skips Google Checkout as a payment option on the payments page since that option // is provided in the checkout page $selection = $payment_modules->selection(); for($i=0, $n=sizeof($selection); $i<$n; $i++) { if($selection[$i]['id'] == 'googlecheckout') { array_splice($selection, $i, 1); break; } } 11
2008-11 Amazon.com, Inc. or its Affiliates // ** END GOOGLE CHECKOUT ** With: // ** GOOGLE CHECKOUT, CHECKOUT BY AMAZON ** // Skips Google Checkout and Checkout by Amazon payment options on the payments page since that option // is provided on the shopping cart page $selection = $payment_modules->selection(); for($i=0, $n=sizeof($selection); $i<$n; $i++) { if(($selection[$i]['id'] == 'googlecheckout') ($selection[$i]['id'] == 'checkout_by_amazon')) { array_splice($selection, $i, 1); $i--; } } // ** END GOOGLE CHECKOUT, CHECKOUT BY AMAZON ** Log in as Administrator in oscommerce's Administrator UI and follow the instructions, in README.txt. Please be sure to read the "Requirements" section as well. 12
Open-Source Shopping Cart Solutions 3 Zen Cart 3.1 Updates Update version Problem Change 2010_08_10_1_13 See release notes See release notes Here is the Readme and Installation Guide for the Zen Cartsolution: 3.2 README.txt CHECKOUT BY AMAZON PLUGIN v1.0 FOR ZEN CART 1.3.9e Author: Balachandar Muruganantham Copyright: 2007-2010 Amazon Technologies, Inc CONTENT SECTIONS (in order of appearance) INTRODUCTION RELEASE NOTES AND UPCOMING FEATURES IMPORTANT NOTICES FOR CERTAIN SOFTWARE COMPONENTS REQUIREMENTS SETUP ON ADMIN UI SUPPORT & PROJECT HOME LINKS INTRODUCTION Please understand that by installing Checkout by Amazon Payment Module for Zen Cart, you are agreeing to understand and abide by the terms of the license, as written in LICENSE.txt. Important links are grouped together in a separate section for your convenience. The most current documentation on Checkout by Amazon can be found on its website. RELEASE NOTES AND UPCOMING FEATURES This is the first GA release for Checkout By Amazon Plugin v1.0 for Zen Cart and can be used in a production environment. We highly recommend the installation of this release by store owners who will be performing it themselves. Following functionality of Checkout By Amazon is available in v1.0 - Checkout with Amazon button on the Shopping Cart page - Amazon 1-Click Checkout Integration - Signed / Unsigned Carts - Ability to add custom data required by merchants via custom data modules - Manage shipping rates, tax rates, promotions, and orders placed on Seller Central - Manage orders through your Zen Cart order management UI (using CBA feeds APIs) - Manage shipping and tax calculation dynamically when the order is being placed (using CBA Callback and Flexible Ship Options functionality) - Get instant notification as soon as the order is placed (using CBA IOPN functionality) Upcoming features 13
2008-11 Amazon.com, Inc. or its Affiliates - Alternate payment method listing IMPORTANT (1) Carefully follow all instructions in INSTALLATION_GUIDE.txt (2) You must have set up an Amazon Seller account & have your Merchant ID (3) You are strongly encouraged to generate keys from Seller Central, and have your key ready to enable signed orders. Unsigned orders are vulnerable to fraud. (4) Note that Checkout by Amazon standards do not allow the weight of products to be 0 at this time. Thus, a weight tag = 0 will be removed from the XML cart before the order is processed (5) The orders that are processed through the Checkout by Amazon Zen Cart plugin should be managed *only* from within Zen Cart Order management page. Please do not use Seller Central to manage orders placed using the Zen Cart plug-in; if you are using Seller Central, then please manually update the same order in Zen Cart Order Management page (6) The Checkout by Amazon Zen Cart plug-in allows you calculate tax rates or use shipping modules in Zen Cart and in Seller Central. You, the seller, will need to be sure that your desired tax rates and shipping modules are configured in Zen Cart and in Seller Central. The configured tax rates or shipping modules will be used to calculcate tax and shipping rates via Callbacks. If merchant's callback end point fails to respond within 5 seconds, settings from Seller Central are used. (7) The price that is included in the XML carts sent to Checkout by Amazon from Zen Cart includes promotion prices set in Zen Cart; that is, the promotion has already been applied to the item. If you, the seller, also configure promotions in Seller Central, these will *also* be applied *in addition to* the promotion from Zen Cart. (8) Please note that the SKU, Title, & Description fields of products may be truncated when building the Checkout by Amazon cart. This is to comply with the standards set by Checkout by Amazon. Please see the Checkout by Amazon documentation in "LINKS" section below. LINKS and REFERENCES Know more about Checkout By Amazon https://payments.amazon.com/sdui/sdui/business?sn=cba/o&apaysccid=ap_ ZENCART Checkout by Amazon Documentation https://sellercentral.amazon.com/gp/help/ Amazon Web Services http://www.amazon.com/webservices Amazon Seller Community Website http://www.amazonsellercommunity.com/forums/ NOTICES FOR CERTAIN SOFTWARE COMPONENTS 1. Notices for Software Components Licensed Under the GNU General Public License. The following are notices for software components that are free software licensed under version 2 of the GNU General Public License (the "GPL"), the full text of which is set forth in the LICENSE.TXT file accompanying this package, as published by the Free Software Foundation (such software, collectively, the "GPL Software"). Portions of these software components have been modified by Amazon.com in order to function with Amazon's Checkout by Amazon service. 14
Open-Source Shopping Cart Solutions a. Modification Notice. The GPL Software has been modified [2007-2008]. b. Terms Applicable to the GPL. The full text of the GPL is set forth in the LICENSE.TXT file accompanying this package. You may redistribute the GPL Software and/or modify it under the terms of the GPL. The GPL Software is distributed WITHOUT ANY WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. You may, for a period of up to three years, obtain, for a charge equal to the cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code. See the terms of the GPL for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. c. Name and Copyright Notice. The following are the names of the GPL Software and the applicable copyright notices: - Zen Cart (c) 2003-2010 Zen Ventures LLC - XmlBuilder.php (c) 2006 Google Inc. - XML Library, by Keith Devens, version 1.2b - XML Library changes - oscommerce, Harald Ponce de Leon 2005-01-22; 2. Notices for Software Components Licensed Under the PHP license. The following are notices for software components that are free software licensed under the PHP License version 3.0 (such software, collectively, the "PHP Software"). a. Terms Applicable to the PHP Software. The PHP Software includes PHP, freely available from http://www.php.net/. Redistribution and use of the PHP Software, in source and binary forms, with or without modification, is permitted provided that the following conditions are met: 1. Redistributions of source code must retain the following copyright notice, this list of conditions and the following disclaimer. "Copyright (c) 1999-2006 The PHP Group. All rights reserved." 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name "PHP" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact group@php.net. 4. Products derived from this software may not be called "PHP", nor may "PHP" appear in their name, without prior written permission from group@php.net. You may indicate that your software works in conjunction with PHP by saying "Foo for PHP" instead of calling it "PHP Foo" or "phpfoo" 5. The PHP Group may publish revised and/or new versions of the license from time to time. Each version will be given a 15
2008-11 Amazon.com, Inc. or its Affiliates distinguishing version number. Once covered code has been published under a particular version of the license, you may always continue to use it under the terms of that version. You may also choose to use such covered code under the terms of any subsequent version of the license published by the PHP Group. No one other than the PHP Group has the right to modify the terms applicable to covered code created under this License. 6. Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes PHP, freely available from <http://www.php.net/>". THIS SOFTWARE IS PROVIDED BY THE PHP DEVELOPMENT TEAM ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PHP DEVELOPMENT TEAM OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. b. Name and Copyright Notice. The following is the names of the PHP Software and the relevant copyright notices. - HMAC.php (c) 1997-2005 The PHP Group. All rights reserved. REQUIREMENTS (1) Zen Cart 1.3.9e or 1.3.8a must be installed We have not tested the plug-in with other versions of Zen Cart. Please use it at your own risk. (2) Seller account from Amazon.com Please see the Seller Central website in "LINKS" section of this document. (2a)Your Merchant ID. - Log in to Seller Central (Please see Seller Central website in "LINKS" section of this document.) - Click Settings -> 'Checkout Pipeline Settings' tab - 'Checkout Pipeline Settings' page has section which displays your Merchant ID. SET-UP ON ADMIN UI 1. General Options ------------------ a. Enable the Checkout by Amazon Module: Set this to "true" to use Checkout by Amazon as an option on your website. b. Checkout by Amazon Merchant ID: Enter your Merchant ID to enable Checkout by Amazon on your website. You can find your Merchant ID in Seller Central by clicking Settings > Checkout Pipeline Settings. c. Operating Environment: Select your operating environment, Sandbox (testing) or Production (live orders). 16
Open-Source Shopping Cart Solutions d. Checkout Button Size: Set the button size you want to use, either large (151 x 27 px) or medium (126 x 24 px). e. Button Style: Select the color of the button you want to place on your website. f. Sort Order Display: Select the order you want to display Amazon Payments relative to your other payment options, from lowest value (first position) to higher values (secondary positions). g. Cart Expiration Time: (Optional) Set the time interval before a customer's cart expires and is reset. If you do not set this value, the cart will not expire. h. Cancellation Return Page: The page you want to send customers to when they cancel an order within the checkout pipeline (before they click the "Place Your Order" button). The default setting returns your customers to the catalog index page without clearing the shopping cart. i. Success Return Page: The page you want to send customers to when they successfully complete an order within the checkout pipeline (that is, they click the "Place Your Order" button). The default setting returns your customers to the catalog index page in your store. j. Enable Diagnostic Logging: If set to true, enables logging for debugging. The debugging log is located in your catalog/checkout_by_amazon/log/ directory, and is named checkout_by_amazon.log. 2. Signing Options ------------------ a. Enable Order Signing: Select whether you want to accept signed orders (secure) or unsigned (insecure). As unsigned orders are vulnerable for fraud, we recommend you enable signed orders. b. Access Key ID: Enter your Seller Central Access Key ID. This key, paired with your Seller Central Secret Key, is required for signed orders. You can get your Seller Central Access Key in Seller Central by clicking Integration > MWS Access Key. c. Secret Key: Enter your Seller Central Secret Access Key. This key, paired with your Seller Central Access Key ID, is required for signed orders. Treat your secret key like a password. You can get your Seller Central Access Key in Seller Central by clicking Integration > MWS Access Key and then clicking +Show. 3. Order Management Options ----------------------------- a. Enable Order Management: Enable this feature to view and manage (ship, refund, or cancel) Checkout by Amazon orders within the Admin Order UI without logging in to Seller Central. Before you enable this feature, you must enable programmatic XML feeds. Please contact us to enable XML feeds. b. Checkout by Amazon Merchant Login ID: Enter your login ID (the e-mail address you use to log in to your Checkout by Amazon merchant account on Seller Central). c. Checkout by Amazon Merchant Password: Enter your password (the password you use to log in to your Checkout by Amazon merchant account on Seller Central). d. Checkout by Amazon Merchant Token: Enter your Merchant Token. You can get your Merchant Token in Seller Central by clicking Settings > Account Info and scrolling down to the Your Merchant Token section. e. Checkout by Amazon Merchant Name: Enter your Merchant Business Display Name. You can get your Merchant Business Display Name in Seller Central by clicking Settings > Account Info and scrolling down to the Your Business Information section. 4. Order Status Mapping ------------------------- Order status mapping is required to map the amazon order status with your own custom status in this site. If the recommended status is *not* available, 17
2008-11 Amazon.com, Inc. or its Affiliates 18 please add it by going to your order status page For example, http://mystore/admin/orders_status.php a. ReadyToShip Order Status: What should be the order status after Amazon processes it? This state will indicate that the order is pending shipment from your end. Recommended: Pending b. Delivered Order Status: What should be the order status after you deliver it? The order will move into this state when you click the button. Recommended: Delivered c. Refund Order Status: What should be the order status after you apply a refund on it? The order will move into this state when you click the button. Recommended: Refund d. Canceled Order Status: What should be the order status when the order gets canceled? The order will move into this state when you click the button or when the buyer or Amazon cancels it. Recommended: Canceled 5. Callback Options ------------------- IMPORTANT: To enable dynamic shipping and tax calculation using callback, you should have a https enabled callback endpoint. a. Enable Callbacks: You can use the Callback API to dynamically calculate shipping (using USPS, FedEx, UPS or any *enabled* shipping modules) or taxes as calculated by your site when customers are in the checkout pipeline. b. Callback Page: Enter the URL on your site where Amazon sends the callback request for dynamic rate calculations. The URL should contain the host and port, and should be set to the path catalog/checkout_by_amazon.php. For example, https://mydomain.com/catalog/checkout_by_amazon.php. c. Enable Shipping Calculations: Enable dynamic shipping rate calculations (callbacks) from any of the shipping modules.. You can enable multiple shipping modules in your Modules > Shipping section in the Admin. d. Enable Tax Calculations: Enable dynamic tax rate calculations (callbacks). Before you enable this feature, apply the correct tax classes and tax rates to your inventory items. e. Is Shipping and Handling Taxed: Select to specify whether to apply the tax rate to the shipping costs as part of the callback. 6. IOPN Setup ------------------- IMPORTANT: To enable IOPN, you should have a https enabled IOPN endpoint. a. Your IOPN End point is https://www.yourdomain.com/checkout_by_amazon.php b. Go to Seller Central > Settings > Checkout Pipeline Settings > Instant Order Processing Notification Settings. Click the "Edit" button and update the Merchant URL. Review your site ----------------- You are strongly encouraged to test several orders in the "Sandbox" environment before enabling "Production" environment SUPPORT & PROJECT HOME The latest documentation on Checkout by Amazon can be found at in the LINKS section below. The latest version of Checkout by Amazon for Zen Cart can be downloaded from the link below. 3.3 INSTALLATION_GUIDE.txt INSTALLATION INSTRUCTIONS FOR CHECKOUT BY AMAZON MODULE FOR ZEN CART
Open-Source Shopping Cart Solutions Author: Balachandar Muruganantham Copyright: 2007-2010 Amazon Technologies, Inc INSTALLATION OPTIONS ------------------------ Please note that by installing Checkout by Amazon Payment Module for Zen Cart, you agree, understand, and will abide by the terms of the License, as written in LICENSE.txt. You have two options for installing the Checkout by Amazon Payment module within Zen Cart. If you have a fresh installation, please follow the directions in "FRESH INSTALL" below. If you already have an existing copy of Zen Cart, please follow the directions in the section marked "EXISTING INSTALL". Please note, if you already have Google Checkout installed in your existing copy of Zen Cart, the last step of the EXISTING INSTALLATION is different, please read the directions carefully. NOTE:This is the first release for Checkout By Amazon Plugin v1.0 for Zen Cart and can be used in a production environment. We highly recommend the installation of this release by store owners who will be performing it themselves. FRESH INSTALL --------------- - copy the files from new_files directory to your ZENCART_DIR/ - copy the file modified_files/includes/templates/template_default/templates/tpl_shopping _cart_default.php to ZENCART_DIR/includes/templates/template_default/templates/tpl_shopping_ca rt_default.php. This will overwrite the existing file - Now go to your Zen Cart Administration > Modules > Payment and select Checkout by Amazon x.x and click on the install button to install the configuration settings. - Click on edit button and give all the details like Merchant Id, and enable order signing with Access ID, Secret Key (if you want your cart to be secure signed) - You are done. Try adding a product to the shopping cart and you should see the Checkout with Amazon button on the shopping cart page. EXISTING INSTALL ------------------ To integrate an existing Zen Cart with Checkout by Amazon, you will need to copy over new files, and modify some existing files within Zen Cart. - copy the files from new_files directory to your ZENCART_DIR/ - You need to modify the shopping cart template file. see below "Modifying tpl_shopping_cart_default.php" for instruction - Now go to your Zen Cart Administration > Modules > Payment and select Checkout by Amazon x.x and click on the install button to install the configuration settings. - Click on edit button and give all the details like Merchant Id, and enable order signing with Access ID, Secret Key (if you want your cart to be secure signed) - You are done. Try adding a product to the shopping cart and you should see the Checkout with Amazon button on the shopping cart page. INSTANT ORDER NOTIFICATION ------------------------------- See README > SETUP ON ADMIN UI > 6. IOPN Setup Modifying tpl_shopping_cart_default.php 19
2008-11 Amazon.com, Inc. or its Affiliates --------------------------------------- search for the following code line no. 153-157 <div class="buttonrow back"><?php echo '<a href="javascript:popupwindow(\''. zen_href_link(filename_popup_shipping_estimator). '\')">'. zen_image_button(button_image_shipping_estimator, BUTTON_SHIPPING_ESTIMATOR_ALT). '</a>';?></div> <?php }?> add the following Code after the above lines i.e line no 158: <!-- ** BEGIN CHECKOUT BY AMAZON ** --> <?php // the button template displays CBA button if cart contents >0 and value >0 if (defined('module_payment_checkoutbyamazon_status') && MODULE_PAYMENT_CHECKOUTBYAMAZON_STATUS == 'True') { include_once(dir_fs_catalog. 'checkout_by_amazon/tpl_button.php'); }?> <!-- ** END CHECKOUT BY AMAZON ** --> Note: Line no may not be exactly the same as mentioned here. Please take extra care when adding the code. Always take backup of your files. CONFIGURING CRON JOB ------------------------ Please configure or ask your hosting provider to configure a cron job that can run once in 5 minutes. This cron job ensures that the orders and order statuses are synched up with Amazon on a regular basis. Please refer example below for a sample cron job configuration. IMPORTANT: If you want to manage orders placed through Checkout By Amazon on your website, setting up the cron job is mandatory. */5 * * * * wget "http://mystore/checkout_by_amazon.php?action=everything" -O /dev/null This cron is required to keep your orders in sync with Amazon Seller Central Order system. Note: Some Hosting provider will not allow you to set cron run once in 5 minutes. In such case, please contact hosting provider for appropriate configurations. 20