Commerce REST API Updates and Enhancements

Oracle CPQ 24D provides the following 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

Add Favorites Support

Beginning in Oracle CPQ 24D, favorite items can be added to using Commerce modify type actions (e.g. Save Transaction, Update Transaction Lines) REST API web services.

Sample Request for Commerce modify type action

Add Favorites REST API example

These Commerce REST API enhancements provide web service support for Commerce process stages and sales agreements.

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.