REST API Version Updates

Overview

The following table lists updates for Oracle CPQ REST API versions.

Version Update Description

v17

Version	Update Description
v17	Oracle CPQ 24D introduces the following features: Calculate Price REST API enhancements: Renamed the following parameters to align with pricing document attributes: "items" is now "lines" "itemIdentifier" is now "_itemIdentifier" "currencyCode" is now "_currencyCode" "customerId" is now "_customerId" "partNumber" is now "_partNumber" Removed "headerAttributeValues" and "itemAttributeValues" objects and included their attributes into their respective parent "pricing-calculatePriceRequest" or "lines" object. Consolidated product price attributes under charges New Commerce REST APIs: Create Price Agreement - create a CPQ Price Agreement from the current transaction sales agreement. Self Service Checkout - update the quote to a closed phase when an order corresponding to this quote is placed using an external system. By default, this action will put the Quote in Canceled step and External Order status. Commerce REST API updates: New "Stage" Resource Path Parameter for Commerce REST APIs The new "Stage" resource parameter provides web service support for transactions in different stages in the Commerce process flow. CPQ automatically generates Commerce endpoints for the Interface Catalog based on your site setup. The new base URL is `/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}`. The following stages are available: Documents includes transactions from all stages Quotes includes transactions in the Quote stage Agreements includes transaction is the Agreement stage Orders includes transactions in the Order stage Endpoints for modify-type actions now support adding favorites to a transaction. New Metrics REST API enables customer to retrieve all business metrics for a site. New Performance Debugger REST API enables customers to collect granular performance logs for Configuration actions, including the timing for associated rules and conditions. Create a Performance Debugger Logging Task - create a performance debugger log for the Configuration action identified in the request payload. Get All Performance Debugger Records - retrieve a list of performance debugger log records. Get a Performance Debugger Record - retrieve the specified performance debugger log record. New Pricing Agreement Attribute REST APIs to support Sales Agreements Get Agreement Attributes - retrieve all agreement attributes. Get Agreement Attribute - retrieve the specified agreement attribute. Delete Agreement Attribute - delete the specified agreement attribute. Get Agreement Attribute Mappings - retrieve attribute mappings for the specified agreement attribute. Update Agreement Attribute Mappings - update attribute mappings for the specified agreement attribute. Migrate Agreement Charge Attributes - create agreement charge attributes from an existing pricing charge attribute. New Pricing Bulk Service REST APIs for pricing export, import, and bulk data services using web services. Get Price Model Bulk Data Headers - retrieve Price Model attributes to define CSV headers for bulk data service uploads. Get Price Model Item Bulk Data Headers - retrieve Price Model Item attributes to define CSV headers for bulk data service uploads. Get Rate Plan Bulk Data Headers - retrieve Rate Plan attributes to define CSV headers for bulk data service uploads. Get Charge Bulk Data Headers - retrieve Charge attributes to define CSV headers for bulk data service uploads. Upload Pricing Bulk Data - bulk upload Oracle CPQ pricing data. Pricing Setup REST API Enhancements Added "scriptingMatrixVariableName" parameter to Price Model endpoints to support Scripting Price Matrices. Added "advancedByTemplate" option to the Price Model "listType" parameter to identify Advanced Price Models with Scripting Price Matrices. Added "scriptingPriceModel" option to the Pricing Matrix Template "templateType" parameter to identify Advanced Price Models with Scripting Price Matrices. Pricing Attribute endpoints will now support Charge Attributes. Added "ioType" parameter to Pricing Attributes and Charge Attribute endpoints to identify if an attribute is an input, output, internal, or external. Added "sourceEntity" and "validMapping" parameters to Pricing Attributes and Charge Attribute mapping endpoints.
v16	Oracle CPQ 24C introduces the following features: New Collaborative Quote Queue REST APIs to manage the collaborative queue: Get Collaborative Quote Queue Clear Collaborative Queue New Commerce REST APIs: Get Archived Transactions - retrieve a list of archived transactions. Delete Archived Transactions - delete the specified archived transactions. Restore Archived Transactions - restore the specified archived transactions. Copy Sequence - retrieve copy sequences for the Commerce process. Forward Transactions - forward selected transactions to the specified users and/or groups. Email Transaction - Commerce process level action to format, merge, and email a transaction. Print Transaction - Commerce process level action to format, merge, and print a transaction. Accept Quote - accept the quote for the specified transaction. Get Transaction Comment - retrieve the specified transaction comment. Get Transaction Comments - retrieve comments for the specified transaction. Publish Quote - notify the self-service channel that the quote is ready for review for customer/buyer. Request Quote Revision - request quote revision for the specified transaction. Commerce REST API enhancements to support accept process level email & print actions and copy sequence specifications. Endpoints for modify-type actions now support adding unconfigured models to a transaction. New BOM Item Administration APIs to support the simple configurator for BOM hierarchies Generate Configurator Get Related Configurator New Groups REST API to support host company and partner organizations endpoints. New Pricing Item REST APIs to support the pricing items: Get and Search Price Items(s) Get, Add, Update, and Delete Price Item Charge Groups Get, Add, Update, and Delete Price Item Charge Group Charges Get, Add, Update, and Delete Price Item Charge Group Rate Plans Get, Add, Update, and Delete Price Item Charge Group Rate Plan Charges New Price Agreement and Price Model endpoints to support matrix grids: Get Price Agreement Pricing Matrix Grid Data Update Price Agreement Pricing Matrix Grid Data Get Price Model Pricing Matrix Grid Data Update Price Model Pricing Matrix Grid Data Pricing Setup REST API enhancements: The Price Setup endpoints now include Created By and Last Modified objects to record user details for pricing items to support SOX compliance in CPQ pricing. The Price Agreement endpoints now include the Source Transaction ID and Status attributes to support sales agreement authoring in CPQ pricing. The Pricing Option REST APIs are updated to support new pricing options: Enable incremental pricing in quoting, Enable Pricing Portal Administration Logging, and Pricing Scripts for Before and After Pricing Engine Execution New Product Search REST APIs to search and retrieve CPQ products. Products consist of both stand-alone parts and product structures (i.e. BOM hierarchies). Get All Products Get a Product Search for Products New Sales Company endpoints: Get Sales Companies Get Sales Company Get Sales Company Groups Get Sales Company Group Get Sales Company Users Get Sales Company User
Oracle CPQ 24B introduces the following features: Get Commerce Settings - returns Commerce Settings and applicable General Site settings. New Commerce REST API endpoint: Group Transactions - returns a list of transaction grouped by columns specified in the request. New Company REST API endpoints for retrieving, adding, and updating host company and partner organization data including support for company style sheets and translations. The new Saved Search REST APIs support the new Quotes List page. Grouping and keyword searches are supported for applicable endpoints. Create a Saved Search Delete a Saved Search Get a Saved Search Get Saved Searches Update a Saved Search Update Saved Search Access Permissions Update Site Default Saved Search Update User Default Saved Search New data store endpoints for the Extract Data REST API allow a customer to identify data stores (i.e., objects) and data store attributes that can be extracted from CPQ. Customers can also use available data store attributes to define criteria to extract data from the specified data store. Extract Data Stores Get All Data Store Attributes Get All Data Stores New Global Branding endpoint to retrieve the global branding properties for a site. New Global Dictionary endpoints to retrieve, add, update, or delete the values in the global dictionary defined for a site. New Pricing Setup endpoints to support new pricing functionality: Price Agreements - These endpoints enable administration of CPQ Price Agreements, Price Agreement Items, Price Agreement stand-alone Charges, Price Agreement Rate Plans, and Price Agreement Rate Plan Charges using REST API services. Pricing Matrices and Pricing Matrix Templates - These endpoints enable administration of Pricing Matrices and Pricing Matrix Templates using REST API services. Pricing Previews - These endpoints enable administration of Pricing Previews using REST API services. They retrieve the pricing attribute values and pricing line items associated with a Commerce transaction. New User Navigation Links REST API endpoint to retrieve the user navigation links defined in the Navigation Menu for a site.
Oracle CPQ 24A introduces the following features: To optimize Commerce rules evaluation, CPQ introduced a new request parameter for Commerce Modify Action REST endpoints. When the `"skipRules": ["HIDING"]` parameter is included the request body during action invocation, Hiding Rules will not be evaluated. This parameter can be used with the endpoint for any Modify type action. New Commerce REST API endpoints: Archive Transactions My Approval Search Unlock Transactions Return consolidated list of Product Family, Product Line, and Model attribute metadata from a Configuration layout. Get Configuration Layout Attribute Data New Product Administration endpoints to enable administration of single select and multi-select menu items using REST API web services. These endpoints provide functions for All Product Families, Product Family, and Model menu items, menu item images, menu item prices, and menu item translations. Update a Menu Item Delete a Menu Item Remove a Menu Item Override Add a Menu Item Image Delete a Menu Item Image Update a Menu Item Image Add a Menu Item Price Delete a Menu Item Price Update a Menu Item Price Add Menu Item Translation Delete a Menu Item Translation Update a Menu Item Translation User Line Item Grid User Personalization. Get All User Personalizations Get a User Personalization Reset User Personalization Save User Personalization
v15	Oracle CPQ 23D introduces the following features: The Last Deploy Date of the product family is added to the Configure Model REST API response when Configuration cache is enabled to allow customers to validate if a local cache instance is up to date with the most current Configuration layout updates. BOM Mapping REST API enhancements: Root BOM Item Label” and “Root BOM Item Part Number” are now included in the BOM Item Definition instance and collection responses. Case insensitive queries can now be performed on the BOM Item Setups collection. New Upsert BOM Item List endpoint added to create, update, or delete CPQ BOM hierarchies using a list format. The Calculate Price REST API is updated to support Charges and Rate Plans. Configuration Product Administration REST API enhancements Added Deploy a Product Family and Get Undeployed Data Tables endpoints to support Product Family Deployment. Added Get, Add, Update, and Delete Configuration Actions (including Configuration Action Translations). Added the Commerce Get History endpoint to retrieve historical changes for a transaction. The following new migration package and migration resource REST API web services are supported: Get Migration Package Content Dependencies Get Dependencies for Selected Migration Resources or Migration Package from Source Site Migrate Selected Migration Resources or Migration Package from Source Site Add Util Library Namespaces to Migration Package REST APIs to aid in package lifecycle management. The unique namespace can be applied when creating, updating, or searching migration package resources. Specify granular (low-level) content in the request payload while creating or updating a migration package. Pricing Setup REST enhancements: Added the following REST API web services to support the Rate Plan business object and pricing integration: Submit Fusion Pricing Synchronization Task Get, Add, Update, and Delete Charge Attributes Get, Add, Update, and Delete Charge Definitions Get, Search, Add, and Delete Price Model Items Get, Add, Update, and Delete Charges, Rate Plans, and Rate Plan Charges Get, Add, Update, and Delete Rate Cards and Rate Card Templates Added the Enable Charge Definition option to Pricing Options endpoints. Added Dynamic Pricing Type property to Price Model Pricing Data endpoints Oracle CPQ 23D removes support or limits the following existing endpoints: Add Price Model Pricing Data (Replaced with Add a Price Model Item) Delete a Price Model Pricing Data Item (Replaced with Delete a Price Model Item) Update a Price Model Pricing Data Item (Replaced with Update a Price Model Item)
v14	Oracle CPQ 23C introduces the following features: Updated the Calculate Price REST API to support multiple charges and product launch. Beginning in Oracle CPQ 23C, customers can use this web service to calculate and return both product prices and any charges defined in Pricing Engine. Added pricing charges to the following endpoints to support multiple charges in Configuration Run-Time Data REST API. Get BOM Items (Configuration) Configure Model Configure Model in System Next Configuration Node Reconfigure from Favorites Reconfigure Model Resume Configuration Update Configuration New Extract Data REST API to manage CPQ data extraction for FAW. Request Data Extract Get Site Status for Data Extract Get Data Extract Task Status Cancel Data Extract Task New Migration Package REST API endpoints to aid administrators in the creation, distribution, and deployment of migration packages to different environments and Migration Resources endpoints retrieve the data source entities that are required for successful migration. The following migration package and migration resources web services are available: Create a Migration Package Update a Migration Package Delete a Migration Package Get All Migration Package Content Get Migration Package Category Content Get Migration Package Resource Low-level Details Update Migration Package Content Update Migration Package Resource Low-Level Details Version a Migration Package Migrate Package Upload Zip File for a Migration Package Get All Migration Resources Get Category Migration Resources Get Category Resource Low-level Details Updated the Parts REST APIs to include the variable name of the root BOM item, part configurable flag, and product status to support Product Launch. Introduced the Update/Insert action for the Parts Setup REST API to update or create CPQ Parts. New Pricing Setup REST API endpoints to support pricing lookups for charges: Add a Pricing Lookup Type Add a Pricing Lookup Value Delete a Pricing Lookup Type Delete a Pricing Lookup Value Get a Pricing Lookup Type Get a Pricing Lookup Value Get All Pricing Lookup Types Get All Pricing Lookup Values Update a Pricing Lookup Type Update a Pricing Lookup Value Update Pricing Lookup Types Update Pricing Lookup Values Added a PATCH method to the SCIM-Compliant User Management REST API which allows administrators to update a user record instead of fully replacing the record.
Oracle 23B introduces the following features: New Part Setup REST APIs to enable administration of CPQ parts using REST API services. Get All Parts Get a Part Create a Part Update a Part Delete a Part Get Part Metadata Action Get Part Extended Descriptions Get Part Extended Descriptions Using Extended Descriptions Id Create Part Extended Descriptions Update Part Extended Descriptions Get All Prices for a Part Get a Part Price Create a Part Prices Update a Part Price Delete a Part Price Get All Translations for a Part Get a Part Translation Create a Part Translation Delete a Part Translation Get All Part Extended Description Translations Get Part Extended Description Translations Create Part Extended Description Translations Delete a Part Extended Description Translations New Company REST API to get company information. Calculate Price REST API and Get, Add, and Update Pricing Data for a Price Model REST APIs have been enhanced to support handling of BOM Item product pricing. Added new functions for the Pricing Setup REST API to manage pricing-related settings in CPQ Pricing Engine. Get All Pricing Options Update Pricing Options Added new User REST APIs that are compliant with the System for Cross-domain Identity Management (SCIM) specification. The SCIM specification is an open standard that facilitates managing user identities across cloud-based applications and services. These endpoints retrieve user details and perform actions to create, update, or inactivate a user.
Oracle 23A introduces the following features: The Get BOM Tree REST API will include the following parameters: "`treeHasModel`" – This response parameter will be included for root BOM items only, and will indicate if the root item has any child models. "`isMode`l" – This parameter will be included for all BOM items to indicate if the current item is a model. New Validate a Part for BOM endpoint to validate parts for BOM mapping implementations. New Parts REST API endpoints to view a specific part or an unfiltered list of all parts. All new and existing endpoints for Parts REST API are read-only; parts cannot be added, modified, or deleted using these web services. Get All Parts Get a Part New Pricing Setup REST APIs Add a Customer-Specific Condition for a Pricing Rule Add a Price Model Add a Pricing Attribute Add a Pricing Rule Add Mapping Data for a Pricing Attribute Add Pricing Data for a Price Model Delete a Customer-Specific Condition for a Pricing Rule Delete a Price Model Delete a Pricing Attribute Delete a Pricing Rule Delete Pricing Data for a Price Model Get a Customer-Specific Condition for a Pricing Rule Get a Price Model Get a Pricing Attribute Get a Pricing Rule Get All Customer-Specific Conditions for a Pricing Rule Get All Price Models Get All Price Models Linked to a Pricing Rule Get All Pricing Attributes Get All Pricing Rules Get Lookups for a Currency Get Lookups for a Data Source's Attributes Get Lookups for a Part Get Lookups for All Accounts Get Lookups for All Simple Condition Attributes Get Lookups for All Supported Currencies Get Lookups for All Supported Data Sources Get Lookups for an Account Get Mapping Data for a Pricing Attribute Get Pricing Data for a Price Model Link a Price Model to Pricing Rule Unlink a Price Model from a Pricing Rule Update a Customer-Specific Condition for a Pricing Rule Update a Price Model Update a Price Model Linked to a Pricing Rule Update a Pricing Attribute Update a Pricing Rule Update Customer-Specific Conditions for a Pricing Rule Update Mapping Data for a Pricing Attribute Update Price Models Update Price Models Linked to Pricing Rule Update Pricing Attributes Update Pricing Data for a Price Model Update Pricing Rules
Oracle CPQ 22D introduces the following features: New BOM Mapping REST APIs Get All BOM Item Definitions Get a BOM Item Definition Get All BOM Item Child Definitions for a Parent BOM Item Get a BOM Item Child Definition for a Parent BOM Item Create a BOM Item Definition Delete a BOM Item Definition Update a BOM Item Definition Get All BOM Item Mappings for a Parent BOM Item Get a BOM Item Mapping for a Parent BOM Item Create a BOM Item Mapping for a Parent BOM Item Delete a BOM Mapping for a Parent BOM Item Update a BOM Item Mapping for a Parent BOM Item Get a BOM Item Tree and BOM Item Mappings Create a BOM Item Tree and BOM Item Mappings Update a BOM Item Tree and BOM Item Mappings New Certificates REST APIs Get List of All Certificates Get a Certificate New Integration Vendors REST APIs Get List of Integrations Get an Integration Create an Integration Delete an Integration Update an Integration
Oracle 22C introduces the following features: The Open Transaction Line REST API now supports navigation parameters for Commerce Sub-Document items. New Configuration Product Administration REST APIs Get List of All Product Families Catalog Definitions Get an All Product Families Catalog Definition Get List of Product Family Catalog Definitions Get a Product Family Catalog Definition Get List of Product Line Catalog Definitions Get a Product Line Catalog Definition Get List of Model Catalog Definitions Get a Model Catalog Definition Get List of All Product Families Attribute Definitions Get an All Product Families Attribute Definition Get List of Product Family Attribute Definitions Get a Product Family Attribute Definition Get List of Product Line Attribute Definitions Get a Product Line Attribute Definition Get List of Model Attribute Definitions Get a Model Attribute Definition Get List of All Product Families Menu Item Definitions Get an All Product Families Menu Item Definition Get List of Product Family Menu Item Definitions Get a Product Family Menu Item Definition Get List of Product Line Menu Item Definitions Get a Product Line Menu Item Definition Get List of Model Menu Item Definitions Get a Model Menu Item Definition Get List of All Product Families Menu Item Image Definitions Get an All Product Families Menu Item Image Definition Get List of Product Family Menu Item Image Definitions Get a Product Family Menu Item Image Definition Get List of Product Line Menu Item Image Definitions Get a Product Line Menu Item Image Definition Get List of Model Menu Item Image Definitions Get a Model Menu Item Image Definition Get List of All Product Families Menu Item Price Definitions Get an All Product Families Menu Item Price Definition Get List of Product Family Menu Item Price Definitions Get a Product Family Menu Item Price Definition Get List of Product Line Menu Item Price Definitions Get a Product Line Menu Item Price Definition Get List of Model Menu Item Price Definitions Get a Model Menu Item Price Definition Get List of BOM Mapping Rules Get a BOM Mapping Rule Create a BOM Mapping Rule Update a BOM Mapping Rule Delete a BOM Mapping Rule Get a List of BOM Mapping Rule Conditions Get a BOM Mapping Rule Condition
Oracle CPQ 22B introduces the following features: Updated REST API version to v14 Added Delete and Export Filtered records information to the applicable Data Table REST APIs New SSO REST APIs Get Single Sign-On Properties Configure Single Sign-On New Sales Groups and Sales Users REST APIs Get List of Sales Users Get Sales User Get List of Sales Groups Get Sales Group New Favorite REST APIs Get User's List of Favorites Get a Favorite Get List of the Selected Options from a Favorite Get Details of a Favorite's Selected Option Update the Favorites Label or Description Delete a List of Favorites Delete a Favorite Copy a List of Favorites to a Folder Copy a Favorite Move a List of Favorites to a Folder Move a Favorite to a Folder Reconfigure a Favorite Get Sharing Settings for a Favorite Update Sharing Settings for a Favorite Remove Myself from a Shared Favorite Get a List of Favorite Folders Get a Favorite Folder Create a Favorite Folder Update a Favorite Folder Delete a Favorite Folder Get Permissions for a Favorite Folder Update or Remove Permissions for a Favorite Folder Get Favorite Process Invocations Invoke Favorite Invoke Add to Cart from Favorites New Shopping Cart REST APIs Get List of All Shopping Carts Get Most Recent Shopping Cart Get Shopping Cart Get Shopping Cart Get All Shopping Cart Items Get Shopping Cart Item Add Selected Items to Quote Check Out the Selected Items Clear All Items from a Shopping Cart Clear Shopping Cart Item Return to Quote Get All Shopping Cart Layouts Get Shopping Cart Layout
v13	Oracle CPQ 21D introduces the following features: Updated REST API version to v13 Consolidated Asset View REST API RTE Template REST APIs Expanded the Usage Metrics REST API web service to provide administrators with easier access to disk space usage information.
v12	Oracle CPQ 21C introduces the Get Usage Metrics REST API
Oracle CPQ 21B introduces the following features: Updated REST API version to v12 Consistent Array Set Prefixes for Configuration Layout and Metadata REST API Responses Remove Key Support for Configuration Array Delete Request
v11	Beginning in Oracle CPQ 21A, we will support the current REST version and the two previous REST versions. Older (three versions back and earlier) REST versions may continue to function; however, Oracle will not address new issues that arise.
The following v11 Web Service features are available in Oracle CPQ 21A: Conversion Units for Float Attributes The v11 Commerce REST APIs provide support for complex objects for Float attributes when conversion units are defined. The following example shows the "length" Float attribute with value of "6" and the "ft" conversion unit. {"length": {"value": 6.0, "unitVarName": "ft"}}
Expanded Domains for Commerce Dynamic Menus The "expandedDomains" and "expandedDomainCriteria" properties can be included in Commerce action and interact REST API requests to return domain information for specified dynamic menu attributes. The "expandedDomains" property is an array of field names that returns an "availableElements" array with expanded domains in the state object response. The "expandedDomainCriteria" property is used to specify document numbers and search text for sub-document dynamic menu attributes. It contains a map for two entries. nodes - The sub-document number of the dynamic menu attribute that is to be expanded. This field is required. searchText - The type in text with which the dynamic menu options should be filtered. This field is optional.
Developer Toolkit REST APIs Oracle CPQ 21A provides REST APIs to support the following Developer Toolkit functions: download, validate, save, and deploy site BML and BMLT (BigMachines Extensible Language Test) files.
Unit Conversion REST APIs The v11 Unit Conversion REST API, delivered in Oracle CPQ 21A, provides support for unit conversion support for Float Attributes.
User Management REST APIs Beginning in Oracle CPQ 21A, new and updated v11 REST APIs expand web service support to manage CPQ users. The following new User Management REST APIs are available: Bulk Update User Status Get Company Users Get User Access Permissions Get User Groups Get User Password Security Question Get Users Import Company Users Update User Access Permissions Update User Groups Update User Password Details The v11 request and response structures for the following existing User Management REST APIs have major changes to provide behavior consistent with the CPQ User Administration UI. These changes also provide support for additional use cases, user access permissions, and user groups. Get Company User Create a Company User Update/Create a Company User Update a Company User
v10	Beginning in Oracle CPQ 20C, the `headlessMode` property replaces the `legacyMode` property in v10 Configuration REST APIs. Note: If you explicitly set the `legacyMode` property in your REST calls, you need to remove the `legacyMode` property from v10 REST calls. If the `legacyMode` property is not removed, you will receive an invalid parameter error.
v9	Oracle CPQ 20B introduces the Migration REST APIs and the following updates: Use the `/rest/v17/tasks/{taskId}`, PATCH method for cancelling tasks such as migration package imports and data table deployments, exports, and imports. The `/rest/v9/tasks/{taskId}/actions/cancel` endpoint is deprecated in Oracle CPQ 20B. Use the `/rest/v17/tasks/{taskId}`, PATCH method to cancel tasks. The Get List of Tasks REST API was introduced in Oracle CPQ 19D to retrieve data table status tasks. Oracle CPQ 20B adds the following categories to support migration tasks: '51' Migration Package import tasks '52' Migration Package export tasks You can use the following category query to list migration tasks: Endpoint: `/rest/v17/tasks/?q={category:{$in:[51,52]}}`
Oracle CPQ 20A introduces the following REST API updates: The Configuration Bulk Add to Transaction REST API now includes the Boolean "legacyMode" request parameter. This boolean parameter determines the API execution behavior. The "`legacyMode`" parameter should be set to "true" if you are using Oracle CPQ Configuration Flows. When true, the API honors Oracle CPQ legacy Configuration Layout Flow behavior, with the relevant attribute values to be overridden as defined in the current Oracle CPQ legacy Configuration Layout Flow. When false, the API does NOT honor Oracle CPQ legacy Configuration Layout Flow and the API will invoke all attributes and rules that are available for the specified model. The default value is 'false'. To reduce the size of the REST API response, HTML attributes are not returned when the delta input parameter is set to 'true' for Oracle CPQ REST API requests version v9 and above. To retrieve HTML attributes when using these versions, set delta to 'false' or do not include delta in the request.
v8	Oracle CPQ 19D introduces the Configuration Bulk Add to Transaction REST API and the following Data Table REST APIs: Get List of Data Tables Get Data Table Properties Create Data Table Delete Data Table Delete Data Tables Deploy Data Tables Export Data Tables Import Data Tables Move Data Tables Update Data Table Properties Get List of Data Table Columns Get Data Table Column Properties Create Data Table Column Delete Data Table Column Delete Data Table Columns Synchronize Data Table Columns Update Data Table Column Properties GET Data Table Data Get Data Table Row Clear Data Table Data Create Data Table Row Delete Data Table Row Delete Data Table Rows Search Data Tables Synchronize Data Table Rows Update Data Table Row Get Data Table Folders Get Data Table Folder Create Data Table Folder Delete Data Table Folder Update Data Table Folder Get Data Table Status Log Tasks Get Status Log Task Cancel Data Table Task Delete Status Log Task Delete Status Log Tasks Get List of Status Log Task Files Download Data Table Task File
Oracle CPQ 19C introduces the following enhancements: The "showParentAttrs=true" query parameter for Configuration attribute and array set metadata REST API endpoints to return all applicable metadata inherited from parent level attributes. For more information refer to Show Parent Attributes Query Parameter. Configuration metadata endpoints to support Product Family Integrations for the JET Configuration UI: Get Product Family Integration Metadata Get Product Family Integrations Metadata Configuration Run-Time Data Configure Model and Reconfigure Model enhancements provide support for ABO Modify, Reconfigure, and Follow-On Order actions. Asset-Based Ordering Support for Configure Models Asset-Based Ordering Support Reconfigure Models The new "_status" object within the "_sysNavigationInfo" resource is a set of Boolean objects that give all the possible states of configuration for the items in the system. For more information refer to System Navigation Status Object. Configure Model In System supports system configuration navigation in the JET Configuration UI.
v8 introduces the following Account REST API services to support integrating and querying external system accounts: Get Account Get Accounts
v8 introduces the following endpoints to provide multi-select support for asset operations: Modify Assets Suspend Assets Resume Assets Renew Assets Terminate Assets v8 provides new transaction support for asset operation REST APIs. When a user invokes an asset operation for an asset without an associated Transaction ID, a new transaction is created and associated with the requested operation. Notes: Administrators must install the 19B ABO Implementation Package to enable new transaction support for asset operations New transaction support is not supported for external applications in Oracle CPQ 19B.
v8 introduces the Configuration Layout & Metadata - Get Recommended Items Metadata REST API v8 introduces the following Configuration Run-Time Data REST APIs: Add Model to Favorites Load Array Set Data Load Configuration Data Reconfigure from Favorites v8 supports updates to the following Configuration Run-Time Data REST APIs: Configure Model added support for the select all property, search result and search flow input parameters on the Configuration page, and the Auto Lock property. Update added support for the search result and search flow input parameters on the Configuration page and the Auto Lock property. Interact added support for the Auto Lock property. Reconfigure Model added the mainDocAction Request Body Parameter.
v8 introduces the following Commerce REST API enhancements to support Collaborative Quoting: The "revsionId" parameter can be included in the request and response body for most Commerce action REST APIs to track changes. Note: The following Commerce actions currently do not accept the revisionId parameter: _dropCache, _send_email, _print_document, _pipelineViewer, and _retrieve_alternate_address. Do not send the revisionId parameter with these actions. The focus object identifies when a user is editing a specific item and is sent with Interact calls. It lists active collaboration users and specifies if a user has locked the focused item.
v7	v7 provides REST API support Transaction Arrays: Transaction Array Support for Commerce Action REST APIs New Array Set and Array Attribute Metadata REST APIs and updates to Commerce Layout and Metadata REST APIs
v7 introduces the following endpoints to support the Commerce pipeline viewer: Transaction Pipeline Viewer Transaction Line Pipeline Viewer
v7 introduces new REST APIs: Configuration Layout & Metadata REST APIs: Layout REST APIs for product families, product lines, and models Configuration Process Invocation Definitions REST APIs for pages and actions Configuration Metadata REST APIs for product families, product lines, models, attributes, array sets, and translations Configuration Run-Time Data REST APIs: Add Configuration Data to Transaction Add from Catalog (Configuration) Add Row to Array Set, Cancel (Configuration) Configuration Integration Configure Model Delete Row from an Array Set Drop Cache (Configuration) Get All Pick List Options Get BOM Items (Configuration) Get Mandatory Models Get Mandatory Parts Get Pick List Options Get Price Books (Configuration) Get Recommended Models Get Recommended Parts Interact (Configuration) Next Configuration Node Previous Configuration Node Process Invocation Reconfigure Model Reconfigure Model from Partner Resume Configuration Save Reconfiguration Start Over Update (Configuration)
v6	v6 introduces the following REST API updates: Commerce interact and action responses will reflect the hidden state for actions that are hidden using Hiding Rules New Fields for Assets configBomInstance REST APIs: assetId, billingAccountId, serviceAccountId, startDate, endDate, amount, and part custom fields Re-sequence Transaction Lines using Interact Search Parts REST API v6 adds eligibility checking and filtering to support the following scenarios: Search parts using Configuration context Search parts using Commerce context Perform a Quick Key part search Search list of part numbers Perform an advanced part search
v6 introduces the following REST API services Calculate Price REST APIs eCommerce Interaction Metrics Eligibility Rules REST APIs Create Eligibility Rule Delete Eligibility Rule Delete Eligibility Rule Deploy Eligibility Rule Deploy Multiple Eligibility Rules Get Eligibility Rule Get Eligibility Rules Update Eligibility Rule Pricebook REST APIs
v6 introduces the following Commerce endpoints Auto-fill Account Information Calculate Transaction Line Price eSignature - Cancel Request eSignature - Request Details eSignature - Send Request Export Attachment from Transaction Navigate Back from Transaction Refresh Transaction
v5	v5 introduces the following REST API updates: Line Item Grid Composite State Attribute - Determine line item grid attribute's visibility (i.e. hidden, shown, read-only) through interact calls Hierarchy Line Item Grid Enhancements - Maintain the product hierarchy of the line item grid during search and sort functions. Partner Information Parameter for New Transaction - v5 services support the "partnerInfo" parameter for New Transaction actions. This parameter contains the "partnerOpportunityId" and "partnerAccountId" parameters. REST Support for Submit Action Approval Related Attributes - When Submit sub-actions are executed, the related attributes for the parent submit action are updated accordingly. Criteria field items can be provided in the request body to retrieve approval related attributes. Support for Country and State Attributes. Support for Language Codes in Language Attributes
v5 introduces the following REST API services: Associate alternate addresses through Commerce REST services. Retrieve Alternate Address Select Alternate Address Message Translations REST API - Allows customers to query Oracle CPQ's resource bundle to retrieve message translations User Management REST APIs: Create User Get User Details Replace User Details Reset User Password Update User
v4	v4 REST API services provide the following enhancements: Additional functions for the Expand Query parameter Optimized translation responses reduces the amount of data returned if translation items contain empty values. When translations are requested, translations that have an empty value for all the properties are not returned Attachment Attribute Support - Provides REST service support to update and retrieve associated file attachments. Users can update files that are associated to file attachment attributes. Users can also retrieve associated file attachments using links that are provided in the REST API response. History Attribute Support - Allows users to retrieve and append entries to History attributes. History attributes capture an input text string along with the user's name and time. Secure Text Attribute Support - In previous versions, secure data attributes returned empty strings. Beginning in v4, masked values are returned when secure data attributes are requested. Summation Attribute Support - Summation is a read only entry that displays a result calculated from other attributes. This feature returns data for summation type of attributes when requested. Transaction Line Total Attribute Support - Provides REST Service support for attribute totals. Users can request total values by using the advanced query object and totals data returns as part of the state object. Query Support for Transaction Line Attributes - Sort and filter support for Transaction Line XML based attributes that are not mapped in data columns. This enhancement supports queries for number, Boolean, string, date, and currency fields. Error Response Support - Allows users to request an error response if errors occur when opening a Transaction Line. The new "errorCriteria" parameter can be used in REST services requests for Open Transaction Line and Back actions. Shared Cache Support - Allows the sharing of a cache instance between a Transaction and Transaction Lines. Cache Refresh Parameter Improved Responses for Interact Functions - A new "delta" parameter is available to request partial transaction responses when cache services are enabled. Enhancements for Submit Actions - Beginning in v4, submit action responses return the data for approval, approval status, and approval history attributes. AJAX Sensitive Parameter
v4 introduces the following REST API services: Commerce REST APIs: Copy to Favorites Navigate Back from Transaction Line Asset Management REST APIs: New "configBomInstance" endpoints expand support for ABO integrations by providing access to configuration and subscription operations. Follow-on Order Get Configuration Instance Modify Asset Reconfigure from Asset Renew Asset Resume Asset Suspend Asset Terminate Asset
v3	v3 provides the following REST API updates: Oracle CPQ introduced the Exclude Field Types request path query to limit returned field types. Refer to Query Parameters for additional request path query parameters. Allow request body inputs for selection, criteria queries, and user cache interaction. These requests are only available for REST APIs with POST methods. Refer to the following topics for additional information: Line Selection Parameter Criteria Parameter Queries State Object Cache Interaction The "numberOfCopies" parameter was introduced for Copy Transaction Lines. Return information necessary for integration with external user interfaces. Refer to the following topics for additional information: Destination URL Currency Type Attribute Menu Attributes State Object Support

