The Fluent Commerce commercetools connector was created by Orium, and provides the following features:
- Ability to capture customer order events from commercetools to Fluent, including payment transaction details.
- Ability to initially load all products from commercetools to Fluent Commerce when the connector is installed. See Caveats for more details.
- Ability to continuously synchronize products from commercetools to Fluent Commerce in near real-time.
- Ability to update Order status on commercetools when the order is completed on Fluent Commerce.
The application receives events (like product publication or order creation) from commercetools, processes them, and then creates corresponding entities in FluentCommerce.
This is achieved through a POST endpoint which receives the event, processes it, and depending on the event type, either creates a product or an order in FluentCommerce.
- FluentCommerce retail account
- FluentCommerce Lingo account
- commercetools account
- commercetools API keys (“Admin client”)
In order to install the connector in your commercetools project, you'll need to deploy it. Refer to the commercetools connect deployment documentation.
Service and Event applications needs setup the required environment variables when you create the deployment:
CTP_CLIENT_IDCTP_CLIENT_SECRETCTP_PROJECT_KEYCTP_SCOPECTP_REGIONFLUENT_CLIENT_SECRETFLUENT_CLIENT_IDFLUENT_USERNAMEFLUENT_PASSWORDFLUENT_HOSTFLUENT_CATALOGUE_REFFLUENT_RETAILER_IDFLUENT_CATALOG_LOCALE
For service you additionally will need the following environment variables:
FLUENT_WEBHOOK_NAMEBASIC_AUTH_SECRET
Once the connector is deployed, it should trigger the postDeploy script.
The post-deploy script will create a commercetools API subscription to listen to “Order Created” and “Product Published” messages . Each time an order is created or a product is published, the commercetools API will send a message to the connector.
In order to uninstall the connector, you’ll need to send the appropriate HTTP request and delete it.
This will trigger the preUndeploy script which will delete the messages subscriptions described on the “Installing the connector” section.
During installation this connector sets up subscription listen for any product publish and updates or insert the product on Fluent. However, after installation, we recommend triggering a manual first time sync in order to have your data imported into Fluent as soon as possible. Follow the steps below to trigger the first product sync.
1 - Execute a GET request to retrieve your Service URL:
curl --get https://connect.us-central1.gcp.commercetools.com/{{ CTP_CLIENT_ID }}/deployments/key={{ COMMERCETOOLS_DEPLOYMENT_KEY }} \
--header 'Authorization: Bearer {{ access_token }}' | json_pp | grep https://Replace
{{ CTP_CLIENT_ID }}and{{ COMMERCETOOLS_DEPLOYMENT_KEY }}with the values used when creating the deployment.
The url will look like this https://service-2da6408a-5e4e-493e-a413-c248f2c37174.us-central1.gcp.preview.commercetools.app/service
2 - After retrieving the Service URL, send a GET request to trigger the products sync.
curl -u {{ CTP_PROJECT_KEY }}:{{ BASIC_AUTH_SECRET }} \
https://service-2da6408a-5e4e-493e-a413-c248f2c37174.us-central1.gcp.preview.commercetools.app/service/fluent-catalog-ingestionReplace
{{ CTP_PROJECT_KEY }}and{{ BASIC_AUTH_SECRET }}with the values you used when creating the deployment.Replace
https://service-2da6408a-5e4e-493e-a413-c248f2c37174.us-central1.gcp.preview.commercetools.app/servicewith the service url you got in the previous step.
The connector is designed to load all products at once, which might result in extended HTTP request times, potentially exceeding predefined limits. We anticipate that it will handle a modest number products, likely no more than a 200. The exact capacity may fluctuate due to various variables. Feel free to get in touch with us if this is a limitation for your project.
When a product is published on commercetools, an event of type 'ProductPublished' is received. The application checks if this product has a key. If there isn't one, the product is not processed.
If a product key exists, the application proceeds to create or update a 'standard product' and its 'variants' in FluentCommerce.
If a product key exists, but the variant has an SKU equals to that key, the connector will not process the product. This is because standard products should have a unique Ref in FluentCommerce, and SKU will be used for Ref in variants.
The standard product, which represents the main product, includes details like the product name, description. The variants represent different forms of the product, like different sizes or colors and include similar information as the standard product, along with their SKU (Stock Keeping Unit).
When an order is created on commercetools, an event of type 'OrderCreated' is received. The application checks if this order has a customer email and customer ID. If these fields don't exist, the order is not processed.
If they do, the application proceeds to create an order in FluentCommerce. If the customer associated with the order doesn't exist in FluentCommerce, a new customer is created along with the order.
If there are payments associated with the order, a financial transaction is created in FluentCommerce.
When an order is updated on Fluent, an WebHook will be triggered and the connector will update the order on commercetools. You will have to configure out the workflow on Fluent to trigger the WebHook when an order is COMPLETED. You should set the FLUENT_WEBHOOK_NAME env variable with the name of the WebHook you created on Fluent.
- By default, commercetools has built-in i18n support. In order to consume the catalog data, we must specify the desired
LocalizedString.
- Fluent will consume products data from an endpoint exposed by the connector. This endpoint is secured using a basic http authentication, where the username is the
CTP_PROJECT_KEYand the password theBASIC_AUTH_SECRET.
- Since the Webhook endpoint will no have proteccion by default, we need to make sure only the Fluent Webhook will be able to trigger the endpoint. The
FLUENT_WEBHOOK_NAMEenv variable will be used to validate the request.