RetailExecutionSettings

Represents settings to manage your inventory, promotions, planograms, and in-store activities.

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

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

File Suffix and Directory Location

RetailExecutionSettings are stored in a single file named RetailExecution.settings in the settings directory.

Version

RetailExecutionSettings are available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
`enableProductHierarchy`	boolean	Indicates whether Product Hierarchy is enabled for your org (`true`) or not `false`). This field is available in API version 53.0 and later.
`enableRetailExecution`	boolean	Indicates whether Retail Execution is enabled for your org (`true`) or not (`false`). The default value is `false`.
`enableVisitSharing`	boolean	Indicates whether Visit Share is enabled for your org (`true`) or not (`false`). The default value is `false`. This field is available in API version 55.0 and later.

Declarative Metadata Sample Definition

The following is an example of a RetailExecutionSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<RetailExecutionSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableRetailExecution>true</enableRetailExecution>
4    <enableProductHierarchy>true</enableProductHierarchy>
5    <enableVisitSharing>false</enableVisitSharing>
6</RetailExecutionSettings>

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>RetailExecution</members>
5        <name>Settings</name>
6    </types>
7    <version>55.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.