Oracle CPQ 24D introduces the following features:

Calculate Price REST API enhancements:
- Renamed the following parameters to align with pricing document attributes:
  - "items" is now "lines"
  - "itemIdentifier" is now "_itemIdentifier"
  - "currencyCode" is now "_currencyCode"
  - "customerId" is now "_customerId"
  - "partNumber" is now "_partNumber"
- Removed "headerAttributeValues" and "itemAttributeValues" objects and included their attributes into their respective parent "pricing-calculatePriceRequest" or "lines" object.
- Consolidated product price attributes under charges
New Commerce REST APIs:
- Create Price Agreement - create a CPQ Price Agreement from the current transaction sales agreement.
- Self Service Checkout - update the quote to a closed phase when an order corresponding to this quote is placed using an external system. By default, this action will put the Quote in Canceled step and External Order status.
Commerce REST API updates:
- New "Stage" Resource Path Parameter for Commerce REST APIs
  The new "Stage" resource parameter provides web service support for transactions in different stages in the Commerce process flow. CPQ automatically generates Commerce endpoints for the Interface Catalog based on your site setup. The new base URL is /rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}. The following stages are available:
  - Documents includes transactions from all stages
  - Quotes includes transactions in the Quote stage
  - Agreements includes transaction is the Agreement stage
  - Orders includes transactions in the Order stage
