Fluent Commerce Logo
Docs
Help & Feedback

Sourcing Utilities

Package

Changed on:

3 Aug 2026

Publisher:Fluent Commerce
Website:Fluent Commerce

Download Package

Download

Version History

2026-08-13
v2.2.0
Key Changes:
  • Rejected location exclusion criterion type identifier renamed from  `fc.sourcing.criterion.locationExclusion` to `fc.sourcing.criterion.rejectedLocationExclusion`
  • `getCriteria(SourcingStrategy)` added as the new signature for retrieving criteria for a strategy. `getCriteria(strategy, defaultCriteria)` and `getDefaultCriteria()` are deprecated
  • Chunk loading architecture: location evaluation now uses a `ProfileStrategyPlanFinder` → `ChunkLoadingPlanFinder` → `AllItemsPlanFinder` chain
    `ChunkLoadingPlanFinder` loads locations in incremental chunks sized proportionally to the order's item count, running a single-location search after each chunk. A multi-split search is run across the full evaluated set if no single-location plan is found
  • Early availability check: before entering permutation search, the combined available quantity for each required item is summed across all candidate locations. If any item cannot be covered, the permutation search is skipped and sourcing proceeds directly to the next strategy
  • Fallback sourcing: location ratings are now recalculated after each allocation iteration using remaining unfulfilled items, ensuring each location selection reflects actual demand at that point in the iteration
  • ETA Calculator: injectable `EtaCalculator` function executed for each fulfillment plan and its fulfillments, with access to selected locations and event context. Additional GraphQL queries are supported within the calculator
  • `availableQty` field added to `FulfilmentItem` and `CreateFulfilmentPlanFulfilmentItemInput`, saved on the fulfillment plan at sourcing time
  • Multi-attempt sourcing: `getPlanFinder` is the preferred entry point - it returns a `SourcingPlanFinder` exposing `nextFullPlan()` (primary) and `nextFallbackPlan()` (fallback), loading sourcing data at most once per variant so alternative plans can be generated without reloading. The lower-level factory methods `getBasedOnStrategiesPlanFinder` and `getBasedOnFallbackStrategiesPlanFinder` are available for decorator/wrapping scenarios
  • `findPartialFulfilmentPlan`: extracted as a public static method
  • Deterministic fulfillment reference format: fulfillments are now created with a sequential one-based index reference `{orderId}-{fulfilmentChoiceId}-{index}`. The index starts at the number of existing fulfillments for the order plus one. This ensures that concurrent sourcing processes operating from the same starting state generate identical references, enabling deduplication via `fc.api.fulfilment.uniqueness`
Java Source Code
2025-12-11
v2.1.0
Key Changes:
  • Fixed custom sourcing condition registration: `SourcingConditionTypeRegistry` is now public, so custom `SourcingCondition` implementations can be placed in external package and registered without compilation errors
Java Source Code
2025-10-03
v2.0.1
Key Changes:
  • Added a `status: "ACTIVE"` filter to the `GetProfileByRef` query used by the `SourcingUtils.loadSourcingProfile` method to ensure the correct Sourcing Profile version is returned
  • Added the `OrderUtils.getSuffixAsPerLocationType` method, along with the units (`DistanceMeasurementUnits`) and model (`Attribute`, `LocationType`, `Constants`) service classes, to remove unnecessary dependencies on other utilities, making the Sourcing Utilities self-contained
Java Source Code
2025-09-29
v2.0.0
Initial release.Java Source Code

Overview

The `util-sourcing` library is a comprehensive collection of utility functions designed to minimize the overhead and complexity of writing sourcing logic in your Fluent Commerce rules.

Detailed Technical Description

Usage

1<dependency>
2    <groupId>com.fluentcommerce</groupId>
3    <artifactId>util-sourcing</artifactId>
4    <version>${util-sourcing.version}</version>
5</dependency>

Language: xml

Name: Adding Sourcing Utilities as a Maven Dependency

Description:

Replace `${util-sourcing.version}` with the Maven dependency version you want to use, for example for v2.0.0 use 2.0.0.

Features

