Fluent Order Management

https://docs.fluentcommerce.com/
Admin
Fluent Order Management provides a comprehensive Order Management System (OMS) to optimize...
Tokens:1,625,812
Snippets:22,510
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example Project Generation Prompts

Source: https://docs.fluentcommerce.com/by-type/create-a-new-rules-sdk-plugin-project

Example values for populating the project generation prompts during SDK installation.

```text
groupId: com.acme
artifactId: rubix-plugin-acme-base
fluentAccountId: _
fluentApiHost: https://ACME.sandbox.api.fluentretail.com
fluentApiPort: 443
fluentApiClientSecret: acmesecret
fluentApiPassword: acmepassword
fluentApiUserName: acmeusername
fluentPluginName: base
fluentVendorName: ACME (Pty) Ltd.
```

--------------------------------

### Install B2C Sample Data Module

Source: https://docs.fluentcommerce.com/by-type/bootstrap-an-account-using-the-fluent-cli

Install the B2C sample data module using its configuration file. This command applies the product catalog setup.

```bash
fluent module install https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data/latest --config module.config.sample.b2c-sample-data.json --retailer sample --profile cli-sample
```

--------------------------------

### Install B2C Sample Inventory Module

Source: https://docs.fluentcommerce.com/by-type/bootstrap-an-account-using-the-fluent-cli

Install the B2C sample inventory module after a cache clearing period. This command applies the inventory setup.

```bash
fluent module install https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data-inventory/latest --config module.config.sample.b2c-sample-data-inventory.json --retailer sample --profile cli-sample
```

--------------------------------

### Upgrade Adobe Commerce Setup

Source: https://docs.fluentcommerce.com/by-type/adobe-commerce-connector-package-installation

Execute this command to allow Adobe Commerce to recognize the newly installed extensions.

```bash
1/bin/magento setup:upgrade
```

--------------------------------

### DynamicUpdateMutation Example

Source: https://docs.fluentcommerce.com/explore-categories/article_list

Demonstrates how DynamicUpdateMutation automatically derives and performs updates on entity fields based on RulesetContext.

```javascript
const mutation = new DynamicUpdateMutation(RulesetContext);
mutation.update({
  "primaryEntity.field1": "value1",
  "primaryEntity.field2": "value2"
});
```

--------------------------------

### Event Retrieval

Source: https://docs.fluentcommerce.com/explore-categories/article_list

Retrieve specific events or a filtered list of events using GET methods. Handles 404 errors if events are not found.

```APIDOC
## GET /event

### Description
Retrieves a list of events based on specified parameters.

### Method
GET

### Endpoint
/event

### Parameters
#### Query Parameters
- **eventType** (string) - Optional - Filters events by type.
- **limit** (integer) - Optional - Limits the number of returned events.
- **offset** (integer) - Optional - Skips a specified number of events.

### Response
#### Success Response (200)
- **events** (array) - A list of event objects.

#### Response Example
{
  "events": [
    {
      "id": "event-id-123",
      "type": "API",
      "timestamp": "2023-10-27T10:00:00Z",
      "payload": {}
    }
  ]
}

## GET /event/{id}

### Description
Retrieves a specific event by its ID.

### Method
GET

### Endpoint
/event/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the event.

### Response
#### Success Response (200)
- **event** (object) - The event object.

#### Response Example
{
  "id": "event-id-123",
  "type": "API",
  "timestamp": "2023-10-27T10:00:00Z",
  "payload": {}
}

#### Error Response (404)
- **message** (string) - Indicates that the event was not found.
```

--------------------------------

### Claude Code Setup Prompt

Source: https://docs.fluentcommerce.com/by-type/setting-up-fluent-sandbox-with-claude-code

This prompt guides Claude Code through setting up a Fluent OMS sandbox, including prerequisites, CLI installation, authentication, module installation, data loading, and user configuration. It emphasizes security and step-by-step execution with approval.