- Endpoints for modify-type actions now support adding favorites to a transaction.
New Metrics REST API enables customer to retrieve all business metrics for a site.
New Performance Debugger REST API enables customers to collect granular performance logs for Configuration actions, including the timing for associated rules and conditions.
- Create a Performance Debugger Logging Task - create a performance debugger log for the Configuration action identified in the request payload.
- Get All Performance Debugger Records - retrieve a list of performance debugger log records.
- Get a Performance Debugger Record - retrieve the specified performance debugger log record.
New Pricing Agreement Attribute REST APIs to support Sales Agreements
- Get Agreement Attributes - retrieve all agreement attributes.
- Get Agreement Attribute - retrieve the specified agreement attribute.
- Delete Agreement Attribute - delete the specified agreement attribute.
- Get Agreement Attribute Mappings - retrieve attribute mappings for the specified agreement attribute.
- Update Agreement Attribute Mappings - update attribute mappings for the specified agreement attribute.
- Migrate Agreement Charge Attributes - create agreement charge attributes from an existing pricing charge attribute.
New Pricing Bulk Service REST APIs for pricing export, import, and bulk data services using web services.
- Get Price Model Bulk Data Headers - retrieve Price Model attributes to define CSV headers for bulk data service uploads.
- Get Price Model Item Bulk Data Headers - retrieve Price Model Item attributes to define CSV headers for bulk data service uploads.
- Get Rate Plan Bulk Data Headers - retrieve Rate Plan attributes to define CSV headers for bulk data service uploads.
- Get Charge Bulk Data Headers - retrieve Charge attributes to define CSV headers for bulk data service uploads.
- Upload Pricing Bulk Data - bulk upload Oracle CPQ pricing data.
Pricing Setup REST API Enhancements
- Added "scriptingMatrixVariableName" parameter to Price Model endpoints to support Scripting Price Matrices.
- Added "advancedByTemplate" option to the Price Model "listType" parameter to identify Advanced Price Models with Scripting Price Matrices.
- Added "scriptingPriceModel" option to the Pricing Matrix Template "templateType" parameter to identify Advanced Price Models with Scripting Price Matrices.
- Pricing Attribute endpoints will now support Charge Attributes.
- Added "ioType" parameter to Pricing Attributes and Charge Attribute endpoints to identify if an attribute is an input, output, internal, or external.
- Added "sourceEntity" and "validMapping" parameters to Pricing Attributes and Charge Attribute mapping endpoints.

