Commerce Process Setup REST API Endpoints

Overview

These REST API endpoints provide web service support for administrative tasks associated with managing processes.

Administration

ClosedCreate a Commerce Process

  Create a Commerce Process Post method
Description Use this endpoint to add a commerce process.
URI Endpoint

/rest/v19/commerceProcessSetups
Endpoint Parameters None
HTTP Method

POST
Request Body Parameters

autoUnlockActionIds

Actions that automatically unlock a transaction when performed by the user who locked the transaction

blockAutofill

Specify auto-fill options for new transactions

  1. User Information
  2. None
  3. Account Information

continueOnTimeout

Execute action if associated integrations timeout

  1. Allow associated actions to run after integration timeout
  2. Disable associated actions upon integration timeout

deleteSecureAttributeEncryptionKey

Delete the public key used for encrypting secure attributes

description

Process description

fiscalYearStartDate

Month / Day for Fiscal year start date

initialImports

List of commerce integrations selected to import initial data

layoutOptions

Layout options available for the process

nonOwnerUnlock

Lets users who did not lock a transaction to unlock the transaction using document-level unlock actions

pageLength

Determines the number of transactions to show at a time

processName

Process name

stage

Enables subsets of transactions within different phases of the transaction lifecycle

  1. Quotes stage allowed
  2. Quotes and Orders stages allowed
  3. Quotes and Agreements stages allowed
  4. Quotes, Orders, and Agreements stages allowed

tabLabelDataMapId

Tab label data map Id

transactionEditingMode

Transaction editing mode :

  1. Single User
  2. Transaction Locking
  3. Collaborative Editing

type

Process type: Standard Process, Blank Process

useRedwoodForTxnsList

Use Redwood layout for quotes / transactions list

variableName

Process variable name
Response Body Parameters

Returns one of the following:

  • processId - the process Id, when creating a Blank Process
  • taskId - the task Id, when creating a Standard Process

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceProcessSetups

ClosedRequest Body Sample

{ "processName": "Test new blank process", "description": "process description", "variableName": "testNewBlankProcess", "pageLength": 30, "blockAutofill": 1, "type": 1, "fiscalYearStartDate": "12/30", "transactionEditingMode": 1, "nonOwnerUnlock": 0, "useRedwoodForTxnsList": true, "stage": 0 }

ClosedResponse Body Sample

{ "processId": 12312 }

ClosedDelete a Commerce Process

Delete a Commerce ProcessDELETE method
Description

Use this endpoint to delete an undeployed commerce process.
URI Endpoint

/rest/v19/commerceProcessSetups/{processId}
Endpoint Parameters

processId

Commerce process Id
HTTP Method DELETE
Request Body Parameters None
Success Response 204

ClosedGet Commerce Process Auto-Unlock Actions

Get Commerce Process Auto-Unlock ActionsGET Method

Description

Use this endpoint to retrieve actions that automatically unlock the specified commerce process.

URI Endpoint

/rest/v19/commerceProcessSetups/{processVarName}/autoUnlockActions

Endpoint Parameters

processVarName

Process variable name

HTTP Method

GET

Request Body Parameters

None
Response Body Parameters

An array of auto-unlock actions

id

Auto-unlock action Id

label

Auto-unlock action label

selected

Indicates if the auto-unlock action is selected

variableName

Auto-unlock action variable name

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo/autoUnlockActions

ClosedResponse Body Sample

{ "items": [ { "id": 3023136164, "label": "Revise Quote", "variableName": "_s_request_quote_revision", "selected": false }, { "id": 3022962141, "label": "Save", "variableName": "cleanSave_t", "selected": false }, { "id": 3023317342, "label": "Self Service Checkout", "variableName": "_s_selfServiceCheckout", "selected": false }, { "id": 3022962823, "label": "Update Asset", "variableName": "updateAsset", "selected": false }, { "id": 3023317346, "label": "Update Price Guidance", "variableName": "_s_updatePriceGuidance_t", "selected": false }, { "id": 3022962757, "label": "Update SFA", "variableName": "oRCL_SFA_UpdateOpportunity", "selected": false } ] }

ClosedInvoke a Commerce Deployment Center Action

  Invoke a Commerce Deployment Center Action Post method
Description Use this endpoint to perform Deployment Center actions for the specified commerce process. The following actions can be performed: Clone a Process, Delete a Process, Deploy a Process, Export a Process, Mass Update Transactions, Remove Transactions, Repopulate Column Data, and Generate Schema and WSDL.
URI Endpoint

/rest/v19/commerceProcessSetups/{processVarName}/deploymentCenter/actions
Endpoint Parameters

