REST API Services for Oracle CPQ

Commerce REST Endpoints

Commerce

Oracle CPQ exposes transactional objects and transaction data through REST APIs and RESTful standards. The REST APIs provide a new, modern way to access transaction and line item information. With appropriate HTTP Basic authentication, any other third-party system can make use of these services. Additional resources allow credentialed third-party systems to create transactions, and to update transactions by invoking modify, version, submit, and approval actions in a Commerce Process through REST APIs.
Notes:

If you are using a custom Commerce Process, your endpoints and action names may vary.
Additionally, you may not see all of the action endpoints listed below. Refer to CPQ Administrator Online Help > Web Services > Interface Catalog for information about accessing your site-specific REST APIs.

Add Transaction Lines: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/addLineItem_t
Alternate Address - Retrieve: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_retrieve_alternate_address
Alternate Address - Select: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_select_alternate_address_action
Archive Transactions: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_archive_transactions
Auto-fill Account Information: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_auto_fill_action
Back to Quotes List/Transaction Manager: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/back_to_transactionmanager_t
Back to Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_back
Calculate Transaction Line Item Price: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_calculate_price_action
Change Transaction Currency: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_change_currency
Copy Sequence: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_copy_sequence
Copy to Favorites: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/copyToFavorites
Copy Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_copy_transaction
Copy Transaction Lines: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/copyLineItems_t
Create Transaction Lines: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}
Create Transaction Version: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/versionTransaction_t
Create Transaction with Line Items: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}
Create Transaction without Line Items: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_new_transaction
Delete Archived Transactions: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_delete_archived_transactions
Delete Transaction Line: Method: delete
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}
Delete Transaction Lines: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_remove_transactionLine
Drop Cache: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_dropCache
Email - Generate Transaction Email: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_process_email_print
Email - Send Transaction Email: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_send_email
eSignature - Cancel Request: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_esig_cancel
eSignature - Request Details: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_esig_details
eSignature - Send Request: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_esig_send
Export Transaction Attachment: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/exportAttachment
Forward Transactions: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_forward
Generate Proposal: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/generateProposal
Get Archived Transactions: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_get_archived_transactions
Get History: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/{displayHistoryActionVarName}
Get Transaction: Method: get
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}
Get Transaction Line: Method: get
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}
Get Transaction Line Available Rate Plan: Method: get
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_availableRatePlanSet/{_row_number}
Get Transaction Line Available Rate Plans: Method: get
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_availableRatePlanSet
Get Transaction Line Charge: Method: get
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_chargeSet/{_row_number}
Get Transaction Line Charges: Method: get
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_chargeSet
Get Transaction Lines: Method: get
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}
Get Transactions: Method: get
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}
Group (Aggregate) Transactions: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_aggregate
Interact - Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_interact
Interact - Transaction Line: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_interact
Lock Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/lockTransaction
My Approvals Search: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_search/_my_approval_search
Open Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_open_transaction
Open Transaction Line: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_open_transactionLine
Orders - Cancel Sales Order: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/order_cancel
Orders - Reject Sales Order: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/order_reject
Orders - Start Sales Order: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/order_start
Orders - Update Sales Order: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/order_update
Pipeline Viewer - Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_pipelineViewer
Pipeline Viewer - Transaction Line: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_pipelineViewer
Print - Generate Transaction Document: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_process_print
Print Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_print_document
Reconfigure Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_reconfigure_action
Reconfigure Transaction - Inbound: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_reconfigure_inbound_action
Reconfigure Transaction Line: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_reconfigure_action
Reconfigure Transaction Line - Inbound: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_reconfigure_inbound_action
Restore Archived Transactions: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_restore_archived_transactions
Save Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/cleanSave_t
Save Transaction Line: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/save_l
Save Transaction Version: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/versionSave_t
Submit - Approve Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/approve_submit_t
Submit - Reject Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/reject_submit_t
Submit - Request Transaction Approval: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/request_approval_submit_t
Submit - Revise Transaction: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/revise_submit_t
Submit Transaction for Approval: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/submit_t
Unlock Transactions: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_process_unlock
Update Transaction Lines: Method: post
Path: /rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_update_line_items