flowcommerce/flowconnector 1.0.21

Flow Connector

Flow Connector Magento Module

This module is used to integrate your Magento store with Flow.

Please make sure you are familiar with the Flow Integration Overview.

Flow Integration

This module provides the core components for integrating with Flow.

Product Catalog

Documentation: Flow Product Catalog

This module will sync product information to Flow in two ways:

1. Product updates (and deletes) are queued with an observer. This queue is processed with a cron task every minute, with additional workers spawned every minute the queue is not empty.
2. There is a cron task that will sync the entire product catalog to Flow. By default, this will sync twice a day.

Hosted Checkout

Documentation: Flow Hosted Checkout

Once your Magento Catalog is fully synced with Flow, 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

For localization of pricing data, please refer to the Flow.js documentation.

Webhook Processing

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 completes the Flow Hosted Checkout process, a series of webhook events will be sent to Magento with detailed order and payment information.

Extending Functionality

This module will dispatch several events that observers can listen to:

• An event is dispatched when a webhook event is received from Flow.
  • List of event types can be found in the Model/WebhookEventManger.php registerWebhooks() method.
  • The event name will be Flow\FlowConnector\Model\WebhookEvent::EVENT_FLOW_PREFIX + the event type.
• An event is dispatched after a webhook event is processed.
  • List of event types can be found in the Model/WebhookEventManger.php registerWebhooks() method.
  • The event name will be Flow\FlowConnector\Model\WebhookEvent::EVENT_FLOW_PREFIX + the event type + Flow\FlowConnector\Model\WebhookEvent::EVENT_FLOW_SUFFIX_AFTER.
• An event is dispatched after a product has been synced to Flow.
  • The event name is defined in Flow\FlowConnector\Model\Sync\CatalogSync::EVENT_FLOW_PRODUCT_SYNC_AFTER.
• An event is dispatched if the customer changed their email address during Flow Hosted Checkout.
  • The event name is defined in Flow\FlowConnector\Model\WebhookEvent::EVENT_FLOW_CHECKOUT_EMAIL_CHANGED.

Administration

Installation

In the require section of your composer.json, require the flowcommerce/flowconnector module.

"require": {
    "flowcommerce/flowconnector": "^1.0.0"
}

Then from your console run:

composer update
compose install
./bin/magento setup:upgrade

Initial Setup

Login to your Magento Admin: - From the left menu, click on Stores -> Configuration. - Change the Scope to your store (or default store). - In the Flow -> Connector Settings, enable the connector and fill out your Flow Organization Id and Flow API Token. - 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

Console commands provided by this module:

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:webhook-event-process      Process Flow webhook events.
flow:flow-connector:webhook-register-webhooks  Register webhooks with Flow.

Update version

To update the plugin to the latest version, run:

composer update
compose install
./bin/magento setup:upgrade