New Pricing Setup REST APIs

Oracle CPQ 24C introduces new Pricing Setup endpoints to support Product Workbench price items and Price Model/Price Agreement pricing matrices.

Price Items

The new Price Item endpoints support pricing products and BOM items from the Product Workbench. A Price Item can represent a single product/part or a product structure/BOM.

Get Price Items

Use this endpoint to retrieve a list of price items. Provide search criteria parameters in the path to filter the results returned.

  • Endpoint: /rest/v16/pricingSetup/priceItems
  • Method:  GET

Add Price Item to a Charge Group

Use this endpoint to associate a price item to a charge group.

  • Endpoint: /rest/v16/pricingSetup/priceItems/actions/addItemToChargeGroup
  • Method:  POST

Search Price Items

Use this endpoint to search price items. Provide search criteria parameters in the request body to filter the results returned.

  • Endpoint: /rest/v16/pricingSetup/priceItems/actions/search
  • Method:  POST

Get a Price Item

Use this endpoint to retrieve the specified price item.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}
  • Method:  GET

Get All Price Item Charge Groups

Use this endpoint to retrieve all charge groups for the specified price item.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups
  • Method:  GET

Add a Price Item Charge Group

Use this endpoint to create a price item charge group. Note: This adds a new price model to the default price rule.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups
  • Method:  POST

Get a Price Item Charge Group

Use this endpoint to retrieve the specified price item charge group.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}
  • Method:  GET

Link or Unlink a Charge Group with a Price Item

Use this endpoint to link or unlink the charge group with the price item by setting the linked property.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}
  • Method:  PATCH

Get All Price Item Charge Group Charges

Use this endpoint to retrieve all charges for the specified price item charge group.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges
  • Method:  GET

Add a Price Item Charge Group Charge

Use this endpoint to create a price item charge group charge.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges
  • Method:  POST

Update Price Item Charge Group Charges

Use this endpoint to update price item charge group charges.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges
  • Method:  PATCH

Get a Price Item Charge Group Charge

Use this endpoint to retrieve the specified price item charge group charge.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges/{id}
  • Method:  GET

Delete a Price Item Charge Group Charge

Use this endpoint to delete the specified price item charge group charge.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges/{id}
  • Method:  DELETE

Update a Price Item Charge Group Charge

Use this endpoint to update the specified price item charge group charge.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges/{id}
  • Method:  PATCH

Get All Price Item Charge Group Rate Plans

Use this endpoint to retrieve all rate plans associated to the specified price item charge group.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans
  • Method:  GET

Add a Price Item Charge Group Rate Plan

Use this endpoint to create a price item charge group rate plan.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans
  • Method:  POST

Update Price Item Charge Group Rate Plans

Use this endpoint to update price item charge group rate plans.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans
  • Method:  PATCH

Get a Price Item Charge Group Rate Plan

Use this endpoint to retrieve the specified price item charge group rate plan.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}
  • Method:  GET

Delete a Price Item Charge Group Rate Plan

Use this endpoint to delete the specified price item charge group rate plan.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}
  • Method:  DELETE

Update a Price Item Charge Group Rate Plan

Use this endpoint to update the specified price item charge group rate plan.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}
  • Method:  PATCH

Get All Price Item Charge Group Rate Plan Charges

Use this endpoint to retrieve all charges for the specified price item charge group rate plan.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges
  • Method:  GET

Add a Price Item Charge Group Rate Plan Charge

Use this endpoint to create a price item charge group rate plan charge.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges
  • Method:  POST

Update Price Item Charge Group Rate Plan Charges

Use this endpoint to update charges for the specified price item charge group rate plan.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges
  • Method:  PATCH

Get a Price Item Charge Group Rate Plan Charge

Use this endpoint to retrieve the specified price item charge group rate plan charge.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges/{id}
  • Method:  GET

Delete a Price Item Charge Group Rate Plan Charge

Use this endpoint to delete the specified price item charge group rate plan charge.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges/{id}
  • Method:  DELETE

Update a Price Item Charge Group Rate Plan Charge

Use this endpoint to update the specified price item charge group rate plan charge.

  • Endpoint: /rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges/{id}
  • Method:  PATCH

Price Model/Price Agreement Matrix Grids

Get Price Model Pricing Matrix Grid Data

Use this endpoint to retrieve all the pricing matrix grid data for the specified price model.

  • Endpoint: /rest/v16/pricingSetup/models/{modelVarName}/matrixGrid
  • Method:  GET

Update Price Model Pricing Matrix Grid Data

Use this endpoint to update the pricing matrix grid data for the specified price model.

  • Endpoint: /rest/v16/pricingSetup/models/{modelVarName}/matrixGrid
  • Method:  POST

Get Price Agreement Pricing Matrix Grid Data

Use this endpoint to retrieve all the pricing matrix grid data for the specified price agreement.

  • Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/matrixGrid
  • Method:  GET

Update Price Agreement Pricing Matrix Grid Data

Use this endpoint to update the pricing matrix grid data for the specified price agreement.

  • Endpoint: /rest/v16/pricingSetup/models/{agreementVarName}/matrixGrid
  • Method:  POST

The new Pricing Setup endpoints provide web service support for:

  • Pricing products and BOM items in the Product Workbench
  • Dynamic Attribute-Based Pricing for Price Models and Price 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.