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

Fields

Field Name	Description
commerceAnalyticsEnabled	Field Type boolean Description Indicates whether Commerce Analytics is enabled (`true`) or not (`false`).
commerceConciergeEnabled	Field Type boolean Description Indicates whether Commerce Concierge bots are 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`).
lowestUnitPriceTracking	Field Type boolean Description Indicates whether lowest unit price tracking (for EU customers) is enabled (`true`) or not (`false`).

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    <commerceEnabled>false</commerceEnabled>
4</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>60.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.