commercetools Customer Sync

Sync Type

Automatically by the system

Customers are added to the external message queue, and a dedicated message connect-sdk consumer will handle the message and export the data to Fluent.

CT Queue: Any customer creation/modification will be pushed to ct-queue using commercetools subscriptions. Out-of-the-box(OOTB) connector uses AWS Event Bridge, and it is possible to implement with other queues/subscriptions supported by Commercetools. More details on commercetools subscription.

CT Queue Listener: This class reads the message from CT-Queue and pushes it to the Event queue.

Event Queue: The event queue is responsible for holding the event message to be processed further.

Message Router: It will read the message name from the Event queue and pass it to the appropriate handler.
i.e. in case of customer changes, the message

`typeId`

`commercetools.connect.customer.upsert`

Customer Updates Handler: This will be a class that reads message data from the internal queue and, based on the customer identifier, fetches more information from Commercetools-SDK ( The core commercetools SDK, which interacts with commercetools APIs ) and maps them with Fluent data model and pushes it to Fluent OMS.

The message handlers are fully extensible. Partners can make the changes as per their requirements. The connect-sdk allows message routing with flexible message handlers to process and transform data moving from a source to a destination. Partners can change the message names and override the classes.

Example to extend the functionality

Partners can override existing handlers using application-connector.yml and Handler class. To change the logic of the Category Upsert handler first go to

`commercetools-connector/src/main/resources/application-connector.yml`

1- route: "commercetools.connect.customer.upsert"
2     props:
3       name: "customer"
4       inclusion-filter:
5          - "ResourceUpdated"
6          - "ResourceCreated"

we can also add new handlers as well by just adding them in 

`application-connector.yml`

Create a new Handler that extends 

`MessageHandler`

`com.fluentcommerce.connect`

`com.fluentcommerce.connect.custom.commercetools.handler.message.<your-handler>.java`

1@Slf4j
2@Component
3@HandlerInfo(name = "FluentCustomerUpsert")
4public class FluentCustomerCreateHandler extends MessageHandler {
5    private static final String CUSTOMER_ATTRIBUTE = "customer";
6    // write your logic
7}

Automatic Delta Sync

This is an automated synchronization that runs in the background to keep Fluent up to date. This synchronization is based on subscriptions. Out of the box, we are supporting 

`ResourceCreated`

`ResourceUpdated`

Customer APIs and Payloads

CT CUSTOMER API

• GET : {{host}}/{{project-key}}/customers
• GET : {{host}}/{{project-key}}/customers/{{Customer-id}}

CUSTOMER MESSAGE PAYLOAD

The Message Payload in CT-queue

1{
2  "notificationType": "Message",
3  "projectKey": "fluent-ct-dev",
4  "id": "85c1c53e-75c8-413a-b8f5-08701292486e",
5  "version": 1,
6  "sequenceNumber": 3,
7  "resource": {
8    "typeId": "customer",
9    "id": "14a4ef54-957d-4148-b0be-de8d0fbc411d"
10  },
11  "resourceVersion": 3,
12  "resourceUserProvidedIdentifiers": {},
13  "type": "CustomerDeleted",
14  "createdAt": "2022-07-27T06:11:11.021Z",
15  "lastModifiedAt": "2022-07-27T06:11:11.021Z"
16}