```plain_text
1CONTEXT:
2Set up Fluent Order Management from scratch in a sandbox environment.
3
4PROJECT DETAILS:
5- Location: [CURRENT DIRECTORY]
6- Environment: Sandbox
7- Credentials: Stored in .env file (never display these)
8- Documentation: [PATH TO YOUR DOCS FOLDER]
9
10CURRENT STATE:
11- Git initialised with .env protected
12- .env file contains: ACCOUNT_ID, CLIENT_ID, PASSWORD, CLIENT_SECRET, FLUENT_USERNAME
13- CLI not yet installed
14- Node may or may not be installed
15
16END GOAL:
17Working Fluent OMS sandbox with:
181. Core module
192. Fulfilment module
203. Order module
214. Inventory module
225. Sample B2C data loaded
236. All users with correct context access
24
25SECURITY REQUIREMENTS:
26- Never display .env file contents
27- Reference environment variables as ${VARIABLE_NAME} (never print values)
28- Explain each command before execution
29- Flag destructive operations
30- Wait for approval before proceeding
31
32SETUP SEQUENCE:
33Execute these phases in order, waiting for approval at each phase:
34
35PHASE 1: Prerequisites Check
36- Verify Node.js >= 20.0.0 < 23.0.0
37- Verify npm >= 10.5.0
38- Install/upgrade if needed
39
40PHASE 2: CLI Installation
41- Install Fluent CLI globally
42- Verify with `fluent --version`
43
44PHASE 3: Authentication
45- Create CLI profile using .env credentials
46- Profile name: cli-b2c
47- Use FLUENT_USERNAME variable (not USERNAME, to avoid system conflict)
48- Username should be lowercase
49- Verify authentication succeeds
50
51PHASE 4: Create Retailer
52- Create retailer named "b2c"
53- Email: b2c@test.com
54- Note the Retailer ID (should be 1)
55
56PHASE 5: Generate Configs
57- Generate Order module config
58- Generate Inventory module config
59- Populate with documentation defaults
60
61PHASE 6: Install Modules (Order Matters)
621. Core module
632. Fulfilment module
643. Order module (with config)
654. Inventory module (with config)
66
67PHASE 7: Load Sample Data
681. Generate and install B2C Sample Data module
692. WAIT 10 MINUTES (required for catalogue cache)
703. Generate and install B2C Sample Inventory module
71
72PHASE 8: Configure User Access
73- Ensure account admin has retailer context roles
74- Add ADMIN and GRAPHQL roles to retailer context
75- This fixes blank screen issue on login
76
77PHASE 9: Verification
78- List installed modules
79- Confirm all 4 modules active
80- Provide login credentials for all created users
81- Provide all application URLs
82
83KNOWN ISSUES TO AVOID:
841. Username case: Use lowercase (e.g., "jarrydz_admin" not "JARRYDZ_admin")
852. USERNAME conflict: Use FLUENT_USERNAME in .env (macOS has system USERNAME variable)
863. Blank screen: Account admin needs retailer context roles added after setup
874. Catalogue cache: Must wait 10 minutes between sample data and inventory install
88
89TEACHING MODE:
90- Explain what each command does before running
91- Define technical terms when first used
92- Show the "why" behind each step
93- Ask if deeper explanation wanted
94
95Begin with Phase 1. Present findings and wait for approval before executing.
```

--------------------------------

### Install All Workflows

Source: https://docs.fluentcommerce.com/by-type/install-starter-pack-into-your-sandbox

Execute all workflows defined in the starter pack. Ensure 'retailer' matches the value in sample_variables.json.

```bash
./workflow-all.sh properties/sample_variables.json retailer
```

--------------------------------

### MyRuleTest Example

Source: https://docs.fluentcommerce.com/essential-knowledge/rule-executor

A complete example demonstrating the setup and execution of a rule using RuleExecutor.

```APIDOC
## Complete Example

### Description
This example demonstrates how to set up a ``RuleExecutor`` with properties, mock named queries, create a custom event, execute the rule, and then assert the results.

### Code Example
```java
import com.fluentcommerce.util.test.executor.RuleExecutor;
import com.fluentcommerce.util.test.executor.RuleContextGenerator;
import com.fluentretail.rubix.event.Event;
import org.junit.jupiter.api.Test;

import static com.fluentcommerce.util.test.executor.TestActions.SendEventAction;
import static org.junit.jupiter.api.Assertions.*;

public class MyRuleTest {

    @Test
    void testMyRule() {
        // ARRANGE: Set up the rule executor with properties
        RuleExecutor executor = RuleExecutor.of(MyRule.class, ImmutableMap.of(
            "eventName", "success-event",
            "threshold", "100"
        ))
        .mockNamedQuery(
            GetOrderQuery.class, 
            "graphql/getOrderResult.json"
        );

        // Create custom event
        Event customEvent = Event.builder()
            .name("OrderCreated")
            .entityRef("order-123")
            .entityType("ORDER")
            .attributes(ImmutableMap.of(
                "orderValue", "150.00",
                "customerType", "PREMIUM"
            ))
            .build();

        // ACT: Execute the rule with custom event
        RuleContextGenerator context = executor.execute(customEvent);

        // ASSERT: Verify the results
        assertEquals(1, context.getActionsOfType(SendEventAction.class).size());
        assertEquals("success-event", context.getLastActionOfType(SendEventAction.class).getEvent().getName());
        
        // Verify no other actions were performed
        assertEquals(0, context.getActionsOfType(MutateAction.class).size());
        assertEquals(0, context.getActionsOfType(WebhookAction.class).size());
    }
}
```
```

