OrderManagementSettings

Represents options for the Salesforce Order Management product.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

OrderManagementSettings values are stored in the OrderManagement.settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

Version 

Order Management settings are available in API version 48 and later.

Special Access Rules 

This metadata type is only accessible by developers and customers using Salesforce Order Management.

Fields 

deliveryEstimationEnabled 

  • Type: boolean
  • Required: No
  • Introduced: API version 62.0
  • Description: Specifies whether delivery estimation is active (true) or not (false). The default value is false.

enableActivityFeedPerChangeOrder 

  • Type: boolean
  • Required: No

enableB2CHighScaleOrders 

  • Type: boolean
  • Required: No

enableB2CIntegration 

  • Type: boolean
  • Required: No
  • Description: Indicates whether Order Management is allowed to accept order data from B2C Commerce (true) or not (false). The default value is false.

enableBillingTypeOrdSummCreation 

  • Type: boolean
  • Required: No

enableDuplicateManagement 

  • Type: boolean
  • Required: No
  • Introduced: API version 53.0
  • Description: Indicates whether the Order Management B2C Commerce Integration applies the Salesforce org’s duplicate and matching rules for Accounts, Contacts, and Person Accounts to shopper records (true) or not (false). The default value is false. The Setup toggle label is B2C Integration Data Matching Rules.

enableHighScaleOrders 

  • Type: boolean
  • Required: No
  • Introduced: API version 56.0
  • Description: Indicates whether the Order Management B2C Commerce Integration uses the High Scale Orders feature (true) or the original order ingestion system (false). The default value is false.

enableIndividualOrderItemTaxAdjustments 

  • Type: boolean
  • Required: No

enableMRURecordCaching 

  • Type: boolean
  • Required: No

enableOMAutomation 

  • Type: boolean
  • Required: No

enableOrderManagement 

  • Type: boolean
  • Required: No
  • Description: Indicates whether Order Management features are enabled (true) or not (false). The default value is false.

enablePersonAccountsForShoppers 

  • Type: boolean
  • Required: No
  • Introduced: API version 49.0
  • Description: Indicates whether Order Management represents each shopper with a Person Account (true) or a normal Account and a Contact (false). The default value is false.

initOMAutomation 

  • Type: boolean
  • Required: No

Declarative Metadata Sample Definition 

The following is an example of an OrderManagementSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<OrderManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata" 
3xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
4    <enableOrderManagement>true</enableOrderManagement>
5    <deliveryEstimationEnabled>false</deliveryEstimationEnabled>
6    <enableB2CIntegration>true</enableB2CIntegration>
7    <enableDuplicateManagement>true</enableB2CIntegration>
8    <enableHighScaleOrders>false</enableB2CSelfService>
9    <enablePersonAccountsForShoppers>true</enablePersonAccountsForShoppers>
10    </OrderManagementSettings>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>OrderManagement</members>
5        <name>Settings</name>
6    </types>
7    <version>49.0</version>
8</Package>

Wildcard Support in the Manifest File 

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.