Fluent Commerce Logo
Docs
Sign In

commercetools connector - Fluent Settings

Essential knowledge

Author:

Fluent Commerce

Changed on:

31 Jan 2024

Overview

The connector requires the settings below to process data being transmitted from Fluent to commercetools and vice versa. It contains a mix of settings and data mapping tables.

Key points

  • Account Mapping
  • General Mapping
  • Product Catalog Sync
  • Inventory Sync
  • Location Sync
  • Order Status
  • Shipping Method
  • Shipping Status
  • Payment Status
  • Fulfilment Status
  • Unit Conversion

All configurations below are expected to follow a naming convention that uses the application name as part of the path. The pattern is 

`fc.connect.<connectorName>`
 where connectorName is taken from a configuration file as shown below.

1fluent-connect:
2  connector-name: commercetools

Language: yaml

Name: application-connector.yaml

Description:

Connector name

Account Mapping

1{
2    "fluent": {
3        "accountId": "FCTDEV",
4        "retailerId": "100"
5    },
6    "externalAccount": {
7        "projectKey": "my-project-qa"
8    }
9}

Language: json

Name: Fluent setting key: fc.connect.commercetools.account-mapping

Description:

This setting maps the commercetools project key to that of Fluent account and retailer. 

General Mapping

1{
2    "productCatalogue": {
3        "entityRef": "PC:MASTER:67",
4        "entitySubType": "MASTER"
5    }
6}

Language: json

Name: Fluent setting key: fc.connect.commercetools.general

Description:

Store values under this settings used across different handlers. 

Product Catalog Sync

1{
2    "previousEndDate": "2022-10-10T01:10:56.00Z",
3    "props": {}
4}

Language: json

Name: Fluent setting key: fc.connect.commercetools.batch.batch-product-catalogue-sync

Description:

No specific props for this setting. The product catalog to sync is picked from fc.connect.commercetools.general

The date 

`previousEndDate`
 is optional when setting up the job for the first time. It defines the start date the job will use the next time it is executed. Please note that the date time must be in UTC.

Inventory Sync

1{
2    "previousEndDate": "2022-10-10T01:09:56.00Z",
3    "props": {
4        "ctChannelKey": "ct-fluent-channel",
5        "fluentAggregateVirtualCatalogueRef": "ATS:1"
6    }
7}

Language: json

Name: Fluent setting key: fc.connect.commercetools.batch.batch-inventory-sync

Description:

Map the specific aggregate virtual catalog from Fluent whose aggregate inventory data  would be synced to specific channel on commercetools 

The date 

`previousEndDate`
 is optional when setting up the job for the first time. It defines the start date the job will use the next time it is executed. Please note that the date time must be in UTC.

Location Sync

1{
2    "previousEndDate": "2022-10-07T03:36:56.00Z",
3    "props": {
4        "fluentNetworkRef": "BASE_67"
5    }
6}

Language: json

Name: Fluent setting key: fc.connect.commercetools.batch.batch-location-sync

Description:

Map the specific network from Fluent whose locations would be synced to channels on commercetools 

The date 

`previousEndDate`
 is optional when setting up the job for the first time. It defines the start date the job will use the next time it is executed. Please note that the date time must be in UTC.

Order Status

1{
2  "fluent": {
3    "RECEIVED": "Open",
4    "PENDING_PAYMENT": "Open",
5    "ESCALATED": "Open",
6    "BOOKED": "Confirmed",
7    "PICK_PACK": "Confirmed",
8    "PICK_PACK_CC": "Confirmed",
9    "AWAITING_COURIER_COLLECTION": "Confirmed",
10    "AWAITING_CUSTOMER_COLLECTION": "Confirmed",
11    "COMPLETE": "Complete",
12    "CANCELLED": "Cancelled"
13  }
14}

Language: json

Name: Fluent setting key: fc.connect.commercetools.order.status-mapping

Description:

Use the format of the settings to modify specific to your Fluent implementation and the required statuses  of order to that of the commercetools order entity status 

Shipping Method

1{
2    "fluent": {
3        "COD": "HD",
4        "express-EU": "HD",
5        "standard-au": "HD",
6        "standard-cc": "CC"
7    }
8}

Language: json

Name: Fluent setting key: fc.connect.commercetools.order.shipping-method-mapping

Description:

Use the format of the settings to modify specific shipping methods in commercetools to that of order type in Fluent 

Shipping Status

1{
2    "fluent": {
3        "RECEIVED": "Pending",
4        "BOOKED": "Pending",
5        "PICK_PACK": "Pending",
6        "PARTIAL_PICK_PACK": "Partial",
7        "AWAITING_COURIER_COLLECTION": "Shipped",
8        "COMPLETE": "Shipped",
9        "CANCELLED": "Cancelled"
10    }
11}

Language: json

Name: Fluent setting key: fc.connect.commercetools.order.shipping-status-mapping

Description:

Use the format of the settings to modify specific to your Fluent implementation and the required statuses  of order to that of the commercetools shipping entity status 

Payment Status

1{
2    "fluent": {
3        "BOOKED": "Paid",
4        "RECEIVED": "Pending",
5        "PENDING_PAYMENT": "Pending"
6    }
7}

Language: json

Name: Fluent setting key: fc.connect.commercetools.order.payment-status-mapping

Description:

Use the format of the settings to modify specific to your Fluent implementation and the required statuses  of order to that of the commercetools payment entity status 

Fulfilment Status

1{
2    "fluent": {
3        "PROCESSING": "Initial",
4        "AWAITING_WAVE": "Initial",
5        "ASSIGNED": "picking",
6        "PARTIALLY_FULFILLED": "picking",
7        "FULFILLED": "picking",
8        "AWAITING_COURIER_COLLECTION": "readyToShip",
9        "AWAITING_CUSTOMER_COLLECTION": "readyToShip",
10        "COMPLETE": "shipped",
11        "ESCALATED": "Initial",
12        "REJECTED": "backorder",
13        "CANCELLED": "Cancelled"
14    }
15}

Language: json

Name: Fluent setting key: fc.connect.commercetools.fulfilment.status-mapping

Description:

Use the format of the settings to modify specific to your Fluent implementation and the required statuses  of fulfilment to that of the commercetools order item entity status 

Unit Conversion

1{
2    "conversionSettings": [
3        {
4            "fromUnit": "cm",
5            "toUnit": "mm",
6            "conversionFactor": 10
7        },
8        {
9            "fromUnit": "kg",
10            "toUnit": "gm",
11            "conversionFactor": 1000
12        }
13    ]
14}

Language: json

Name: Fluent setting key: fc.connect.commercetools.unit-conversion

Description:

Unit conversion setting 

Fluent Commerce

Fluent Commerce

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.

Fluent Logo