--------------------------------

### Install Sample B2C Data Module with Configuration

Source: https://docs.fluentcommerce.com/by-type/set-up-a-new-account-with-reference-modules-and-b2c-sample-data

Installs the sample B2C data module using a local configuration file for the 'b2c' retailer.

```bash
fluent module install https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data/latest --config module.config.b2c.b2c-sample-data.json --retailer b2c --profile cli-b2c
```

--------------------------------

### Get Job Status Example

Source: https://docs.fluentcommerce.com/by-type/Send-Inventory-Batches

Example of how to retrieve the status of a job. This is useful for monitoring batch processing.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;

public class JobClient
{
    private readonly HttpClient _httpClient;
    private readonly string _baseUrl;

    public JobClient(HttpClient httpClient, string baseUrl)
    {
        _httpClient = httpClient;
        _baseUrl = baseUrl;
    }

    public async Task<string> GetJobStatusAsync(string jobId)
    {
        var requestUrl = $"{_baseUrl}/jobs/{jobId}";
        var response = await _httpClient.GetAsync(requestUrl);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        var status = JsonConvert.DeserializeObject<dynamic>(responseBody).status;
        return status;
    }
}
```

--------------------------------

### Get Inventory Batch Status Example

Source: https://docs.fluentcommerce.com/by-type/Send-Inventory-Batches

Example of how to retrieve the status of a specific inventory batch within a job.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;

public class InventoryClient
{
    private readonly HttpClient _httpClient;
    private readonly string _baseUrl;

    public InventoryClient(HttpClient httpClient, string baseUrl)
    {
        _httpClient = httpClient;
        _baseUrl = baseUrl;
    }

    public async Task<string> GetInventoryBatchStatusAsync(string jobId, string batchId)
    {
        var requestUrl = $"{_baseUrl}/jobs/{jobId}/inventory-batches/{batchId}";
        var response = await _httpClient.GetAsync(requestUrl);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        var status = JsonConvert.DeserializeObject<dynamic>(responseBody).status;
        return status;
    }
}
```

--------------------------------

### Install a module

Source: https://docs.fluentcommerce.com/by-type?selectedType=how_to_guide

Install the built module using the provided zip file, specifying the profile and retailer.

```bash
fluent module install dist/<module-name>-<version>.zip -p <profile> -r <retailer>
```

--------------------------------

### Install Reference Modules

Source: https://docs.fluentcommerce.com/by-type/bootstrap-an-account-using-the-fluent-cli

Install the core, fulfilment, order, and inventory reference modules using the CLI. The order and inventory modules utilize the previously generated configuration files.

```bash
fluent module install core --retailer sample --profile cli-sample
```

```bash
fluent module install fulfilment --retailer sample --profile cli-sample
```

```bash
fluent module install order --config module.config.sample.order.json --retailer sample --profile cli-sample
```

```bash
fluent module install inventory --config module.config.sample.inventory.json --retailer sample --profile cli-sample
```

--------------------------------

### Get Job Status Endpoint Example

Source: https://docs.fluentcommerce.com/by-type/Send-Inventory-Batches

This is an example of how to call the Job API to retrieve the status of an existing job using its ID.

```markdown
GET/{{fluent.account.host}}/api/v4.1/job/{jobID}
```

--------------------------------

### Configuration Example

Source: https://docs.fluentcommerce.com/building-blocks/retailer-address-validation-condition

Provides an example of how to configure the RETAILER_ADDRESS_VALIDATION_CONDITION setting. This is a placeholder and requires specific values to be provided.

```text
1to be provided
```

--------------------------------

### Get Job Status Example

Source: https://docs.fluentcommerce.com/by-type/how-to-submit-inventory-batches

Example of how to retrieve the status of a specific job using its ID. This helps in monitoring the progress of batch processing.

```csharp
var jobStatus = await client.Job.GetStatusAsync(response.Id);

Console.WriteLine($"Job Status: {jobStatus}");
```

--------------------------------

### Install Sample B2C Data Inventory Module with Configuration

Source: https://docs.fluentcommerce.com/by-type/set-up-a-new-account-with-reference-modules-and-b2c-sample-data

