Type
magento2-module
Flow Connector
magento2-module
proprietary
None
None
None
None
None
This module provides the core components for integrating with Flow.
Flow is a comprehensive global e-commerce solution. For more information about Flow's capabilities please reference Flow Integration Overview.
require
section of your composer.json
, require the flowcommerce/flowconnector
module."require": {
"flowcommerce/flowconnector": "^1.1.6"
}
composer update
compose install
./bin/magento setup:upgrade
Login to your Flow Console: - Create your Organization's first viable Experience. - If you do not have an Organization yet or need more information about your Flow Console, Organizations, and Experiences, please contact your Customer Success Manager. - An Experience is viable for checkout when it is "Active" and has Shipping Tiers available. Flow Logistics Setup - From the left menu, select Organization Settings -> API Keys. - This is where you can find and generate Flow API Keys for use in the Magento 2 Back Office setup - You will also need your Flow Organization ID for Magento 2 Back Office setup. It can be found in your current browser address bar 'https://console.flow.io/YOUR-ORGANIZATION-ID-HERE/organization/api-keys'.
Login to your Magento 2 Back Office: - From the left menu, click on Stores -> Configuration. - Change the Scope to your store (or default store if you only have one). - Select Flow -> Connector Settings, enable the connector and fill out your Flow Organization ID and Flow API Key. - After saving the configuration, the module will connect to Flow and register webhooks. You can view webhooks from your Flow Console -> Organization Settings.
Console commands provided by this module:
flow:flow-connector:catalog-sync-attributes-save Saves product attributes needed for the integration in flow.io
flow:flow-connector:catalog-sync-process Process sync skus queue and send to Flow.
flow:flow-connector:catalog-sync-queue-all Queue all products for sync to Flow catalog.
flow:flow-connector:cron-cleanup Clean up Flow cron tasks.
flow:flow-connector:integration-initialize Initializes integration with flow.io. This is a wrapper for webhooks registration, attributes creation, inventory center key fetching and creating secret for webhook payload verification.
flow:flow-connector:inventory-center-fetch-keys Fetches inventory center keys for all store views where flowconnector is configured.
flow:flow-connector:inventory-sync-process Process inventory sync queue and send to Flow. Warnings may be logged for items which are configured to not track inventory.
flow:flow-connector:inventory-sync-queue-all Queue all products for sync to Flow inventory.
flow:flow-connector:webhook-event-process Process Flow webhook events.
flow:flow-connector:webhook-register-webhooks Register webhooks with Flow.
flow:flow-connector:webhook-update-settings Create secret for webhook payload verification.
To update the plugin to the latest version, run:
composer update
compose install
./bin/magento setup:upgrade
Documentation: Flow Product Catalog
This module will sync product information to Flow in two ways:
Documentation: Flow Checkout UI
Once your Magento 2 Catalog is fully synced with Flow Product Catalog, customers can be sent to Flow Hosted Checkout. There is a redirect URL included in this module that will send the user's cart and information to Flow Hosted Checkout.
/flowconnector/checkout/redirecttoflow?country=FRA
To localize pricing data, please refer to Flow.js Product Localization.
Discount codes have limited functionality as of version 1.0.40. The conditions under which a discount code can be applied to a CUI order are as follows: - Does not apply to the shipping amount - Is not a “Buy X Get Y” discount - Does not apply a discount to a specific item in the cart through the use of Magento 2 Sales Rule “Action” conditions - Applies to all cart items evenly
To enable this feature for your Organization please contact your Customer Success Manager.
IMPORTANT: Due to how Magento 2 calculates Cart Sales Rules it is possible that other Magento 2 Cart Sales Rules may apply to an order when applying a valid discount code. If you need to isolate a Magento 2 Sales Rule, raise the priority of your discount code and enable the option "Discard subsequent rules". This will calculate that discount first and disregard the following Magento 2 Sales Rules.
Documentation: Flow Webhook
Upon configuring this module with your Flow credentials, the module will configure a set of webhooks to receive event data from Flow. These webhook events are queued and processed with a cron task. For example, after a customer submits an order through Flow Checkout UI, a series of webhook events will be sent to Magento 2 with detailed order and payment information.
This module will dispatch several events that observers can listen to:
Flow\FlowConnector\Model\WebhookEvent::EVENT_FLOW_PREFIX
+ the event type.Flow\FlowConnector\Model\WebhookEvent::EVENT_FLOW_PREFIX
+ the event type + Flow\FlowConnector\Model\WebhookEvent::EVENT_FLOW_SUFFIX_AFTER
.Flow\FlowConnector\Model\Sync\CatalogSync::EVENT_FLOW_PRODUCT_SYNC_AFTER
.Flow\FlowConnector\Model\WebhookEvent::EVENT_FLOW_CHECKOUT_EMAIL_CHANGED
.