v16

Oracle CPQ 24C introduces the following features:

New Collaborative Quote Queue REST APIs to manage the collaborative queue:
- Get Collaborative Quote Queue
- Clear Collaborative Queue
New Commerce REST APIs:
- Get Archived Transactions - retrieve a list of archived transactions.
- Delete Archived Transactions - delete the specified archived transactions.
- Restore Archived Transactions - restore the specified archived transactions.
- Copy Sequence - retrieve copy sequences for the Commerce process.
- Forward Transactions - forward selected transactions to the specified users and/or groups.
- Email Transaction - Commerce process level action to format, merge, and email a transaction.
- Print Transaction - Commerce process level action to format, merge, and print a transaction.
- Accept Quote - accept the quote for the specified transaction.
- Get Transaction Comment - retrieve the specified transaction comment.
- Get Transaction Comments - retrieve comments for the specified transaction.
- Publish Quote - notify the self-service channel that the quote is ready for review for customer/buyer.
- Request Quote Revision - request quote revision for the specified transaction.
Commerce REST API enhancements to support accept process level email & print actions and copy sequence specifications.
Endpoints for modify-type actions now support adding unconfigured models to a transaction.
New BOM Item Administration APIs to support the simple configurator for BOM hierarchies
- Generate Configurator
- Get Related Configurator
New Groups REST API to support host company and partner organizations endpoints.
New Pricing Item REST APIs to support the pricing items:
- Get and Search Price Items(s)
- Get, Add, Update, and Delete Price Item Charge Groups
- Get, Add, Update, and Delete Price Item Charge Group Charges
- Get, Add, Update, and Delete Price Item Charge Group Rate Plans
- Get, Add, Update, and Delete Price Item Charge Group Rate Plan Charges
New Price Agreement and Price Model endpoints to support matrix grids:
Pricing Setup REST API enhancements:
- The Price Setup endpoints now include Created By and Last Modified objects to record user details for pricing items to support SOX compliance in CPQ pricing.
- The Price Agreement endpoints now include the Source Transaction ID and Status attributes to support sales agreement authoring in CPQ pricing.
- The Pricing Option REST APIs are updated to support new pricing options: Enable incremental pricing in quoting, Enable Pricing Portal Administration Logging, and Pricing Scripts for Before and After Pricing Engine Execution
New Product Search REST APIs to search and retrieve CPQ products. Products consist of both stand-alone parts and product structures (i.e. BOM hierarchies).
New Sales Company endpoints:

