Newer Version Available

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

InventorySettings

Represents options for the Salesforce Omnichannel Inventory product.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

InventorySettings values are stored in the Inventory.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

Inventory settings are available in API version 51 and later.

Special Access Rules

This metadata type is only accessible by developers and customers using Salesforce Omnichannel Inventory.

Fields

Field Name Field Type Description
enableOCIB2CIntegration boolean Indicates whether Omnichannel Inventory is allowed to exchange inventory data with B2C Commerce (true) or not (false). The default value is false.
enableOmniChannelInventory boolean Indicates whether Omnichannel Inventory features are enabled (true) or not (false). The default value is false.

Declarative Metadata Sample Definition

The following is an example of an InventorySettings component.

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

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