Consumer Goods Cloud Developer Guide

Consumer Goods Standard Objects
Sync Management Custom Objects
Retail Execution Custom Objects
Trade Promotion Management Custom Objects
Custom Objects for Retail Execution and Trade Promotion Management
Custom Objects for Future Use
Consumer Goods Cloud Associated Objects
Consumer Goods Metadata APIs
RetailExecutionSettings
IndustriesSettings
Consumer Goods Business APIs
Einstein Object Detection Standard Objects
Einstein Object Detection REST APIs
Einstein Visit Recommendation Standard Objects
Einstein Visit Recommendation Recommendation Associated Objects
Einstein Visit Recommendation Recommendation Actions
Einstein Visit Activity Recommendation Standard Objects
Einstein Visit Task Recommendation Associated Objects
API End-of-Life
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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.

File Suffix and Directory Location

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

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
enableRetailExecution boolean Indicates whether Retail Execution is enabled for your org (true) or not (false). The default value is false.

Declarative Metadata Sample Definition

The following is an example of a Retail Execution Settings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<RetailExecutionSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3  <enableRetailExecution>false</enableRetailExecution>
4</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>47.0</version>
8</Package>