Product Administration Menu Item REST APIs

Oracle CPQ 24A adds several new Product Administration endpoints to enable administration of single select and multi-select menu items using REST API web services. These endpoints provide add, update, and delete functions for All Product Families, Product Family, and Model menu items, menu item images, menu item prices, and menu item translations.

NOTE:  You must deploy the applicable Product Family after any changes to Configuration menu items, refer to Oracle CPQ Administrator Online Help > Web Services > REST APIs > CPQ APIs > Product Administration REST APIs – Deploy a Product Family.

The new REST API actions listed below are provided for the following base URLs:

  • /rest/v16/allProductFamilySetups/{allProdFamsVarName}

  • /rest/v16/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}

  • /rest/v16/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}

  • /rest/v16/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}

Add a Menu Item

Use this endpoint to add the applicable All Product Families, Product Family, Product Line, or Model menu item.

  • Endpoint: /attributes/{attributeVarName}/menuItems
  • Method:  POST

Update a Menu Item

Use this endpoint to update the specified All Product Families, Product Family, Product Line, or Model menu item.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}
  • Method:  PUT

Delete a Menu Item

Use this endpoint to delete the specified All Product Families, Product Family, Product Line, or Model menu item.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}
  • Method:  DELETE

Remove a Menu Item Override

Use this endpoint to remove an override for the specified All Product Families, Product Family, Product Line, or Model menu item.

  • Endpoint: /attributes/{attributeVarName}/menuItems /actions/removeOverride
  • Method:  POST

Add a Menu Item Image

Use this endpoint to associate an image to the applicable All Product Families, Product Family, Product Line, or Model menu item.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}/images
  • Method:  POST

Delete a Menu Item Image

Use this endpoint to delete the specified All Product Families, Product Family, Product Line, or Model menu item image association.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}/images/{imageId}
  • Method:  DELETE

Update a Menu Item Image

Use this endpoint to update the specified All Product Families, Product Family, Product Line, or Model menu item image.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}/images/{imageId}
  • Method:  PUT

Add a Menu Item Price

Use this endpoint to add the applicable All Product Families, Product Family, Product Line, or Model menu item price.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}/prices
  • Method:  POST

Delete a Menu Item Price

Use this endpoint to delete the specified All Product Families, Product Family, Product Line, or Model menu item price.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}/prices/{priceId}
  • Method:  DELETE

Update a Menu Item Price

Use this endpoint to update the specified All Product Families, Product Family, Product Line, or Model menu item price.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}/prices/{priceId}
  • Method:  PUT

Add Menu Item Translation

Use this endpoint to add the applicable All Product Families, Product Family, Product Line, or Model menu item translations.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}/translations
  • Method:  POST

Delete a Menu Item Translation

Use this endpoint to delete the specified All Product Families, Product Family, Product Line, or Model menu item translation.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}/translations/{translationId}
  • Method:  DELETE

Update a Menu Item Translation

Use this endpoint to update the specified All Product Families, Product Family, Product Line, or Model menu item translation.

  • Endpoint: /attributes/{attributeVarName}/menuItems /{menuItemId}/translations/{translationId}
  • Method:  PUT

The new Oracle CPQ 24A (v16) Configuration Product Administration REST APIs enable administration of Configuration menu items.

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.