Newer Version Available

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

OrderManagementSettings

Represents options for the Lightning Order Management product, which is currently in closed beta.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

OrderManagementSettings values are stored in the OrderManagement.settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

Order Management settings are available in API version 47 and later.

Special Access Rules

This metadata is only used by internal developers and customers participating in the Lightning Order Management closed beta.

Fields

Field Name Field Type Description
enableOrderManagement boolean Indicates whether Lightning Order Management features are enabled.

Declarative Metadata Sample Definition

The following is an example of an OrderManagementSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<OrderManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata" 
3xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
4    <enableOrderManagement>true</enableOrderManagement>
5</OrderManagementSettings>

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