REST API Services for Oracle CPQ

Process REST Endpoints

Commerce/Process

Commerce Process REST APIs provide access to process level data.
Note: If you are using a custom Commerce Process, your endpoints may vary. Commerce REST APIs use the following resource paths:
- Main document: /commerce{Stage}{ProcessVarName}{MainDocVarName}
The following variables may differ for custom processes:
- {Stage} The stage variable identifies where a transaction is within the Commerce process flow
- {ProcessVarName} The variable name of the commerce process, note the first letter must be capitalized
- {MainDocVarName} The variable name of the main document, note the first letter must be capitalized
- {id} The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site

Archive Transactions: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_archive_transactions
Copy Sequence: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_copy_sequence
Delete Archived Transactions: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_delete_archived_transactions
Export Transactions: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_export_transactions
Forward Transactions: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_forward
Get Archived Transactions: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_get_archived_transactions
Group (Aggregate) Transactions: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_aggregate
My Approvals Search: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_my_approval_search
Restore Archived Transactions: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_restore_archived_transactions
Unlock Transactions: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_process_unlock