Manage Sourcing Profiles
The Manage Sourcing Profiles feature allows businesses to create, update, activate, retrieve, and search centralized sourcing configurations. This capability establishes foundational baseline rules—including default networks, virtual catalogs, and maximum shipment split allocations—and enables teams to reference these profiles directly within automated order fulfillment workflows.
  • Create, update, activate, get, and search Sourcing Profiles
  • Configure Default Network, Virtual Catalog, and Max Split values for Sourcing Strategies
  • Reference Sourcing Profiles directly within Workflows
Configure Sourcing Strategies
Configure Sourcing Strategies allows businesses to create rule-based fulfillment logic that optimizes how orders route to locations. By defining specific conditions and ranking criteria, the platform dynamically selects the best fulfillment centers or stores for each order, minimizes order splits, and overrides default profiles to adapt to regional, international, or customer-tier requirements.
Sourcing Conditions and Criteria Library
  • Expandable library with predefined functions
  • Built-in configuration parameters:
    • Path
    • Operators (e.g., equals, greaterThan)
    • Condition Scope (e.g., ALL, ANY)
    • Bands
    • Thresholds
  • Support for custom Sourcing Conditions and Criteria via partner extensions
Sourcing Logic Evaluation and Execution
The Sourcing Logic Evaluation feature automates real-time processing of routing rules to determine optimal fulfillment nodes for inbound orders. The engine systematically reviews active strategies, filters out inapplicable options, and applies criteria as tie-breakers to rank locations.
  • Evaluates Sourcing Strategies based on defined Priority.
  • Skips inactive or inapplicable Sourcing Strategies.
  • Applies Sourcing Criteria in sequence, with each serving as a tie-breaker to rank eligible fulfillment Location options.
Partial Fulfillments and Re-Sourcing
The Partial Fulfillments and Re-Sourcing feature provides automated order splitting capabilities and fallback sourcing logic. When a preferred location cannot satisfy an entire order, the platform optimizes real-time re-sourcing decisions using configurable sourcing criteria to route remaining items to alternative locations seamlessly.
Framework Usability and Extensibility
The Framework Usability and Extensibility feature provides an accessible, transparent, and scalable environment to manage and execute your order routing rules. This framework features a dedicated user experience (UX) tailored for both technical and business users, offers clear visibility into the platform's decision-making process, and supports custom logic developed by integration partners to meet unique business demands.
  • Dedicated UX for both technical and business users
  • Transparent configuration and visibility into decision-making
  • Support for partner-developed custom logic and extensions
Capability type:Tool

Related content

Utility Bundles Overview
Edited 373 days ago
The Fluent Commerce Utility Bundles are a set of libraries designed to accelerate Rule development, reduce boilerplate code, and improve the overall quality and maintainability of implementations. They are the cornerstone of writing maintainable, reusable, and easily upgradeable Rules for the Fluent Commerce platform.
How Sourcing Utilities work
Edited 47 days ago
The articles below will walk you through the Sourcing Utilities (`util-sourcing`), designed to simplify implementing complex sourcing logic and reduce repetitive code.PrerequisitesBefore diving in, make sure you have:
How Sourcing Conditions work
Edited 332 days ago
This article introduces Sourcing Conditions as the mechanism that evaluates Sourcing Requests and returns outcomes used in Strategy selection. Readers will learn how reference schema, operators, and parameters shape these evaluations, and how custom schema can extend them.
How Sourcing Criteria work
Edited 332 days ago
This article introduces Sourcing Criteria as the ranking (and exclusion) functions that score candidate Locations during Strategy evaluation. You’ll learn how Criteria order affects final rankings, which reference Criteria are available, and how to extend the library with custom implementations.
Building Blocks
Building Blocks
Packages & Modules
All UI Components
Workflows
Settings
Interface Contracts
All Rules
By Type
All Types
Knowledge Tracks
Extend Knowledge
Glossary
All How-to Guides
Sitemap
Topics
Use Cases
Helpful Resources
Platform Limits
Support Policy
Service Level Agreement (SLA) - Enterprise
Deprecation Policy
Extend Knowledge Content – Terms and Conditions
System and Organization Controls (SOC) 3 Report
Data Privacy Addendum
Security Policy
Quick Links
For Partners
Customer Resources
Webinars and Events
Certifications
Training Resources
Knowledge Tracks
Builders Portal
Product Update Newsletter
Industry Blogs & Events Newsletter
Trust Center Portal

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

Fluent Logo