Commerce Product Setup REST APIs

Oracle CPQ 25D supports new Commerce Process Setup REST API endpoints.

Get Commerce Process Encryption Key Status

Use this endpoint to check if the specified commerce process has a valid encryption key certificate.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/hasValidCertificate
• Method: GET

Invoke a Commerce Deployment Center Action

Use this endpoint to perform deployment center actions for the specified commerce process. The following actions can be performed: Deploy Process, Clone Process, Repopulate Column Data, Remove Transactions, Mass Update Transactions, Export Process, Delete Process, and Generate Schema and WSDL.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/deploymentCenter/actions
• Method: POST

Process Manager

Create a Commerce Process Manager Column

Use this endpoint to add a commerce process manager column.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/processColumns
• Method: POST

Delete Commerce Process Manager Columns

Use this endpoint to delete the specified commerce process manager columns.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/processColumns/delete
• Method: POST

Update a Commerce Process Manager Column

Use this endpoint to update the specified commerce process manager column.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/processColumns/{columnId}
• Method: PATCH

Actions

Clone a Commerce Document Action

Use this endpoint to clone the specified commerce document action.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/actions/{actionVarName}/clone
• Method: POST

Create a Commerce Copy Action Copy Sequence

Use this endpoint to add a copy sequence for the specified commerce process action.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/actions/{actionVarName}/copySequence
• Method: POST

Create a Commerce Document Action

Use this endpoint to add a document action. The document Id is specified in the request body.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/actions
• Method: POST

Delete Commerce Document Actions

Use this endpoint to delete the specified commerce document actions.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/actions/delete
• Method: POST

Update a Commerce Copy Action Copy Sequence

Use this endpoint to update the specified commerce process copy action copy sequence.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/actions/{actionVarName}/copySequence/{sequenceId}
• Method: PATCH

Update a Commerce Process Action

Use this endpoint to update the specified commerce process action.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/actions/{actionVarName}
• Method:  PATCH

Update Commerce Process Action Access Rights

Use this endpoint to update access rights for the specified commerce process action.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/actions/{actionVarName}/accessRights
• Method: PATCH

Attributes

Get System Attributes

Use this endpoint to retrieve system variable attributes.

• Endpoint: /rest/v19/commerceProcessSetups/systemAttributes
• Method: GET

Create a Commerce Attribute

Use this endpoint to add an attribute to the specified commerce document.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes
• Method: POST

Delete Commerce Attributes

Use this endpoint to delete the specified commerce document attributes.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes/delete
• Method: POST

Get Commerce Attribute References

Use this endpoint to retrieve attribute references for the specified commerce document attribute.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/references
• Method: GET

Get Commerce Attribute Settings

Use this endpoint to retrieve attribute settings for the specified commerce document attribute.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/settings
• Method: GET

Get Commerce Attribute Types

Use this endpoint to retrieve attribute types for the specified commerce document.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeTypes
• Method: GET

Update a Commerce Attribute

Use this endpoint to update the specified commerce document attribute.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}
• Method: PATCH

Array Sets

Create a Commerce Array Set

Use this endpoint to add an array set to the specified commerce document.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/arraySets
• Method: POST

Delete Commerce Array Sets

Use this endpoint to delete the specified commerce document array sets.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/arraySets/delete
• Method: POST

Synchronize Commerce Charge Array Set

Use this endpoint to synchronize the commerce document charge array set.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/synchronizeChargeSet
• Method: POST

Update a Commerce Array Set

Use this endpoint to update the specified commerce document array set.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}
• Method: PATCH

Attribute Sets

Delete Commerce Attribute Sets

Use this endpoint to delete the specified commerce document attribute sets.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeSets/delete
• Method: POST

Create a Commerce Attribute Set

Use this endpoint to add an attribute set to the specified commerce document.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeSets
• Method: POST

Get Commerce Part Attribute Set Attribute Options

Use this endpoint to retrieve attribute options for the commerce document part attribute set.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeSets/{attrSetVarName}/manageAttributeOptions
• Method: GET

Update Commerce Part Attribute Set Attribute Options

Use this endpoint to update the attribute options for the commerce document part attribute set.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeSets/{attrSetVarName}/manageAttributeOptions
• Method: PATCH

Library Functions

Create a Commerce Library Function

Use this endpoint to add a commerce library function.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions
• Method: POST

Debug a Commerce Library Function

Use this endpoint to debug the specified commerce document library function.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/actions/debug
• Method: POST

Delete a Commerce Library Function

Use this endpoint to delete the specified commerce document library function.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/{functionVarName}
• Method: DELETE

Get Commerce Library Functions

Use this endpoint to retrieve library functions for the specified commerce document.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions
• Method: GET

Get a Commerce Library Function

Use this endpoint to retrieve the specified commerce document library function.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/{functionVarName}
• Method: GET

Get Commerce Library Function Dependent Attributes

Use this endpoint to retrieve all the dependent attributes for the specified commerce document library function.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/actions/dependentAttributes
• Method: POST

Load Commerce Library Function Transaction Data

Use this endpoint to retrieve attribute values for requested commerce document library function.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/actions/loadTransactionData
• Method: POST

Update a Commerce Library Function

Use this endpoint to update the specified commerce document library function.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/{functionVarName}
• Method: PATCH

Validate a Commerce Library Function

Use this endpoint to validate the specified commerce document library function.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/actions/validate
• Method: POST

Get All Commerce Attribute Lookups

This endpoint to retrieve all attribute lookups for the specified commerce process.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/bml/attributeLookups
• Method: GET

Get a Commerce Attribute Lookup

Use this endpoint to retrieve lookup type details for the specified commerce process attribute lookup.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/bml/attributeLookups/{lookupType}
• Method: GET

Get Commerce Attribute Lookup Values

Use this endpoint to retrieve lookup values for the specific commerce process attribute lookup.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/bml/attributeLookups/{lookupType}/lookupValues
• Method: GET

Rules

Get Commerce Rule Conditions

Use this endpoint to retrieve rule conditions for the specified commerce document rule.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/rules/{ruleVarName}/ruleCondition
• Method: GET

Convert a Simple Condition to an Advanced Condition

Use this endpoint to convert the specified commerce document simple condition to an advanced condition.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/ruleCondition/convertToAdvanced
• Method: POST

Views & Templates

Copy a Printer Friendly XSL View

Use this endpoint to copy the specified commerce process printer friendly XSL view.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews/actions/copy
• Method: POST

Create a Printer Friendly XSL View

Use this endpoint to add a printer friendly XSL view to the specified commerce process.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews
• Method: POST

Delete Printer Friendly XSL Views

Use this endpoint to delete the specified commerce process printer friendly XSL views.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews/actions/delete
• Method: POST

Get Printer Friendly XSL View Settings

Use this endpoint to retrieve printer friendly XSL view settings for the specified commerce process.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews/settings
• Method: GET

Update a Printer Friendly XSL View

Use this endpoint to update the specified commerce process printer friendly XSL view.

• Endpoint: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews/{xslVarName}
• Method: PATCH

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.