Pricing Option REST APIs
Overview
These endpoints enable administration of Pricing Options using REST API services.
Administration
Description |
Use this endpoint to retrieve all pricing options. |
|
---|---|---|
URI Endpoint |
/rest/v17/pricingSetup/pricingOptions |
|
Endpoint Parameters |
None |
|
(Optional) This endpoint supports the following query specifications: |
||
HTTP Method |
GET |
|
Request Body Parameters |
None |
|
Response Body Parameters |
A collection of CPQ pricing options, which includes:
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions
{ "items": [{ "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2023-04-26T15:51:02Z", "dateAdded": "2023-04-10T05:14:16Z", "variableName": "transferPricingJSON", "displayName": "Transfer Price Model JSON to Commerce", "category": "advancedOption", "functionalArea": "general", "readOnly": false, "description": "Whether to transfer Pricing Engine calculation info JSON from Price Models to Commerce line attribute Calculation Information (_price_calculation_info). Turn this option off for better performance if you don't use this function in commerce.", "enabled": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/transferPricingJSON" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2023-04-26T15:51:02Z", "dateAdded": "2023-04-10T05:14:16Z", "variableName": "applyFirstMatchingPriceModel", "displayName": "Apply only the first matching Price Model", "category": "advancedOption", "functionalArea": "general", "readOnly": false, "description": "This option determines if one or multiple Price Models are applied to a part during pricing evaluation. 'Yes' indicates that the first Price Model that matches the Pricing Rule criteria is applied to the part. 'No' indicates that all Price Models that match the Pricing Rule criteria are applied to the part.", "enabled": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/applyFirstMatchingPriceModel" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2023-04-26T15:51:02Z", "dateAdded": "2023-04-10T05:14:16Z", "variableName": "commercePricingBehavior", "displayName": "Pricing Behavior", "category": "advancedOption", "functionalArea": "general", "readOnly": false, "description": "This option modifies the order of actions and calculation of prices. Depending on your adoption of Pricing Engine, this setting may have been set automatically and may limit which options you may choose.<br><br>Switching from one Pricing option to another may impact existing pricing and past transactions within the system. Oracle recommends thoroughly testing the impact of the Pricing option change before implementing the change in a production environment. Once the Pricing option is changed in a production environment, returning transaction data to its previous state may require significant effort.<br><br>Version 1 represents the legacy pricing behavior.<br><br>Version 2 runs the CPQ Pricing Engine as part of pricing calculations and provides for the following adjustments to the Invocation and Pricing flows: Main Document attributes populate before the Sub Document modify execution occurs; and Global Pricing calculations occur immediately before the execution of Formulas.<br><br>Version 3 retains all Version 2 adjustments in addition to the following change: The Document Advanced Default BML will no longer execute when the 'Revert to Default' selection is selected for attribute(s) on the modify tab of an Action.<br><br>Version 4 retains all Version 3 adjustments and improves commerce pricing performance. Pricing calculation is now optimized to run once in commerce actions.<br><br>For more information, please refer to the Software Help.", "value": "Version 4", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/commercePricingBehavior" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2023-10-06T21:08:37Z", "dateAdded": "2023-10-06T21:08:37Z", "variableName": "fusionDefaultPriceList", "displayName": "Default Partner Price List", "category": "advancedOption", "functionalArea": "integration", "readOnly": false, "description": "Represents the default partner Price List ID at the global level that maps to CPQ Price Lists.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/fusionDefaultPriceList" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2023-10-06T21:08:37Z", "dateAdded": "2023-10-06T21:08:37Z", "variableName": "enableChargeDefinition", "displayName": "Enable Charge Definitions", "category": "advancedOption", "functionalArea": "charge", "readOnly": false, "description": "Charge definitions are used to categorize charges. When enabled, the Pricing administrator selects a charge definition first when creating a charge. You must turn this option on to integrate with Oracle Fusion Order Management.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/enableChargeDefinition" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-04-15T18:54:36Z", "dateAdded": "2024-04-15T18:54:36Z", "variableName": "automaticCurrencyConversion", "displayName": "Enable Currency Conversion in Pricing Engine", "category": "advancedOption", "functionalArea": "charge", "readOnly": false, "description": "This option activates automatic currency conversion from the site base currency if no price is specified for a currency in Pricing Engine. When this option is on and a charge does not have a price for a currency, Pricing Engine will convert the base currency price, if one exists, using the CPQ Exchange Rates. When this option is off and no price is defined in Pricing Engine for the transaction currency, the pricing applied falls back to the previous price model price, price book price, or part price that is available in the transaction currency. This is the legacy behavior for CPQ Pricing. You are strongly recommended to turn this option on.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/automaticCurrencyConversion" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-04-15T18:54:36Z", "dateAdded": "2024-04-15T18:54:36Z", "variableName": "applyPLMultiChargeAsAWhole", "displayName": "Apply multiple charges in a price list as a whole", "category": "advancedOption", "functionalArea": "charge", "readOnly": false, "description": "When the option is on, multiple charges of a product from an absolute price model (price list) are applied as a whole. When the option is off, the charges are applied additively.For example, price list 1 has charge A, B, price list 2 has charge B, C, and when both price list 1 and 2 apply, the final charges are charge B, C when the option is on, and A, B, C when the option is off.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/applyPLMultiChargeAsAWhole" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-04-15T18:54:36Z", "dateAdded": "2024-04-15T18:54:36Z", "variableName": "applyAdjustmentsToExistingChargesOnly", "displayName": "Apply adjustments on existing charges only", "category": "advancedOption", "functionalArea": "charge", "readOnly": false, "description": "When the option is on, a discount or markup to a charge only applies if a previous price list has instantiated the charge.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/applyAdjustmentsToExistingChargesOnly" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-04-15T18:54:36Z", "dateAdded": "2024-04-15T18:54:36Z", "variableName": "honorCommercePriceActionPerms", "displayName": "Observe commerce process Steps for the pricing action in quoting", "category": "advancedOption", "functionalArea": "general", "readOnly": false, "description": "Pricing is executed in quoting only if commerce action Recalcuate (_calculate_price_action) is active in the current commerce process Step. This option, when enabled, further ensures that commerce sub-document actions invoke pricing only immediately before Formula for Pricing Behavior v2 or higher.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/honorCommercePriceActionPerms" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-04-15T18:54:36Z", "dateAdded": "2024-04-15T18:54:36Z", "variableName": "fusionContractTypeName", "displayName": "Contract Type Name", "category": "advancedOption", "functionalArea": "integration", "readOnly": false, "description": "Represents the Contract Type Name that maps to contracts of type Sales Agreement in Fusion.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/fusionContractTypeName" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-07-03T15:38:57Z", "dateAdded": "2024-07-03T15:38:57Z", "variableName": "enableAdministrationLogging", "displayName": "Enable Pricing Portal Administration Logging", "category": "advancedOption", "functionalArea": "general", "readOnly": false, "description": "When the option is on, change history to Pricing Portal is logged in Administration Logs.<br><br>Logging can negatively impact performance. Validate performance before turning it on in production.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/enableAdministrationLogging" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-07-03T15:38:57Z", "dateAdded": "2024-07-03T15:38:57Z", "variableName": "enableIncrementalPricingInQuote", "displayName": "Enable incremental pricing in quoting", "category": "advancedOption", "functionalArea": "general", "readOnly": false, "description": "When the option is on, only line items whose pricing attributes are changed are repriced. If any header pricing attribute is changed, all line items are repriced. When the option is off, if any pricing header attribute is changed or any line item is changed, all line items are repriced. You are recommended to turn this option on if all line items are priced independently.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/enableIncrementalPricingInQuote" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-07-03T15:38:57Z", "dateAdded": "2024-07-03T15:38:57Z", "variableName": "beforePricingEngineExecution", "displayName": "Pricing Script: Before Pricing Engine Execution", "category": "advancedOption", "functionalArea": "scripting", "readOnly": false, "description": "This option if enabled determines the script to be executed before the start of pricing engine execution.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/beforePricingEngineExecution" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-07-03T15:38:57Z", "dateAdded": "2024-07-03T15:38:57Z", "variableName": "afterPricingEngineExecution", "displayName": "Pricing Script: After Pricing Engine Execution", "category": "advancedOption", "functionalArea": "scripting", "readOnly": false, "description": "This option if enabled determines the script to be executed after the end of pricing engine execution.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/afterPricingEngineExecution" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "dateModified": "2024-08-01T17:09:52Z", "dateAdded": "2024-08-01T17:09:52Z", "variableName": "applyContextDependentPricingAttrMapping", "displayName": "Apply context-dependent data source in Pricing Attribute Mapping", "category": "advancedOption", "functionalArea": "general", "readOnly": false, "description": "This setting is only applicable when a Pricing Attribute has more than one Attribute Mapping. When the option is on, the data source corresponding to the current invocation context is used. When the option is off, the mapping is honored strictly by the order number. For example, define two attribute mappings for a pricing attribute with the following data sources: a configuration model and a commerce process. When the option is on, the configuration data source is used in the configuration model, and the commerce data source is used in the commerce process. When the option is off, the available data source of the lowest order number is used.", "enabled": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions/applyContextDependentPricingAttrMapping" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" } ] } ], "offset": 0, "limit": 1000, "count": 15, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions?offset=0&limit=1000" } ] }
Description |
Use this endpoint to update pricing options. |
|
---|---|---|
URI Endpoint |
/rest/v17/pricingSetup/pricingOptions |
|
Endpoint Parameters |
None |
|
HTTP Method |
PATCH |
|
Request Body Parameters |
The array of pricing patch operations. |
|
op |
The operation to be performed | |
path |
The JSON pointer string for "path" property.
|
|
value |
The target value. | |
Success Response |
204 |
https://sitename.oracle.com/rest/v17/pricingSetup/pricingOptions
[{ "op": "replace", "path": "/transferPricingJSON", "value": { "enabled": "true" } }, { "op": "replace", "path": "/commercePricingBehavior", "value": { "value": "Version 4" } } ]