PricingRecipe | Metadata API Developer Guide

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

PricingRecipe components have the suffix .pricingRecipe and are stored in the pricingRecipe folder.

Version

PricingRecipe components are available in API version 60.0 and later.

Special Access Rules

This metadata type is available with Salesforce Pricing.

Fields

Field Name	Description
defaultPricingProcedure	Field Type ExpressionSetDefinition Description Expression set definition that's associated with this pricing recipe setting.
defaultPricingProcedureDeveloperName	Field Type string Description For internal use only.
defaultPricingProcedureId	Field Type string Description ID of the pricing procedure of the pricing recipe.
developerName	Field Type string Description Required. API name of the pricing recipe.
isActive	Field Type boolean Description Indicates whether the pricing recipe is active (`true`) or not (`false`). The default value is `false`
isInternal	Field Type boolean Description Indicates whether the price recipe record is created internally by the Salesforce platform (`true`) or not (`false`). The default value is `false`
masterLabel	Field Type string Description Required. Name for pricing recipe that's defined when the pricing recipe is created.
pricingRecipeTableMapping	Field Type PricingRecipeTableMapping[] Description Mapping of the pricing components of a lookup table with the chosen pricing recipe.

PricingRecipeTableMapping

Represents the mapping of the lookup table with the chosen pricing recipe.

Field Name	Description
isInternal	Field Type boolean Description Indicates whether the price recipe field mapping record is created internally by the Salesforce platform (`true`) or not (`false`). The default value is `false`.
lookupTable	Field Type DecisionTable DecisionMatrixDefinition Description Lookup table that's associated with either a decision matrix or decision table.
lookupTableDeveloperName	Field Type string Description For internal use only.
pricingComponentType	Field Type string Description Pricing component field data that the decision table is built on. Valid values are: `AttributeDiscount` `BundleDiscount` `DerivedPricing` `ListPrice` `PriceAdjustmentMatrix` `PromotionsDiscount` `VolumeDiscount` `VolumeTierDiscount` `DiscountDistributionService`. This value is available in API version 60.0 and later. `MinimumPrice`. Available in API version 62.0 and later.
pricingProcedureOutputMapList	Field Type PricingProcedureOutputMap[] Description List of the mappings of the outputs of the pricing procedures to the associated lookup tables. Available in API version 60.0 and later.
pricingRecipe	Field Type string Description Required. Pricing data store that's associated with this pricing recipe field mapping.

PricingProcedureOutputMap

Represents the mapping of the outputs of the pricing procedures to the associated lookup tables. Each record specifies the output mapping of the associated lookup table based on the pricing component type specified in the PricingRecipeTableMapping object.

Field Name	Description
fieldName	Field Type string Description For internal use only.
isPricingRecipeActive	Field Type boolean Description Indicates whether the associated pricing recipe is active (`true`) or not (`false`). The default value is `false`.
outputFieldName	Field Type string Description Field name that contains the output type that's generated from the pricing element.
outputFieldNameString	Field Type string Description Derived field that references a specific column in a decision table or decision matrix.
outputType	Field Type string Description Output type that's generated from a pricing element. Valid values are: `AdjustmentType` `AdjustmentValue` `CustomOutput` `HashOutput` `UnitPrice`
pricingElementType	Field Type PricingElementType (enumeration of type string) Description Type of pricing element, which is a derived field from `PricingRecipeTableMapping.PricingComponentType`. Valid values are: `AssetDiscovery` `AttributeDiscount` `BundleDiscount` `DerivedPricing` `DiscountDistributionService` `ListPrice` `MinimumPrice` `PriceAdjustmentMatrix` `PriceRevision` `PromotionsDiscount` `RuleFetch` `VolumeDiscount` `VolumeTierDiscount`

Declarative Metadata Sample Definition

The following is an example of a PricingRecipe component.

1<PricingRecipe xmlns="http://soap.sforce.com/2006/04/metadata">
2    <defaultPricingProcedureId> </defaultPricingProcedureId>
3    <developerName>CMEDefaultRecipe</developerName>
4    <isActive>false</isActive>
5    <isInternal>false</isInternal>
6    <masterLabel>CMEDefaultRecipe</masterLabel>
7    <pricingRecipeTableMapping>
8        <isInternal>false</isInternal>
9        <lookupTableDeveloperName>Bundle_Based_Adjustment_Decision_Table</lookupTableDeveloperName>
10        <pricingComponentType>CUSTOMDISCOUNT</pricingComponentType>
11        <fileBasedDecisionTableName>Bundle Based Adjustment Entries</fileBasedDecisionTableName>
12        <pricingProcedureOutputMapList>
13            <fieldName>AdjustmentValue</fieldName>
14            <isPricingRecipeActive>false</isPricingRecipeActive>
15            <outputFieldName>0lPxx000000000f</outputFieldName>
16            <outputFieldNameString>false</outputFieldNameString>
17            <outputType>AdjustmentValue</outputType>
18	     <pricingElementType>BundleDiscount</pricingElementType>
19        </pricingProcedureOutputMapList>
20        <pricingProcedureOutputMapList>
21            <fieldName>AdjustmentType</fieldName>
22            <isPricingRecipeActive>false</isPricingRecipeActive>
23            <outputFieldName>0lPxx000000000m</outputFieldName>
24            <outputFieldNameString>false</outputFieldNameString>
25            <outputType>AdjustmentType</outputType>
26	     <pricingElementType>BundleDiscount</pricingElementType>
27        </pricingProcedureOutputMapList>
28        <pricingRecipe>CMEDefaultRecipe</pricingRecipe>
29    </pricingRecipeTableMapping>
30</PricingRecipe>

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>*</members>
5        <name>PricingRecipe</name>
6    </types>
7    <version>67.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.