Download the PHP package ordergroove/subscription without Composer
On this page you can find all versions of the php package ordergroove/subscription. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package subscription
Overview
This repository contains a Magento 2 sample code extension which would serve as a middleware with Ordergroove's subscription service.
- Compatibility Magento 2.4
- Adobe Open Source: 2.4.3-p1
- Adobe Commerce: 2.4.3-p1
- Stable Version -> Latest 1.3.X
- Braintree payment gateway for Credit Card and PayPal payment methods
Currently Known Issues and Limitations
Please note that due to the flexible nature of Magento, it might be possible that other overrides may interfere with this sample code. Please work with your Ordergroove representative to conduct thorough testing as you're going through the integration process.
- This sample code was built with a Braintree payment gateway in mind. If you are using another gateway then code customization is required to store/retrieve vaulted payment methods.
- Credit Cards and PayPal are currently the only supported payment methods. If you want to support additional payment methods then a modification to this code is required to add support or hide alternative payment methods for customers who choose to check out with a subscription in their cart.
- Multi-site support is limited to powering the customer's ability to check out with a subscription and managing their previously created subscriptions in the customer's account section. The sample code does not currently provide full support for placing recurring orders and ingesting the Magento product catalog (aka the product feed)
- This sample code currently relies upon a flat shipping rate being setup in Magento in order to apply a shipping cost for all recurring orders. Because of this, the code hides this flat rate shipping option during standard checkout. If you are explicitly using flat-rate shipping and offering it as an option to your customers, you will have to change the code so that your customers can continue to choose flat rate shipping during checkout.
- This sample code does not have support for customer/payment updates. If your current Magento site provides a way for customers to update their personal details or payment method you can send these updates to Ordergroove using our customer/payment updated APIs
- Sometimes it's very difficult to troubleshoot an environment specific issue, for this purpose we added some logging and by default the logs can be found in the
/var/log/ordergroovedirectory. Ordergroove does not have direct access to these logs so sometimes we may require that you send these to us. - The cron job which is responsible for sending Ordergroove the product feed can skip firing and the product updates may stop making their way into Ordergroove. This is usually related to the default cron schedule attempting to schedule an execution for a time during which the cron won't actually run for the job. If you run into this issue, please contact Ordergroove or take a look at the cron_groups setup for "ordergroove" and adjust it based on your needs.
If you run into an issue which is not listed here, please don't hesitate to add it to the github issues list: https://github.com/ordergroove/magento-module-24/issues
Installation Instructions
Install Ordergroove/Subscription through one of the following two methods. After that, configure the module to connect to Ordergroove as described below.
Install through Composer (recommended)
Run the following commands in your root Magento installation directory:
Install through app/code (not recommended)
Note: When installing through app/code, upgrading the module in the future will be more difficult.
- Create the following directory:
app/code/Ordergroove/Subscription - Download the latest release for the module. (You can download previous releases through this link as well)
- Extract and copy the files to
app/code/Ordergroove/Subscription. - Run the following commands in your root Magento installation directory:
Documentation
Configuration
All configuration is located under Stores > Configuration > Ordergroove > Subscription.
Configuration is available per website, and will not be visible on the default scope.
General Configuration
- Module Enabled - Choose whether the module is enabled or not
- Environment - Determines whether to use staging urls for Ordergroove operations only
- Public ID - Ordergroove Public / Merchant ID. Provided by Ordergroove when setting up an account.
- Note: Public ID should be unique for each website, and should not be reused on multiple websites.
- Hash Key - Ordergroove Hash Key. Provided by Ordergroove when setting up an account.
- Note: - Hash Key should belong to a corresponding Public ID.
SFTP Configuration
-
Sync Schedule is only available in the Default Config scope.
- Select the hour of the day (EST) at which the product sync will occur.
- Host - Un-editable host string. Always points to feeds.ordergroove.com
- Port - Un-editable port string. Is always
22 - Username - SFTP Username provided by Ordergroove
- Password - SFTP Password provided by Ordergroove
- Check Connection - Click after inputting username and password to determine if the credentials are valid.
Logs
Ordergroove/Subscription will log various important information to log files located within
var/log/ordergroove. For example, any product sync related errors will be logged to
var/log/ordergroove/product_sync/error.log, and product sync related messages to
var/log/ordergroove/product_sync/info.log.
Recurring Order (Order Placement)
Placement endpoint configuration
Ordergroove should be configured to send recurring orders to
Enable Flat-rate shipping
The recurring order placement code assumes that flat-rate shipping is enabled. You can enable this feature in Magento via Stores > Configuration > Sales > Delivery Methods
Enable Multi-Source Inventory
If your store uses multi-store inventory, you must enable this feature in the Ordergroove configuration. You can do this via the standard Ordergroove settings available under Stores > Configuration > Ordergroove > Subscription
