OrderManagementSettings in SFDX

Architectural Overview#

The OrderManagementSettings metadata type controls the core activation switches for Salesforce Order Management (SOM). In omnichannel architectures linking B2B Commerce, B2C Commerce, or third-party storefronts to Salesforce, SOM serves as the central hub for order capture, inventory reservation, fulfillment routing, and payment settlement.

Deploying OrderManagementSettings activates the immutable order ledger schema—including OrderSummary, OrderItemSummary, FulfillmentOrder, PaymentAuthorization, and ReturnOrder. Without this metadata type configured in your source control repository, automated CI/CD builds deploying SOM flows, CustomObject extensions, or ApexClass triggers fail immediately due to missing schema objects.

Directory and File Conventions#

In SFDX source format, OrderManagementSettings is represented as an XML file under the settings/ directory and referenced using the Settings type with member OrderManagement.

Key Metadata Fields#

The OrderManagementSettings metadata type exposes several configuration flags that determine how orders are ingested and orchestrated:

Declarative XML and Package Manifest Examples#

Below is an enterprise configuration for an omnichannel order processing deployment:

<?xml version="1.0" encoding="UTF-8"?>
<OrderManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableB2CIntegration>true</enableB2CIntegration>
    <enableHighScaleOrders>true</enableHighScaleOrders>
    <enableOrderManagement>true</enableOrderManagement>
    <enableOrderSummaries>true</enableOrderSummaries>
</OrderManagementSettings>

Scratch Org Definition Configuration#

When creating scratch orgs for order management development, include the feature license and settings configuration:

{
  "orgName": "Omnichannel SOM Dev Org",
  "edition": "Enterprise",
  "features": ["OrderManagement", "B2BCommerce"],
  "settings": {
    "orderManagementSettings": {
      "enableOrderManagement": true,
      "enableB2CIntegration": true,
      "enableHighScaleOrders": true,
      "enableOrderSummaries": true
    }
  }
}

Package Manifest (package.xml)#

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>OrderManagement</members>
        <name>Settings</name>
    </types>
    <version>68.0</version>
</Package>

CLI Retrieval and Deployment Commands#

Manage OrderManagementSettings using the Salesforce CLI (sf):

# Retrieve OrderManagementSettings from the org
sf project retrieve start --metadata Settings:OrderManagement

# Deploy OrderManagementSettings to a target environment
sf project deploy start --metadata Settings:OrderManagement

# Deploy with dry-run validation
sf project deploy validate --metadata Settings:OrderManagement --test-level RunLocalTests

Architect Best Practices and Gotchas#

• Dependency Pipeline Sequencing: Always deploy OrderManagement.settings-meta.xml in an initial foundational deployment step before deploying Flow definitions, ApexClass fulfillment triggers, or custom fields on OrderSummary.
• Irreversibility in Production: Once Order Management is active and business transactions generate OrderSummary records, toggling enableOrderManagement off is permanently restricted. Test all settings in full sandboxes before applying to production.
• High-Scale Order Ingestion Timing: When enableHighScaleOrders is active, order insertion does not invoke synchronous Apex triggers on Order. Ensure routing logic executes against OrderSummaryCreatedEvent or asynchronous platform events.

Frequently asked questions

What primary capabilities are enabled by OrderManagementSettings?

It activates Salesforce Order Management, provisioning OrderSummary, FulfillmentOrder, and payment processing objects required for post-order orchestration.

Why do deployments of OrderSummary custom fields fail in scratch orgs?

OrderSummary and related fulfillment entities do not exist until enableOrderManagement is set to true in OrderManagementSettings and the org feature is active.

How do you retrieve OrderManagementSettings via the Salesforce CLI?

Execute sf project retrieve start with metadata Settings:OrderManagement to extract OrderManagement.settings-meta.xml into the local settings directory.

Can OrderManagementSettings be disabled after being activated in production?

No. Once Order Management is activated and OrderSummary records are generated, disabling the setting is restricted to prevent relational data corruption.