processVarName

Process variable name
HTTP Method

POST
Request Body Parameters

category

Deployment center action category:

  • DEPLOY_PROCESS
  • CLONE_PROCESS
  • REPOPULATE_COLUMN_DATA
  • REMOVE_TRANSACTION
  • MASS_UPDATE_TRANSACTIONS
  • BULK_DOWNLOAD
  • DELETE_PROCESS
  • GENERATE_SCHEMA_AND_WSDL

emailTo

Email to address

processVarName

Process variable name

scheduledTime

Time the action is scheduled to run

sendEmail

Specifies whether to send email

stepIds

Step Ids
Response Body Parameters

taskId

The task Id

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo/deploymentCenter/actions

ClosedRequest Body Samples

Deploy Process Sample

{ "emailTo": "abcd@oracle.com", "sendEmail": true, "category": "DEPLOY_PROCESS", "scheduledTime": "12/06/2024 6:09 AM" }

Clone Process Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "CLONE_PROCESS", "scheduledTime": "12/06/2024 6:09 AM" }

Repopulate Data Columns Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "REPOPULATE_COLUMN_DATA", "scheduledTime": "12/06/2024 6:09 AM" }

Remove Transactions Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "REMOVE_TRANSACTION", "scheduledTime": "12/06/2024 6:09 AM" }

Mass Update Transactions Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "MASS_UPDATE_TRANSACTIONS", "scheduledTime": "12/06/2024 6:09 AM", "stepIds": "123456,234564,987654" }

Export Process Sample

{ "category": "BULK_DOWNLOAD" }

Delete Process Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "DELETE_PROCESS", "scheduledTime": "12/06/2024 6:09 AM" }

Generate Schema and WSDL Sample

{ "category": "GENERATE_SCHEMA_AND_WSDL" }

ClosedResponse Body Sample

{ taskId: 12345678 }

ClosedUpdate a Commerce Process

Update a Commerce Process Patch method

Description

Use this endpoint to update the specified commerce process.

URI Endpoint

/rest/v19/commerceProcessSetups/{processVarName}

Endpoint Parameters

processVarName

The Commerce process variable name

HTTP Method

PATCH
Request Header Content-Type: multipart/form-data

Request Body Parameters

secureAttributeEncryptionKey

Secure attribute encryption key file

The public key must be in the .CER format and equal to 2048 or more bytes.

processSettings

 JSON process settings

autoUnlockActionIds

Actions that automatically unlock a transaction when performed by the user who locked the transaction

blockAutofill

Specify auto-fill options for new transactions

  1. User Information
  2. None
  3. Account Information

continueOnTimeout

Execute action if associated integrations timeout

  1. Allow associated actions to run after integration timeout
  2. Disable associated actions upon integration timeout

deleteSecureAttributeEncryptionKey

Delete the public key used for encrypting secure attributes

description

Process description

fiscalYearStartDate

Month / Day for Fiscal year start date

initialImports

List of commerce integrations selected to import initial data

layoutOptions

Layout options available for the process

nonOwnerUnlock

Lets users who did not lock a transaction to unlock the transaction using document-level unlock actions

pageLength

Determines the number of transactions to show at a time

processName

Process name

stage

Enables subsets of transactions within different phases of the transaction lifecycle

  1. ?Quotes
  2. ?Orders
  3. ?Agreements

tabLabelDataMapId

Tab label data map Id

transactionEditingMode

Transaction editing mode :

  1. Single User
  2. Transaction Locking
  3. Collaborative Editing

type

Process type: Standard Process, Blank Process

useRedwoodForTxnsList

Use Redwood layout for quotes / transactions list

variableName

Process variable name
Response Body Parameters

Returns one of the following:

  • processId - the process Id, when creating a Blank Process
  • taskId - the task Id, when creating a Standard Process

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo

ClosedRequest Body Sample

payload: // JSON as text
{ "transactionEditingMode": 1, "stage": 3, "deleteSecureAttributeEncryptionKey": false, "blockAutofill": 2, "continueOnTimeout": 1, "nonOwnerUnlock": true, "fiscalYearStartDate": "02/29", "initialImports": [ 12321 ], "autoUnlockActionIds": [ 1234, 2345 ], "description": "Description is changed", "layoutOptions": { "generationRequested": 1, "layoutAccess": [{ "layoutType": 0, "priority": 3, "enabled": true }, { "layoutType": 1, "priority": 2, "enabled": true }, { "layoutType": 2, "priority": 1, "enabled": true } ] } },
resultFile: "test.cer", // File expected

ClosedResponse Body Sample

{ "processId": 12312 }

Related Topics

Related Topics Link IconSee Also