Jump to

• Request
• Response
• Examples

Get Pricing Options

get

/rest/v16/pricingSetup/pricingOptions

Use this endpoint to retrieve all pricing options.

Request

Query Parameters

• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
• finder: string
  Used as a predefined finder to search the collection.
  Format: ?finder=<finderName>;<VarName>=<variableValue>
  The following are the available finder names and corresponding finder variables:

  • findByKeyword: Find pricing options using variable name.
    Finder Variable:
    • keyword;string: The search text.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderby: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
• totalResults: boolean
  The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_PricingOption

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingOption"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingOption

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingOption"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : PricingOption

Type: object

Show Source

• category: string()
  Title: Category

  Allowed Values: [ "legacyPhaseOut", "advancedOption", "featureOptIn" ]

  The category of the Pricing Option.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation date of the Pricing Option.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Pricing Option.
• description: string()
  Title: Description

  The description of the Pricing Option.
• displayName: string()
  Title: Display Name

  The display name of the Pricing Option.
• enabled: boolean()
  Title: Enabled

  Indicates if the pricing option is enabled.
• functionalArea: string()
  Title: Functional Area

  Allowed Values: [ "general", "charge", "integration", "scripting" ]

  The functional area of the Pricing Option.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• readOnly: boolean()
  Title: ReadOnly

  Indicates if the pricing option is read only.
• value: string()
  Title: Value

  The value of the pricing option if it cannot be enabled/disabled.
• variableName: string()
  Title: Variable Name

  The unique variable name of the Pricing Option.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Option.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Option.",
            "title":"Date Added",
            "readOnly":true
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The unique variable name of the Pricing Option.",
            "title":"Variable Name"
        },
        "displayName":{
            "type":"string",
            "format":"",
            "description":"The display name of the Pricing Option.",
            "title":"Display Name"
        },
        "category":{
            "type":"string",
            "format":"",
            "description":"The category of the Pricing Option.",
            "title":"Category",
            "enum":[
                "legacyPhaseOut",
                "advancedOption",
                "featureOptIn"
            ]
        },
        "functionalArea":{
            "type":"string",
            "format":"",
            "description":"The functional area of the Pricing Option.",
            "title":"Functional Area",
            "enum":[
                "general",
                "charge",
                "integration",
                "scripting"
            ]
        },
        "readOnly":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the pricing option is read only.",
            "title":"ReadOnly"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the Pricing Option.",
            "title":"Description"
        },
        "value":{
            "type":"string",
            "format":"",
            "description":"The value of the pricing option if it cannot be enabled/disabled.",
            "title":"Value"
        },
        "enabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the pricing option is enabled.",
            "title":"Enabled"
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following examples show how to retrieve CPQ pricing options by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/pricingOptions

Response Body Sample

{
    "items": [
        {
            "dateModified": "2024-02-12T19:23:32Z",
            "dateAdded": "2023-03-23T14:30:17Z",
            "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": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions/applyFirstMatchingPriceModel"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        },
        {
            "dateModified": "2024-02-12T19:23:32Z",
            "dateAdded": "2023-03-23T14:30:17Z",
            "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.comrest/v16/pricingSetup/pricingOptions/transferPricingJSON"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        },
        {
            "dateModified": "2024-02-12T19:23:32Z",
            "dateAdded": "2023-03-23T14:30:17Z",
            "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. 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.
			
			Version 1 represents the legacy pricing behavior.
			
			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.
			
			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.
			
			Version 4 retains all Version 3 adjustments and improves commerce pricing performance. Pricing calculation 
			is now optimized to run once in commerce actions.
			
			For more information, please refer to the CPQ Admistrator Online Help.",
            "value": "Version 4",
            "enabled": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions/commercePricingBehavior"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        },
        {
            "dateModified": "2024-01-23T03:14:25Z",
            "dateAdded": "2023-09-21T14:31:12Z",
            "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.",
            "value": "300100071623855",
            "enabled": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions/fusionDefaultPriceList"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        },
        {
            "dateModified": "2023-09-25T21:42:38Z",
            "dateAdded": "2023-09-21T14:31:12Z",
            "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": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions/enableChargeDefinition"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        },
        {
            "dateModified": "2024-02-12T19:23:32Z",
            "dateAdded": "2024-01-16T16:18:42Z",
            "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.comrest/v16/pricingSetup/pricingOptions/applyPLMultiChargeAsAWhole"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        },
        {
            "dateModified": "2024-02-12T19:23:32Z",
            "dateAdded": "2024-01-16T16:18:42Z",
            "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.comrest/v16/pricingSetup/pricingOptions/applyAdjustmentsToExistingChargesOnly"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        },
        {
            "dateModified": "2024-02-12T19:23:32Z",
            "dateAdded": "2024-01-16T16:18:42Z",
            "variableName": "honorCommercePriceActionPerms",
            "displayName": "Observe commerce process Steps for the pricing action in quoting",
            "category": "advancedOption",
            "functionalArea": "general",
            "readOnly": false,
            "description": "honorCommercePriceActionPerms_helpText",
            "enabled": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions/honorCommercePriceActionPerms"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        },
        {
            "dateModified": "2024-01-23T12:06:52Z",
            "dateAdded": "2024-01-22T21:20:48Z",
            "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.",
            "value": "zOKC_AUTO_SALESAGREEMENT_OM",
            "enabled": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions/fusionContractTypeName"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        },
        {
            "dateModified": "2024-02-12T19:23:32Z",
            "dateAdded": "2024-01-04T21:09:09Z",
            "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": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions/automaticCurrencyConversion"
                },
                {
                    "rel": "parent",
                    "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
                }
            ]
        }
    ],
    "offset": 0,
    "limit": 1000,
    "count": 10,
    "hasMore": false,
    "links": [
        {
            "rel": "canonical",
            "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions"
        },
        {
            "rel": "self",
            "href": "https://sitename.oracle.comrest/v16/pricingSetup/pricingOptions?offset=0&limit=1000"
        }
    ]
}

Back to Top