Oracle CPQ 24B introduces the following features:

Get Commerce Settings - returns Commerce Settings and applicable General Site settings.
New Commerce REST API endpoint: Group Transactions - returns a list of transaction grouped by columns specified in the request.
New Company REST API endpoints for retrieving, adding, and updating host company and partner organization data including support for company style sheets and translations.
The new Saved Search REST APIs support the new Quotes List page. Grouping and keyword searches are supported for applicable endpoints.
- Create a Saved Search
- Delete a Saved Search
- Get a Saved Search
- Get Saved Searches
- Update a Saved Search
- Update Saved Search Access Permissions
- Update Site Default Saved Search
- Update User Default Saved Search
New data store endpoints for the Extract Data REST API allow a customer to identify data stores (i.e., objects) and data store attributes that can be extracted from CPQ. Customers can also use available data store attributes to define criteria to extract data from the specified data store.
New Global Branding endpoint to retrieve the global branding properties for a site.
New Global Dictionary endpoints to retrieve, add, update, or delete the values in the global dictionary defined for a site.
New Pricing Setup endpoints to support new pricing functionality:
- Price Agreements - These endpoints enable administration of CPQ Price Agreements, Price Agreement Items, Price Agreement stand-alone Charges, Price Agreement Rate Plans, and Price Agreement Rate Plan Charges using REST API services.
- Pricing Matrices and Pricing Matrix Templates - These endpoints enable administration of Pricing Matrices and Pricing Matrix Templates using REST API services.
- Pricing Previews - These endpoints enable administration of Pricing Previews using REST API services. They retrieve the pricing attribute values and pricing line items associated with a Commerce transaction.
New User Navigation Links REST API endpoint to retrieve the user navigation links defined in the Navigation Menu for a site.

Oracle CPQ 24A introduces the following features:

To optimize Commerce rules evaluation, CPQ introduced a new request parameter for Commerce Modify Action REST endpoints. When the "skipRules": ["HIDING"] parameter is included the request body during action invocation, Hiding Rules will not be evaluated. This parameter can be used with the endpoint for any Modify type action.
New Commerce REST API endpoints:
Return consolidated list of Product Family, Product Line, and Model attribute metadata from a Configuration layout.
- Get Configuration Layout Attribute Data
New Product Administration endpoints to enable administration of single select and multi-select menu items using REST API web services. These endpoints provide functions for All Product Families, Product Family, and Model menu items, menu item images, menu item prices, and menu item translations.
- Update a Menu Item
- Delete a Menu Item
- Remove a Menu Item Override
- Add a Menu Item Image
- Delete a Menu Item Image
- Update a Menu Item Image
- Add a Menu Item Price
- Delete a Menu Item Price
- Update a Menu Item Price
- Add Menu Item Translation
- Delete a Menu Item Translation
- Update a Menu Item Translation
User Line Item Grid User Personalization.

v15

Oracle CPQ 23D introduces the following features:

