CommerceSettings | Metadata API Developer Guide

Parent Type and Manifest Access

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

CommerceSettings values are stored in the Commerce.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

Version

Commerce Settings are available in API version 50.0 and later.

Special Access Rules

A B2B Commerce or D2C Commerce license and access to Commerce objects is required.

Fields

Field Name	Description
buyerGroupExtensibility	Field Type boolean Description Indicates whether Buyer Group Extensibility is enabled (`true`) or not (`false`). Available in API version 64.0 and later.
commerceAnalyticsEnabled	Field Type boolean Description Indicates whether Commerce Analytics is enabled (`true`) or not (`false`).
commerceAppEnabled	Field Type boolean Description Indicates whether Commerce App is enabled (`true`) or not (`false`).
commerceConciergeEnabled	Field Type boolean Description Indicates whether Commerce Concierge bots are enabled (`true`) or not (`false`).
commerceCopilotEcomEnabled	Field Type boolean Description Indicates whether Commerce Copilot is enabled (`true`) or not (`false`).
commerceDCSegmentEnabled	Field Type boolean Description Indicates whether the Data 360 segment integration is enabled (`true`) or not (`false`).
commerceDiscoveryExpansion	Field Type boolean Description Indicates whether the Commerce Discovery Expansion service is enabled (`true`) or not (`false`).
commerceEnabled	Field Type boolean Description Indicates whether Commerce is enabled (`true`) or not (`false`).
commerceNGPEnabled	Field Type boolean Description Indicates whether NGP (“Salesforce”) Pricing is enabled (`true`) or not (`false`).
commerceRLMSubs	Field Type boolean Description Indicates whether Commerce Revenue Lifecycle Management Subscriptions is enabled (`true`) or not (`false`).
generateInvPerSubscription	Field Type boolean Description Indicates whether a separate invoice is generated per subscription (`true`) or not (`false`). Available in API version 64.0 and later.
lowestUnitPriceTracking	Field Type boolean Description Indicates whether lowest unit price tracking (for EU customers) is enabled (`true`) or not (`false`).
messagingEngagementDataKit	Field Type boolean Description Indicates whether Message Engagement data kit is enabled (`true`) or not (`false`). Message Engagement data kit is a Data 360 data model object (DMO) for a user’s engagement with a marketing message.

Declarative Metadata Sample Definition

The following is an example of a CommerceSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CommerceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<buyerGroupExtensibility>false</buyerGroupExtensibility>
4	<commerceAnalyticsEnabled>false</commerceAnalyticsEnabled>
5	<commerceAppEnabled>false</commerceAppEnabled>
6	<commerceConciergeEnabled>false</commerceConciergeEnabled>
7	<commerceCopilotEcomEnabled>false</commerceCopilotEcomEnabled>
8	<commerceDCSegmentEnabled>false</commerceDCSegmentEnabled>
9	<commerceDiscoveryExpansion>false</commerceDiscoveryExpansion>
10	<commerceEnabled>false</commerceEnabled>
11	<commerceNGPEnabled>false</commerceNGPEnabled>
12	<commerceRLMSubs>false</commerceRLMSubs>
13	<generateInvPerSubscription>false</generateInvPerSubscription>
14	<lowestUnitPriceTracking>false</lowestUnitPriceTracking>
15	<messagingEngagementDataKit>false</messagingEngagementDataKit>
16</CommerceSettings>

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>Commerce</members>
5        <name>Settings</name>
6    </types>
7    <version>64.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.