Commerce Process Setups REST API

Oracle CPQ 25B introduces the following Commerce Process Setup REST API endpoints:

Create a Commerce Process

Use this endpoint to create a Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups
• Method: POST

Delete an Undeployed Commerce Process

Use this endpoint to delete an undeployed specified Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups/{id}
• Method: DELETE

Get Commerce Process Auto-Unlock Actions

Use this endpoint to retrieve actions that automatically unlock the specified Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/autoUnlockActions
• Method: GET

Update a Commerce Process

Use this endpoint to update the specified Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}
• Method: PATCH

Create a Commerce Process Data Column

Use this endpoint to create Data Columns for the specified Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/dataColumns
• Method: POST

Get Commerce Process Data Column References

Use this endpoint to retrieve references to the specified Commerce Process Data Column.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/dataColumns/{id}
• Method: GET

Update a Commerce Process Data Column

Use this endpoint to update the specified Commerce Process Data Column.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/dataColumns/{id}
• Method: PATCH

Perform Commerce Process Deployment Center Actions

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/v18/commerceProcessSetups/{processVarName}/deploymentCenter/actions
• Method: POST

Create a Commerce Process Document

Use this endpoint to create a main document or sub-document for the specified Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/documents
• Method: POST

Delete a Commerce Process Document

Use this endpoint to delete the specified undeployed Commerce Process document.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/documents/{id}
• Method: DELETE

Get Commerce Process Document Modify Options

Use this endpoint to retrieve modify options for the specified Commerce Process document.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/documents/{docVarName}/modifyTab
• Method: GET

Update a Commerce Process Document

Use this endpoint to update the specified Commerce Process document.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/documents/{docVarName}
• Method: PATCH

Update Commerce Process Document Modify Options

Use this endpoint to update modify options for the specified Commerce Process document.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/documents/{docVarName}/modifyTab
• Method: PATCH

Get Commerce Process Integrations

Use this endpoint to retrieve available integrations for the specified Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/integrations
• Method: GET

Create a Commerce Process Integration

Use this endpoint to create an integration for the specified Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/integrations
• Method: POST

Get Commerce Process Integration Initial Imports

Use this endpoint to retrieve enabled initial integration imports for the specified Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/initialImports
• Method: GET

Get Commerce Process Integration Settings

Use this endpoint to retrieve Commerce Process integration settings.

• Endpoint: /rest/v18/commerceProcessSetups/integrationSettings
• Method: GET

Get Commerce Process Integration Types

Use this endpoint to retrieve integration types for the specified Commerce Process.

• Endpoint: /rest/v18/commerceProcessSetups/integrationTypes
• Method: GET

Update a Commerce Process Integration

Use this endpoint to update the specified Commerce Process integration.

• Endpoint: /rest/v18/commerceProcessSetups/{processVarName}/integrations/{integrationVarName}
• Method: PATCH

The Commerce Process Setups REST API provides web service support managing Commerce Process actions, documents, and integrations.

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.