The Last Deploy Date of the product family is added to the Configure Model REST API response when Configuration cache is enabled to allow customers to validate if a local cache instance is up to date with the most current Configuration layout updates.
BOM Mapping REST API enhancements:
- Root BOM Item Label” and “Root BOM Item Part Number” are now included in the BOM Item Definition instance and collection responses.
- Case insensitive queries can now be performed on the BOM Item Setups collection.
- New Upsert BOM Item List endpoint added to create, update, or delete CPQ BOM hierarchies using a list format.
The Calculate Price REST API is updated to support Charges and Rate Plans.
Configuration Product Administration REST API enhancements
- Added Deploy a Product Family and Get Undeployed Data Tables endpoints to support Product Family Deployment.
- Added Get, Add, Update, and Delete Configuration Actions (including Configuration Action Translations).
Added the Commerce Get History endpoint to retrieve historical changes for a transaction.
The following new migration package and migration resource REST API web services are supported:
- Get Migration Package Content Dependencies
- Get Dependencies for Selected Migration Resources or Migration Package from Source Site
- Migrate Selected Migration Resources or Migration Package from Source Site
- Add Util Library Namespaces to Migration Package REST APIs to aid in package lifecycle management. The unique namespace can be applied when creating, updating, or searching migration package resources.
- Specify granular (low-level) content in the request payload while creating or updating a migration package.
Pricing Setup REST enhancements:
- Added the following REST API web services to support the Rate Plan business object and pricing integration:
  - Submit Fusion Pricing Synchronization Task
  - Get, Add, Update, and Delete Charge Attributes
  - Get, Add, Update, and Delete Charge Definitions
  - Get, Search, Add, and Delete Price Model Items
  - Get, Add, Update, and Delete Charges, Rate Plans, and Rate Plan Charges
  - Get, Add, Update, and Delete Rate Cards and Rate Card Templates
- Added the Enable Charge Definition option to Pricing Options endpoints.
- Added Dynamic Pricing Type property to Price Model Pricing Data endpoints
- Oracle CPQ 23D removes support or limits the following existing endpoints:
  - Add Price Model Pricing Data (Replaced with Add a Price Model Item)
  - Delete a Price Model Pricing Data Item (Replaced with Delete a Price Model Item)
  - Update a Price Model Pricing Data Item (Replaced with Update a Price Model Item)

v14

Oracle CPQ 23C introduces the following features:

Updated the Calculate Price REST API to support multiple charges and product launch. Beginning in Oracle CPQ 23C, customers can use this web service to calculate and return both product prices and any charges defined in Pricing Engine.
Added pricing charges to the following endpoints to support multiple charges in Configuration Run-Time Data REST API.
- Get BOM Items (Configuration)
- Configure Model
- Configure Model in System
- Next Configuration Node
- Reconfigure from Favorites
- Reconfigure Model
- Resume Configuration
- Update Configuration
New Extract Data REST API to manage CPQ data extraction for FAW.
- Request Data Extract
- Get Site Status for Data Extract
- Get Data Extract Task Status
- Cancel Data Extract Task
New Migration Package REST API endpoints to aid administrators in the creation, distribution, and deployment of migration packages to different environments and Migration Resources endpoints retrieve the data source entities that are required for successful migration. The following migration package and migration resources web services are available:
- Create a Migration Package
- Update a Migration Package
- Delete a Migration Package
- Get All Migration Package Content
- Get Migration Package Category Content
- Get Migration Package Resource Low-level Details
- Update Migration Package Content
- Update Migration Package Resource Low-Level Details
- Version a Migration Package
- Migrate Package
- Upload Zip File for a Migration Package
- Get All Migration Resources
- Get Category Migration Resources
- Get Category Resource Low-level Details
Updated the Parts REST APIs to include the variable name of the root BOM item, part configurable flag, and product status to support Product Launch.
Introduced the Update/Insert action for the Parts Setup REST API to update or create CPQ Parts.
New Pricing Setup REST API endpoints to support pricing lookups for charges:
- Add a Pricing Lookup Type
- Add a Pricing Lookup Value
- Delete a Pricing Lookup Type
- Delete a Pricing Lookup Value
- Get a Pricing Lookup Type
- Get a Pricing Lookup Value
- Get All Pricing Lookup Types
- Get All Pricing Lookup Values
- Update a Pricing Lookup Type
- Update a Pricing Lookup Value
- Update Pricing Lookup Types
- Update Pricing Lookup Values
Added a PATCH method to the SCIM-Compliant User Management REST API which allows administrators to update a user record instead of fully replacing the record.

Oracle 23B introduces the following features:

New Part Setup REST APIs to enable administration of CPQ parts using REST API services.
- Get All Parts
- Get a Part
- Create a Part
- Update a Part
- Delete a Part
- Get Part Metadata Action
- Get Part Extended Descriptions
- Get Part Extended Descriptions Using Extended Descriptions Id
- Create Part Extended Descriptions
- Update Part Extended Descriptions
- Get All Prices for a Part
- Get a Part Price
- Create a Part Prices
- Update a Part Price
- Delete a Part Price
- Get All Translations for a Part
- Get a Part Translation
- Create a Part Translation
- Delete a Part Translation
- Get All Part Extended Description Translations
- Get Part Extended Description Translations
- Create Part Extended Description Translations
- Delete a Part Extended Description Translations
New Company REST API to get company information.
Calculate Price REST API and Get, Add, and Update Pricing Data for a Price Model REST APIs have been enhanced to support handling of BOM Item product pricing.
Added new functions for the Pricing Setup REST API to manage pricing-related settings in CPQ Pricing Engine.
- Get All Pricing Options
- Update Pricing Options
Added new User REST APIs that are compliant with the System for Cross-domain Identity Management (SCIM) specification. The SCIM specification is an open standard that facilitates managing user identities across cloud-based applications and services. These endpoints retrieve user details and perform actions to create, update, or inactivate a user.

Oracle 23A introduces the following features:

The Get BOM Tree REST API will include the following parameters:
- "treeHasModel" – This response parameter will be included for root BOM items only, and will indicate if the root item has any child models.
- "isModel" – This parameter will be included for all BOM items to indicate if the current item is a model.
New Validate a Part for BOM endpoint to validate parts for BOM mapping implementations.
New Parts REST API endpoints to view a specific part or an unfiltered list of all parts. All new and existing endpoints for Parts REST API are read-only; parts cannot be added, modified, or deleted using these web services. Get All Parts Get a Part
New Pricing Setup REST APIs
- Add a Customer-Specific Condition for a Pricing Rule
- Add a Price Model
- Add a Pricing Attribute
- Add a Pricing Rule
- Add Mapping Data for a Pricing Attribute
- Add Pricing Data for a Price Model
- Delete a Customer-Specific Condition for a Pricing Rule
- Delete a Price Model
- Delete a Pricing Attribute
- Delete a Pricing Rule
- Delete Pricing Data for a Price Model
- Get a Customer-Specific Condition for a Pricing Rule
- Get a Price Model
- Get a Pricing Attribute
- Get a Pricing Rule
- Get All Customer-Specific Conditions for a Pricing Rule
- Get All Price Models
- Get All Price Models Linked to a Pricing Rule
- Get All Pricing Attributes
- Get All Pricing Rules
- Get Lookups for a Currency
- Get Lookups for a Data Source's Attributes
- Get Lookups for a Part
- Get Lookups for All Accounts
- Get Lookups for All Simple Condition Attributes
- Get Lookups for All Supported Currencies
- Get Lookups for All Supported Data Sources
- Get Lookups for an Account
- Get Mapping Data for a Pricing Attribute
- Get Pricing Data for a Price Model
- Link a Price Model to Pricing Rule
- Unlink a Price Model from a Pricing Rule
- Update a Customer-Specific Condition for a Pricing Rule
- Update a Price Model
- Update a Price Model Linked to a Pricing Rule
- Update a Pricing Attribute
- Update a Pricing Rule
- Update Customer-Specific Conditions for a Pricing Rule
- Update Mapping Data for a Pricing Attribute
- Update Price Models
- Update Price Models Linked to Pricing Rule
- Update Pricing Attributes
- Update Pricing Data for a Price Model
- Update Pricing Rules

Oracle CPQ 22D introduces the following features:

New BOM Mapping REST APIs
- Get All BOM Item Definitions
- Get a BOM Item Definition
- Get All BOM Item Child Definitions for a Parent BOM Item
- Get a BOM Item Child Definition for a Parent BOM Item
- Create a BOM Item Definition
- Delete a BOM Item Definition
- Update a BOM Item Definition
- Get All BOM Item Mappings for a Parent BOM Item
- Get a BOM Item Mapping for a Parent BOM Item
- Create a BOM Item Mapping for a Parent BOM Item
- Delete a BOM Mapping for a Parent BOM Item
- Update a BOM Item Mapping for a Parent BOM Item
- Get a BOM Item Tree and BOM Item Mappings
- Create a BOM Item Tree and BOM Item Mappings
- Update a BOM Item Tree and BOM Item Mappings
New Certificates REST APIs
- Get List of All Certificates
- Get a Certificate
New Integration Vendors REST APIs
- Get List of Integrations
- Get an Integration
- Create an Integration
- Delete an Integration
- Update an Integration

