---
schema_version: "1"
id: 5e84e9abc035d49aad94cef31b52eb6d82664ad859dad38707a72ca2806c5801
title: OrderSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_ordersettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ordersettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 248143b911ff476784d4cfef31877a7acd3310c92cfc06924f9c8e86186fe797
description: Represents order settings.
---
# OrderSettings

Represents order settings.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for 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’s only one settings file for each settings component.

## Version

OrderSettings components are available in API version 30.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d724146e111">Field Name</th>

              <th class="featureTableHeader  " id="d724146e114">Field Type</th>

              <th class="featureTableHeader  " id="d724146e117">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableEnhancedCommerceOrders</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether enhanced commerce orders are enabled for the
                org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This preference is
                available only in orgs with the Salesforce Order Management license.
                Default value is <samp class="codeph nolang">false.</samp>
                Available in API versions 48.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableNegativeQuantity</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether users in the org can add order products with
                quantities of less than zero (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">To enable this preference,
                  <span class="keyword parmname">enableOrders</span> must be set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableOptionalPricebook</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether users in the org can create orders without
                price books (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). For more
                information, see <a class="xref" href="https://help.salesforce.com/s/articleView?id=sales.customize_order_enable_without_pricebooks.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Enable
                  Orders Without Price Books</a> in Salesforce Help.</td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableOrderEvents</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether order events are enabled for the org (<samp class="codeph nolang">true</samp>) or not <samp class="codeph nolang">(false)</samp>. For more information, see
                OrderStatusChangedEvent in the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_intro.htm" target="_blank" title="HTML (New Window)">Platform
                  Events Developer Guide</a>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableOrders</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether orders are enabled for the org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>


            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableOrderWithMultiplePriceBooks</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether users in the org can create orders containing
                order items that refer to multiple price books (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version
                60.0 and later.<p class="p">To enable this preference,
                  <span class="keyword parmname">enableOrders</span> and
                  <span class="keyword parmname">enableEnhancedCommerceOrders</span> must be
                  set to <samp class="codeph nolang">true</samp>.
                </p>
                <p class="p">This
                  field helps to offer different pricing structures for various
                  customer segments, regions, or promotional periods.</p>
              </td>

            </tr>


            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableReductionOrders</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether reduction orders are enabled for the org
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). For more information, see
                <a class="xref" href="https://help.salesforce.com/s/articleView?id=sales.orderreduction_overview.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">Reduction
                  Orders</a> in Salesforce Help.<p class="p">To enable this preference,
                  <span class="keyword parmname">enableOrders</span> must be set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d724146e111" data-title="Field Name"><span class="keyword parmname">enableZeroQuantity</span></td>

              <td class="entry" headers="d724146e114" data-title="Field Type">boolean</td>

              <td class="entry" headers="d724146e117" data-title="Description">Indicates whether users in the org can add order products with
                quantities of zero (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). Default value is
                <samp class="codeph nolang">false</samp>.<p class="p">To enable this
                  preference, <span class="keyword parmname">enableOrders</span> must be set to
                  <samp class="codeph nolang">true</samp>.
                </p>
                <p class="p">Available
                  in API version 42.0 and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This is a sample OrderSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<OrderSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableNegativeQuantity\>false</enableNegativeQuantity\>
    <enableZeroQuantity\>false</enableZeroQuantity\>
    <enableOrders\>true</enableOrders\>
    <enableReductionOrders\>true</enableReductionOrders\>
    <enableEnhancedCommerceOrders\>true</enableEnhancedCommerceOrders\>
    <enableOptionalPricebook\>false</enableOptionalPricebook\>
    <enableOrderEvents\>false</enableOrderEvents\>
    <enableOrderWithMultiplePriceBooks\>false</enableOrderWithMultiplePriceBooks\>
</OrderSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Order</members\>
        <name\>Settings</name\>
    </types\>
    <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).