REST API Services for Oracle CPQ

Transaction REST Endpoints

Commerce/Transaction

Commerce Transaction REST APIs provide access to transactional objects and transaction data.
Note: If you are using a custom Commerce Process, your endpoints and action names may vary. Commerce REST APIs use the following resource paths:
- Main document: /commerce{Stage}{ProcessVarName}{MainDocVarName}
- Sub document: /commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}.
The following variable 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

Accept Quote: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_accept_quote
Add from Favorites: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_addFromFavorites_t
Alternate Address - Retrieve: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_retrieve_alternate_address
Alternate Address - Select: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_select_alternate_address_action
Associate Product: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_add_coverage
Auto-fill Account Information: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_auto_fill_action
Back to Quotes List/Transaction Manager: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/back_to_transactionmanager_t
Change Transaction Currency: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_change_currency
Copy to Favorites: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/{copyToFavoritesActionVarName}
Copy Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_copy_transaction
Create New Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_new_transaction
Create Sales Agreement: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_createAgreement
Create Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction
Create Transaction Version: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/versionTransaction_t
Display History: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/{displayHistoryActionVarName}
Drop Cache: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_dropCache
Email - Generate Transaction Email: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_action_process_email_print
Email - Send Transaction Email: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_send_email
eSignature - Cancel Request: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_action_esig_cancel
eSignature - Request Details: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_action_esig_details
eSignature - Send Request: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_action_esig_send
Export Transaction Attachment: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/{exportAttachmentActionVarName}
Generate Proposal: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/generateProposal
Get Transaction: Method: get
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}
Get Transaction Comment: Method: get
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/_s_transactionComments_t/{_row_number}
Get Transaction Comments: Method: get
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/_s_transactionComments_t
Get Transactions: Method: get
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction
Interact - Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_interact
Lock Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/{lockActionVarName}
Open Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_open_transaction
Orders - Cancel Sales Order: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_cancel
Orders - Reject Sales Order: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_reject
Orders - Start Sales Order: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_start
Orders - Update Sales Order: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_update
Pipeline Viewer - Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_pipelineViewer
Print - Generate Transaction Document: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_action_process_print
Print Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_print_document
Publish Quote: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_publish_quote
Quote Summary: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_quoteSummary_t
Reconfigure Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_reconfigure_action
Reconfigure Transaction - Inbound: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_reconfigure_inbound_action
Request Quote Revision: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_request_quote_revision
Save Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/cleanSave_t
Save Transaction Version: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/versionSave_t
Self-Service Checkout: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_selfServiceCheckout_t
Submit - Approve Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/approve_submit_t
Submit - Reject Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/reject_submit_t
Submit - Request Transaction Approval: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/request_approval_submit_t
Submit - Revise Transaction: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/revise_submit_t
Submit Transaction for Approval: Method: post
Path: /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/submit_t