Oracle 22C introduces the following features:

The Open Transaction Line REST API now supports navigation parameters for Commerce Sub-Document items.
New Configuration Product Administration REST APIs
- Get List of All Product Families Catalog Definitions
- Get an All Product Families Catalog Definition
- Get List of Product Family Catalog Definitions
- Get a Product Family Catalog Definition
- Get List of Product Line Catalog Definitions
- Get a Product Line Catalog Definition
- Get List of Model Catalog Definitions
- Get a Model Catalog Definition
- Get List of All Product Families Attribute Definitions
- Get an All Product Families Attribute Definition
- Get List of Product Family Attribute Definitions
- Get a Product Family Attribute Definition
- Get List of Product Line Attribute Definitions
- Get a Product Line Attribute Definition
- Get List of Model Attribute Definitions
- Get a Model Attribute Definition
- Get List of All Product Families Menu Item Definitions
- Get an All Product Families Menu Item Definition
- Get List of Product Family Menu Item Definitions
- Get a Product Family Menu Item Definition
- Get List of Product Line Menu Item Definitions
- Get a Product Line Menu Item Definition
- Get List of Model Menu Item Definitions
- Get a Model Menu Item Definition
- Get List of All Product Families Menu Item Image Definitions
- Get an All Product Families Menu Item Image Definition
- Get List of Product Family Menu Item Image Definitions
- Get a Product Family Menu Item Image Definition
- Get List of Product Line Menu Item Image Definitions
- Get a Product Line Menu Item Image Definition
- Get List of Model Menu Item Image Definitions
- Get a Model Menu Item Image Definition
- Get List of All Product Families Menu Item Price Definitions
- Get an All Product Families Menu Item Price Definition
- Get List of Product Family Menu Item Price Definitions
- Get a Product Family Menu Item Price Definition
- Get List of Product Line Menu Item Price Definitions
- Get a Product Line Menu Item Price Definition
- Get List of Model Menu Item Price Definitions
- Get a Model Menu Item Price Definition
- Get List of BOM Mapping Rules
- Get a BOM Mapping Rule
- Create a BOM Mapping Rule
- Update a BOM Mapping Rule
- Delete a BOM Mapping Rule
- Get a List of BOM Mapping Rule Conditions
- Get a BOM Mapping Rule Condition

Oracle CPQ 22B introduces the following features:

Updated REST API version to v14
Added Delete and Export Filtered records information to the applicable Data Table REST APIs
New SSO REST APIs
- Get Single Sign-On Properties
- Configure Single Sign-On
New Sales Groups and Sales Users REST APIs
- Get List of Sales Users
- Get Sales User
- Get List of Sales Groups
- Get Sales Group
New Favorite REST APIs
- Get User's List of Favorites
- Get a Favorite
- Get List of the Selected Options from a Favorite
- Get Details of a Favorite's Selected Option
- Update the Favorites Label or Description
- Delete a List of Favorites
- Delete a Favorite
- Copy a List of Favorites to a Folder
- Copy a Favorite
- Move a List of Favorites to a Folder
- Move a Favorite to a Folder
- Reconfigure a Favorite
- Get Sharing Settings for a Favorite
- Update Sharing Settings for a Favorite
- Remove Myself from a Shared Favorite
- Get a List of Favorite Folders
- Get a Favorite Folder
- Create a Favorite Folder
- Update a Favorite Folder
- Delete a Favorite Folder
- Get Permissions for a Favorite Folder
- Update or Remove Permissions for a Favorite Folder
- Get Favorite Process Invocations
- Invoke Favorite
- Invoke Add to Cart from Favorites
New Shopping Cart REST APIs
- Get List of All Shopping Carts
- Get Most Recent Shopping Cart
- Get Shopping Cart
- Get Shopping Cart
- Get All Shopping Cart Items
- Get Shopping Cart Item
- Add Selected Items to Quote
- Check Out the Selected Items
- Clear All Items from a Shopping Cart
- Clear Shopping Cart Item
- Return to Quote
- Get All Shopping Cart Layouts
- Get Shopping Cart Layout

v13

Oracle CPQ 21D introduces the following features:

Updated REST API version to v13
Consolidated Asset View REST API
RTE Template REST APIs
Expanded the Usage Metrics REST API web service to provide administrators with easier access to disk space usage information.

v12 Oracle CPQ 21C introduces the Get Usage Metrics REST API

Oracle CPQ 21B introduces the following features:

Updated REST API version to v12
Consistent Array Set Prefixes for Configuration Layout and Metadata REST API Responses
Remove Key Support for Configuration Array Delete Request

v11 Beginning in Oracle CPQ 21A, we will support the current REST version and the two previous REST versions. Older (three versions back and earlier) REST versions may continue to function; however, Oracle will not address new issues that arise.

The following v11 Web Service features are available in Oracle CPQ 21A:

Conversion Units for Float Attributes

The v11 Commerce REST APIs provide support for complex objects for Float attributes when conversion units are defined. The following example shows the "length" Float attribute with value of "6" and the "ft" conversion unit.
```
{"length": {"value": 6.0, "unitVarName": "ft"}}
```

Expanded Domains for Commerce Dynamic Menus

The "expandedDomains" and "expandedDomainCriteria" properties can be included in Commerce action and interact REST API requests to return domain information for specified dynamic menu attributes.
- The "expandedDomains" property is an array of field names that returns an "availableElements" array with expanded domains in the state object response.
- The "expandedDomainCriteria" property is used to specify document numbers and search text for sub-document dynamic menu attributes. It contains a map for two entries.
  - nodes - The sub-document number of the dynamic menu attribute that is to be expanded. This field is required.
  - searchText - The type in text with which the dynamic menu options should be filtered. This field is optional.

Developer Toolkit REST APIs

Oracle CPQ 21A provides REST APIs to support the following Developer Toolkit functions: download, validate, save, and deploy site BML and BMLT (BigMachines Extensible Language Test) files.

Unit Conversion REST APIs

The v11 Unit Conversion REST API, delivered in Oracle CPQ 21A, provides support for unit conversion support for Float Attributes.

User Management REST APIs
Beginning in Oracle CPQ 21A, new and updated v11 REST APIs expand web service support to manage CPQ users. The following new User Management REST APIs are available:
- Bulk Update User Status
- Get Company Users
- Get User Access Permissions
- Get User Groups
- Get User Password Security Question
- Get Users
- Import Company Users
- Update User Access Permissions
- Update User Groups
- Update User Password Details
The v11 request and response structures for the following existing User Management REST APIs have major changes to provide behavior consistent with the CPQ User Administration UI. These changes also provide support for additional use cases, user access permissions, and user groups.
- Get Company User
- Create a Company User
- Update/Create a Company User
- Update a Company User

v10

Beginning in Oracle CPQ 20C, the headlessMode property replaces the legacyMode property in v10 Configuration REST APIs.

Note: If you explicitly set the legacyMode property in your REST calls, you need to remove the legacyMode property from v10 REST calls. If the legacyMode property is not removed, you will receive an invalid parameter error.

Oracle CPQ 20B introduces the Migration REST APIs and the following updates:

Use the /rest/v17/tasks/{taskId}, PATCH method for cancelling tasks such as migration package imports and data table deployments, exports, and imports.

The /rest/v9/tasks/{taskId}/actions/cancel endpoint is deprecated in Oracle CPQ 20B. Use the /rest/v17/tasks/{taskId}, PATCH method to cancel tasks.
The Get List of Tasks REST API was introduced in Oracle CPQ 19D to retrieve data table status tasks. Oracle CPQ 20B adds the following categories to support migration tasks:
- '51' Migration Package import tasks
- '52' Migration Package export tasks
You can use the following category query to list migration tasks:
- Endpoint: /rest/v17/tasks/?q={category:{$in:[51,52]}}

Oracle CPQ 20A introduces the following REST API updates:

The Configuration Bulk Add to Transaction REST API now includes the Boolean "legacyMode" request parameter. This boolean parameter determines the API execution behavior.

The "legacyMode" parameter should be set to "true" if you are using Oracle CPQ Configuration Flows.
- When true, the API honors Oracle CPQ legacy Configuration Layout Flow behavior, with the relevant attribute values to be overridden as defined in the current Oracle CPQ legacy Configuration Layout Flow.
- When false, the API does NOT honor Oracle CPQ legacy Configuration Layout Flow and the API will invoke all attributes and rules that are available for the specified model. The default value is 'false'.
To reduce the size of the REST API response, HTML attributes are not returned when the delta input parameter is set to 'true' for Oracle CPQ REST API requests version v9 and above. To retrieve HTML attributes when using these versions, set delta to 'false' or do not include delta in the request.

Oracle CPQ 19D introduces the Configuration Bulk Add to Transaction REST API and the following Data Table REST APIs:

