Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

OrderSettings

Represents order settings. It extends the Metadata metadata type and inherits its fullName field. For more information, see “Customizing Order Settings” in the Salesforce Help.

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

There is one OrderSettings component in a file named Order.settings in the settings folder. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

OrderSettings components are available in API version 30.0 and later.

Fields

Field Name Field Type Description
enableNegativeQuantity boolean Indicates whether users in the organization can add order products with quantities of less than zero (true) or not (false).

To enable this preference, enableOrders must be set to true.
enableOrders boolean Indicates whether orders are enabled for the organization (true) or not (false).
enableReductionOrders boolean Indicates whether reduction orders are enabled for the organization (true) or not (false). For more information, see “Reduction Orders Overview” in the Salesforce Help.

To enable this preference, enableOrders must be set to true.

Declarative Metadata Sample Definition

This is a sample OrderSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<OrderSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableOrders>true</enableOrders>
4    <enableReductionOrders>false</enableReductionOrders>
5    <enableNegativeQuantity>true</enableNegativeQuantity>
6</OrderSettings>

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