Installs the sample B2C data inventory module using a local configuration file for the 'b2c' retailer. Ensure a 10-minute cache wait time after creating an Inventory Catalogue.

```bash
fluent module install https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data-inventory/latest --config module.config.b2c.b2c-sample-data-inventory.json --retailer b2c --profile cli-b2c
```

--------------------------------

### Internal Message Naming Example

Source: https://docs.fluentcommerce.com/essential-knowledge/extend-the-connector-contract

Provides an example of an internal message name, following the domain:internal:step-name structure. Step names should start with the verb/action.

```text
domain:internal:step-name
```

--------------------------------

### Account Mapping Example

Source: https://docs.fluentcommerce.com/by-type/commercetools-connector-extend-configuration

Illustrates how to map a Fluent account and retailer to an external system's project key and UID.

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

--------------------------------

### Compile and Deploy Static Content

Source: https://docs.fluentcommerce.com/by-type/adobe-commerce-connector-package-installation

Run these commands after installation to compile dependency injection, deploy static content, and clear caches.

```bash
1rm -rf ./generated/*
2
3php bin/magento setup:di:compile
4
5php bin/magento setup:static-content:deploy -f
6
7php bin/magento cache:clean
8
9php bin/magento cache:flush
```

--------------------------------

### Get Inventory Batch Status Example

Source: https://docs.fluentcommerce.com/by-type/how-to-submit-inventory-batches

Example of how to retrieve the status of a specific inventory batch using its ID. This allows for detailed tracking of individual batch processing.

```csharp
var batchStatus = await client.InventoryBatch.GetStatusAsync(batchResponse.Id);

Console.WriteLine($"Inventory Batch Status: {batchStatus}");
```

--------------------------------

### General Settings Example

Source: https://docs.fluentcommerce.com/by-type/commercetools-connector-extend-configuration

Provides an example of general settings for the commercetools connector, specifically for product catalog configuration.

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

--------------------------------

### Get Inventory Batch Status Endpoint Example

Source: https://docs.fluentcommerce.com/by-type/Send-Inventory-Batches

This is an example of how to call the API to retrieve the status of a specific inventory batch, requiring both the Job ID and Batch ID.

```markdown
GET/{fluent.account.host}/api/v4.1/job/{jobID}/batch/{batchID}
```

--------------------------------

### Example Scenario: Version and Namespace Changes

Source: https://docs.fluentcommerce.com/by-type/deploy-and-run-your-rules-sdk-project

Illustrates how version increments and namespace changes affect plugin activation and coexistence.

```text
Initial deployment: ACME.ordermanagement::1.0.0
Bug fix - increment version: ACME.ordermanagement::1.0.1
(version 1.0.0 deactivates automatically)
New feature - add to existing: ACME.ordermanagement::1.1.0
(version 1.0.1 deactivates automatically)
New capability - change namespace: ACME.inventory_sync::0.0.1
(ordermanagement 1.1.0 remains active)
```

--------------------------------

### Product Example Response

Source: https://docs.fluentcommerce.com/essential-knowledge/product-api

An example of a successful response after updating a product.

```json
1{
2 "id":"427323"
3}
4
5

```

--------------------------------

### Create fc.mystique.filters.string Setting

Source: https://docs.fluentcommerce.com/building-blocks/fc-mystique-filters-string

Example of how to create the fc.mystique.filters.string setting using a GraphQL mutation. This sets the filter to partial match (starts with).

```graphqlschema
POST: {{fluentApiHost}}/graphql


GraphQL Query:
mutation CreateSetting {
createSetting(input: {
		name: "fc.mystique.filters.string", 
		valueType: "JSON", 
        lobValue: "{  \"prefix\": false,  \"postfix\": true}", 
		context: "ACCOUNT", 
		contextId:0}) {
    id
    name
  }
}
```

--------------------------------

### Example Listener Configuration

Source: https://docs.fluentcommerce.com/essential-knowledge/fluent-connector-configuration

Configure a single listener with specific settings for queue interaction, thread management, and message visibility.

```yaml
listeners:
    # listener configuration block 
    listener-id:
      name: "ENV_VARIABLE"
      fluent-account: FLUENT_ACCOUNT
      type: "sqs"
      core-pool-size: 5       
      pool-size: 20
      prefix: "my-prefix"
      shutdown-timeout: 300
      visibility-timeout: 120
      poll-wait: 20
      dlq-suffix: "-dlq"
      retry: 5 
```
Tokens:
Raw