Get List of Data Tables
Get Data Table Properties
Create Data Table
Delete Data Table
Delete Data Tables
Deploy Data Tables
Export Data Tables
Import Data Tables
Move Data Tables
Update Data Table Properties
Get List of Data Table Columns
Get Data Table Column Properties
Create Data Table Column
Delete Data Table Column
Delete Data Table Columns
Synchronize Data Table Columns
Update Data Table Column Properties
GET Data Table Data
Get Data Table Row

Clear Data Table Data
Create Data Table Row
Delete Data Table Row
Delete Data Table Rows
Search Data Tables
Synchronize Data Table Rows
Update Data Table Row
Get Data Table Folders
Get Data Table Folder
Create Data Table Folder
Delete Data Table Folder
Update Data Table Folder
Get Data Table Status Log Tasks
Get Status Log Task
Cancel Data Table Task
Delete Status Log Task
Delete Status Log Tasks
Get List of Status Log Task Files
Download Data Table Task File

Oracle CPQ 19C introduces the following enhancements:

The "showParentAttrs=true" query parameter for Configuration attribute and array set metadata REST API endpoints to return all applicable metadata inherited from parent level attributes. For more information refer to Show Parent Attributes Query Parameter.
Configuration metadata endpoints to support Product Family Integrations for the JET Configuration UI:
- Get Product Family Integration Metadata
- Get Product Family Integrations Metadata
Configuration Run-Time Data Configure Model and Reconfigure Model enhancements provide support for ABO Modify, Reconfigure, and Follow-On Order actions.
- Asset-Based Ordering Support for Configure Models
- Asset-Based Ordering Support Reconfigure Models
The new "_status" object within the "_sysNavigationInfo" resource is a set of Boolean objects that give all the possible states of configuration for the items in the system. For more information refer to System Navigation Status Object.
Configure Model In System supports system configuration navigation in the JET Configuration UI.

v8 introduces the following Account REST API services to support integrating and querying external system accounts:

Get Account
Get Accounts

v8 introduces the following endpoints to provide multi-select support for asset operations:

v8 provides new transaction support for asset operation REST APIs. When a user invokes an asset operation for an asset without an associated Transaction ID, a new transaction is created and associated with the requested operation.
Notes:
- Administrators must install the 19B ABO Implementation Package to enable new transaction support for asset operations
- New transaction support is not supported for external applications in Oracle CPQ 19B.

v8 introduces the Configuration Layout & Metadata - Get Recommended Items Metadata REST API
v8 introduces the following Configuration Run-Time Data REST APIs:
v8 supports updates to the following Configuration Run-Time Data REST APIs:
- Configure Model added support for the select all property, search result and search flow input parameters on the Configuration page, and the Auto Lock property.
- Update added support for the search result and search flow input parameters on the Configuration page and the Auto Lock property.
- Interact added support for the Auto Lock property.
- Reconfigure Model added the mainDocAction Request Body Parameter.

v8 introduces the following Commerce REST API enhancements to support Collaborative Quoting:

The "revsionId" parameter can be included in the request and response body for most Commerce action REST APIs to track changes.

Note: The following Commerce actions currently do not accept the revisionId parameter: _dropCache, _send_email, _print_document, _pipelineViewer, and _retrieve_alternate_address. Do not send the revisionId parameter with these actions.
The focus object identifies when a user is editing a specific item and is sent with Interact calls. It lists active collaboration users and specifies if a user has locked the focused item.

v7 provides REST API support Transaction Arrays:

v7 introduces the following endpoints to support the Commerce pipeline viewer:

v7 introduces new REST APIs:

Configuration Layout & Metadata REST APIs:
- Layout REST APIs for product families, product lines, and models
- Configuration Process Invocation Definitions REST APIs for pages and actions
- Configuration Metadata REST APIs for product families, product lines, models, attributes, array sets, and translations
Configuration Run-Time Data REST APIs:
- Add Configuration Data to Transaction
- Add from Catalog (Configuration)
- Add Row to Array Set,
- Cancel (Configuration)
- Configuration Integration
- Configure Model
- Delete Row from an Array Set
- Drop Cache (Configuration)
- Get All Pick List Options
- Get BOM Items (Configuration)
- Get Mandatory Models
- Get Mandatory Parts
- Get Pick List Options
- Get Price Books (Configuration)
- Get Recommended Models
- Get Recommended Parts
- Interact (Configuration)
- Next Configuration Node
- Previous Configuration Node
- Process Invocation
- Reconfigure Model
- Reconfigure Model from Partner
- Resume Configuration
- Save Reconfiguration
- Start Over
- Update (Configuration)

v6 introduces the following REST API updates:

Commerce interact and action responses will reflect the hidden state for actions that are hidden using Hiding Rules
New Fields for Assets configBomInstance REST APIs: assetId, billingAccountId, serviceAccountId, startDate, endDate, amount, and part custom fields
Re-sequence Transaction Lines using Interact
Search Parts REST API
v6 adds eligibility checking and filtering to support the following scenarios:
- Search parts using Configuration context
- Search parts using Commerce context
- Perform a Quick Key part search
- Search list of part numbers
- Perform an advanced part search

v6 introduces the following REST API services

Calculate Price REST APIs
eCommerce Interaction Metrics
Eligibility Rules REST APIs
- Create Eligibility Rule
- Delete Eligibility Rule
- Delete Eligibility Rule
- Deploy Eligibility Rule
- Deploy Multiple Eligibility Rules
- Get Eligibility Rule
- Get Eligibility Rules
- Update Eligibility Rule
Pricebook REST APIs

v6 introduces the following Commerce endpoints

v5 introduces the following REST API updates:

Line Item Grid Composite State Attribute - Determine line item grid attribute's visibility (i.e. hidden, shown, read-only) through interact calls
Hierarchy Line Item Grid Enhancements - Maintain the product hierarchy of the line item grid during search and sort functions.
Partner Information Parameter for New Transaction - v5 services support the "partnerInfo" parameter for New Transaction actions. This parameter contains the "partnerOpportunityId" and "partnerAccountId" parameters.
REST Support for Submit Action Approval Related Attributes - When Submit sub-actions are executed, the related attributes for the parent submit action are updated accordingly. Criteria field items can be provided in the request body to retrieve approval related attributes.
Support for Country and State Attributes.
Support for Language Codes in Language Attributes

v5 introduces the following REST API services:

Associate alternate addresses through Commerce REST services.
- Retrieve Alternate Address
- Select Alternate Address
Message Translations REST API - Allows customers to query Oracle CPQ's resource bundle to retrieve message translations

User Management REST APIs:
- Create User
- Get User Details
- Replace User Details
- Reset User Password
- Update User

v4 REST API services provide the following enhancements:

Additional functions for the Expand Query parameter
Optimized translation responses reduces the amount of data returned if translation items contain empty values. When translations are requested, translations that have an empty value for all the properties are not returned
Attachment Attribute Support - Provides REST service support to update and retrieve associated file attachments. Users can update files that are associated to file attachment attributes. Users can also retrieve associated file attachments using links that are provided in the REST API response.
History Attribute Support - Allows users to retrieve and append entries to History attributes. History attributes capture an input text string along with the user's name and time.
Secure Text Attribute Support - In previous versions, secure data attributes returned empty strings. Beginning in v4, masked values are returned when secure data attributes are requested.
Summation Attribute Support - Summation is a read only entry that displays a result calculated from other attributes. This feature returns data for summation type of attributes when requested.
Transaction Line Total Attribute Support - Provides REST Service support for attribute totals. Users can request total values by using the advanced query object and totals data returns as part of the state object.
Query Support for Transaction Line Attributes - Sort and filter support for Transaction Line XML based attributes that are not mapped in data columns. This enhancement supports queries for number, Boolean, string, date, and currency fields.
Error Response Support - Allows users to request an error response if errors occur when opening a Transaction Line. The new "errorCriteria" parameter can be used in REST services requests for Open Transaction Line and Back actions.
Shared Cache Support - Allows the sharing of a cache instance between a Transaction and Transaction Lines.
Cache Refresh Parameter
Improved Responses for Interact Functions - A new "delta" parameter is available to request partial transaction responses when cache services are enabled.
Enhancements for Submit Actions - Beginning in v4, submit action responses return the data for approval, approval status, and approval history attributes.
AJAX Sensitive Parameter

v4 introduces the following REST API services:

Commerce REST APIs:
- Copy to Favorites
- Navigate Back from Transaction Line

Asset Management REST APIs:
New "configBomInstance" endpoints expand support for ABO integrations by providing access to configuration and subscription operations.

v3 provides the following REST API updates:

Oracle CPQ introduced the Exclude Field Types request path query to limit returned field types.
Refer to Query Parameters for additional request path query parameters.
Allow request body inputs for selection, criteria queries, and user cache interaction. These requests are only available for REST APIs with POST methods. Refer to the following topics for additional information:
The "numberOfCopies" parameter was introduced for Copy Transaction Lines.
Return information necessary for integration with external user interfaces. Refer to the following topics for additional information:

REST API Version Updates

Overview

Related Topics