IndustriesUnifiedPromotionsSettings Metadata Type

Represents the configuration settings to set up Global Promotions Management.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

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

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

File Suffix and Directory Location

IndustriesUnifiedPromotionsSettings values are stored in a single file named IndustriesUnifiedPromotions.settings 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

IndustriesUnifiedPromotionsSettings components are available in API version 60.0 and later.

Fields

enableGlblPrmtConstraintModel

Field Type: boolean
Description: Indicates whether the constraint model for Global Promotions Management is enabled (true) or disabled (false) in your org. When enabled, the system uses a constraint model to evaluate promotion eligibility and enforce promotion constraints. Available in API version 66.0 or later.
Default value: false

enableGlobalPromotionsEvaluation

Field Type: boolean
Description: Indicates whether promotions evaluation is enabled (true) or disabled (false) in your org. When enabled, the system evaluates cart details and returns the adjusted price of the cart and line items after applying eligible promotions. Available in API version 65.0 or later.
Default value: false

enableGlobalPromotionsForRevenueCloud

Field Type: boolean
Description: Indicates whether Global Promotions Management is enabled (true) or disabled (false) for Revenue Management in your org. Available in API version 66.0 or later.
Default value: false

enableGlobalPromotionsProductCatalogManagement

Field Type: boolean
Description: Indicates whether Product Catalog Management is enabled (true) or disabled (false) in your org. Available in API version 62.0 or later.
Default value: false

enableUnifiedPromotions

Field Type: boolean
Description: Indicates whether Global Promotions Management is enabled (true) or disabled (false) for your org.
Default value: true

Declarative Metadata Sample Definition

The following is an example of a IndustriesGamificationSettings component.

1<?xml version="1.0" encoding="UTF-8"?><IndustriesUnifiedPromotionsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
2    <enableUnifiedPromotions>true</enableUnifiedPromotions>
3    <enableGlobalPromotionsProductCatalogManagement>true</enableGlobalPromotionsProductCatalogManagement>
4    <enableGlobalPromotionsEvaluation>true</enableGlobalPromotionsEvaluation>
5    <enableGlobalPromotionsForRevenueCloud>true</enableGlobalPromotionsForRevenueCloud>
6    <enableUnifiedPromotions>true</enableUnifiedPromotions>
7</IndustriesUnifiedPromotionsSettings>

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>IndustriesUnifiedPromotions</members>
5    <name>Settings</name>
6  </types>
7  <version>XX.X</version>
8</Package>

Where XX.X is the latest API version.

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.