cartintegration:magento:magento
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
cartintegration:magento:magento [2010/09/01 04:27] – earlyimpact | cartintegration:magento:magento [2012/09/24 04:07] (current) – matt | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== SubscriptionBridge Extension for Magento (BETA) ====== | + | ~~NOTOC~~ |
+ | < | ||
+ | |||
+ | The Magento Add-On is no longer supported in-house by Early Impact. | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | ====== SubscriptionBridge Extension for Magento (BETA) ====== | ||
===== Overview ===== | ===== Overview ===== | ||
{{ : | {{ : | ||
- | The **SubscriptionBridge Extension for Magento** | + | The **[[http:// |
+ | |||
+ | During checkout, Magento will detect that the product/ | ||
Features include: | Features include: | ||
- | * Easily activate a **live connection** between your Magento-powered store and your SubscriptionBridge Merchant | + | |
- | * **Map items** in your Magento store catalog | + | |
+ | * **Map items** in your Magento store catalog | ||
* Automatically display subscription terms when showing product details and during checkout, via the **built-in [[developer_guide: | * Automatically display subscription terms when showing product details and during checkout, via the **built-in [[developer_guide: | ||
- | * Automatically create a subscription in the recurring payment system associated with your SubscriptionBridge store | + | |
- | * ... | + | |
+ | * Manage subscription billing and recurring payments through SubscriptionBridge | ||
+ | |||
+ | The extension is now in **BETA** simply because it needs to be used in "real life" environments for a bit longer to ensure that everything is working as expected. We will remove the BETA label as soon as possible. | ||
+ | |||
+ | ===== Screen shots ===== | ||
+ | |||
+ | ==== Product details page ==== | ||
+ | |||
+ | The product details page in the Magento storefront catalog automatically loads subscription terms information from SubscriptionBridge, | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ==== Shopping cart page ==== | ||
+ | |||
+ | Subscription terms are also shown on the shopping cart page when the product (subscription) is added to the shopping cart. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ==== Magento store administration ==== | ||
+ | |||
+ | In the Magento store administration area you can quickly activate the integration with SubscriptionBridge, | ||
+ | |||
+ | {{: | ||
+ | {{: | ||
+ | {{: | ||
+ | |||
+ | Once you have created a link between a product and a SubscriptionBridge package, there are a number of settings that you can define at the product level. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ===== Installing the SubscriptionBridge Extension ===== | ||
+ | |||
+ | The [[http:// | ||
+ | |||
+ | To install the SubscriptionBridge Extension for Magento: | ||
+ | |||
+ | * In your Magento administration area, click on "// | ||
+ | * Load the SubscriptionBridge Extension page in the Magento Connect Web site | ||
+ | * Request the extension key for the extension by clicking on the corresponding button | ||
+ | * Enter the extension key in the Magento Connect Manager and click on " | ||
+ | * Click on " | ||
+ | |||
+ | {{: | ||
+ | |||
+ | * Click on " | ||
+ | |||
+ | ===== Activating the SubscriptionBridge Extension ===== | ||
+ | |||
+ | Before you can associate products in your Magento catalog with subscription package in SubscriptionBridge, | ||
+ | |||
+ | ==== Obtaining API credentials from SubscriptionBridge ==== | ||
+ | |||
+ | * Open a new browser window and log into the [[https:// | ||
+ | * Locate the SubscriptionBridge store that you want to connect to your Magento-powered store | ||
+ | * Click on **API Credentials** | ||
+ | * Agree to the Terms & Conditions and then API credentials will be shown to you | ||
+ | |||
+ | ==== Entering the SubscriptionBridge credentials in Magento ==== | ||
+ | |||
+ | * Return to Magento and select " | ||
+ | * Select // | ||
+ | * Enter the API credentials that you obtained from SubscriptionBridge (your other browser window should still be open) | ||
+ | * API User Name | ||
+ | * API Password | ||
+ | * API Key | ||
+ | * The API URL is pre-populated with the default value (< | ||
+ | * Click on "Save Config" | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ===== SubscriptionBridge settings in Magento ===== | ||
+ | |||
+ | Under "// | ||
+ | |||
+ | ==== SubscriptionBridge Center Links ==== | ||
+ | |||
+ | There are two fields that contain pre-populated URLs to the SubscriptionBridge Customer and Merchant Center. You should not need to change these links. | ||
+ | |||
+ | ==== Messages ==== | ||
+ | |||
+ | You can edit default messages shown by Magento in the storefront. Specifically: | ||
+ | |||
+ | * **Message - Cart not valid** \\ This message pertains to a current limitation: customers can only purchase a subscription product OR a regular product, but not both at the same time. This limitation might be removed in the future. The default message is: "//The shopping cart is not valid. You can add only one subscription product or general products.//" | ||
+ | * **Message - Terms and Condition Title** \\ You can show "Terms & Conditions" | ||
+ | * **Message - Add subscription not allow** \\ This message pertains to a current limitation: customers can only purchase a subscription product OR a regular product, but not both at the same time. This limitation might be removed in the future. This message is shown when there is already a " | ||
+ | * **Message - No additional products** \\ This message pertains to a current limitation: customers can only purchase a subscription product OR a regular product, but not both at the same time. This limitation might be removed in the future. This message is shown when there is already a " | ||
+ | * **Message - Only one subscription** \\ This message pertains to a current limitation: customers can only purchase one subscription at a time. This limitation might be removed in the future. This message is shown when there is already a " | ||
+ | |||
+ | ===== Associating Products and Subscription Packages ===== | ||
+ | |||
+ | To turn an item in your Magento store catalog into a subscription-based product or service, you need to "link it" to a package that you have __previously__ setup in the SubscriptionBridge Merchant Center. | ||
+ | |||
+ | ==== Create a Package in SubscriptionBridge ==== | ||
+ | |||
+ | Make sure that you have already created at least one package in SubscriptionBridge, | ||
+ | |||
+ | ==== Linking Packages and Products ==== | ||
+ | |||
+ | * Log into your Magento admin area | ||
+ | * Click on "// | ||
+ | * Search for the item that you want to turn into a subscription and click "// | ||
+ | * The **Packages** drop-down will load a list of the packages that have been setup in your SubscriptionBridge Merchant Center and that are ready for sale (not all packages will be listed). | ||
+ | * Select the subscription package that you want to associate with this product | ||
+ | * Then enter settings that are consistent with the package settings that you have created in SubscrptionBridge (e.g. trial price) | ||
+ | * If you want customers to have to agree to Terms & Conditions for the subscription during checkout, set "// | ||
+ | * Click "// | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ==== Subscription Price ==== | ||
+ | |||
+ | Note that the regular price for this subscription-based product or service is not shown in this window. Only the trial price is (if any). That's because the " | ||
+ | |||
+ | ==== Listing existing subscription Packages ==== | ||
+ | |||
+ | You can now view a list of the items that you have linked to subscription packages by selecting // | ||
+ | ===== Subscription Terms Widget ===== | ||
+ | |||
+ | The Subscription Terms Widget allows you to show terms for the subscription in the Magento storefront, dynamically retrieving them from SubscriptionBridge. You can style the widget using simple CSS. | ||
+ | |||
+ | To show the widget, you need to edit a few files in the Magento storefront. This is because " | ||
+ | |||
+ | ==== Edit " | ||
+ | |||
+ | * Download the file " | ||
+ | * Open it in Notepad or your favorite HTML editor | ||
+ | * Locate the following code around line 68 < | ||
+ | * Add the following code right after that line: < | ||
+ | // start code to add | ||
+ | if($_product-> | ||
+ | // end code to add | ||
+ | ?></ | ||
+ | * Save the file and upload it back to the Web server. | ||
+ | |||
+ | ==== Edit " | ||
+ | |||
+ | * Download the file " | ||
+ | * Open it in Notepad or your favorite HTML editor | ||
+ | * Locate the following code around line 52 < | ||
+ | * Add the following code right after that line: < | ||
+ | // start code to add | ||
+ | if($_item-> | ||
+ | // end code to add | ||
+ | ?></ | ||
+ | * Save the file and upload it back to the Web server. | ||
+ | |||
+ | ==== Edit " | ||
- | ===== Status Update ===== | + | * Download the file " |
+ | * Open it in Notepad or your favorite HTML editor | ||
+ | * Locate the following code around line 49 < | ||
+ | * Add the following code right after that line: < | ||
+ | // start code to add | ||
+ | if($_item-> | ||
+ | // end code to add | ||
+ | ?></ | ||
+ | * Save the file and upload it back to the Web server. | ||
- | The integration between SubscriptionBridge and Magento is currently under way. We are performing final testing and an extension will be submitted to Magento Connect over the next few days. It will __initially be released as a BETA release__, which means that we acknowledge that not enough testing has been done in "real life" scenarios. | + | ==== Edit " |
- | ===== User Guide ===== | + | * Download the file " |
+ | * Open it in Notepad or your favorite HTML editor | ||
+ | * Locate the following code around line 29 < | ||
+ | * Add the following code right after that line: < | ||
+ | // start code to add | ||
+ | $_sbOrder | ||
+ | $_sbPayment | ||
+ | if($_sbPayment-> | ||
+ | echo $this-> | ||
+ | endif; | ||
+ | // end code to add | ||
+ | ?></ | ||
+ | * Save the file and upload it back to the Web server. | ||
- | Detailed instructions on how to use the integration between SubscriptionBridge and Magento will be posted soon. | + | ===== Other notes ===== |
+ | ==== Product Type ==== | ||
- | Last updated on August 31st, 2010. | + | If you are selling a subscription-based service (i.e. non-shipping, typically non-taxable), |
+ | ==== Current Limitations ==== | ||
+ | * One subscription \\ You can only purchase one subscription product/ | ||
+ | * Either a subscription or regular products \\ You cannot put in the shopping cart, at the same time, a subscription product with one or more regular products. Subscriptions must be purchased separately. The message that informs customers of this scenario can be edited in the Magento administration area. | ||
+ | * PayPal Express Checkout \\ PayPal Express Checkout is not supported at this time. |
cartintegration/magento/magento.1283329632.txt.gz · Last modified: 2010/09/01 00:00 (external edit)