commercetools connector - Fluent Settings

Docs

Help & Feedback

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

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

Note

All the settings will be configured with respect to each retailer id associated to an account.

Disclaimer

All the values defined on the below settings are only the sample data and it should be adapted specific to the retailer settings and master data of your Fluent and commercetools setup.

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

Account Mapping

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

General Mapping

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

Product Catalog Sync

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

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}

Location Sync

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

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}

Shipping Method

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

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}

Payment Status

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

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}

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}

Related content

Settings Creation and Editing Mutations

Edited 651 days ago

Setting Editing Mutation

Edited 861 days ago

1fluent-connect:
2  connector-name: commercetools

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

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

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

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

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

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}

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

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}

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

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}

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}

commercetools connector - Fluent Settings

Overview

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

Related content

Settings Creation and Editing Mutations

Setting Editing Mutation

Fluent Commerce

Building Blocks

By Type

Helpful Resources

Quick Links