Commerce REST APIs

Overview

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.

Accept Quote
Description	Use this endpoint to accept the specified transaction.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_s_accept_quote
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `deleteRows`, `delta`, `documents`, `revisionId`, `selectionMode`, `selections`, `skipIntegration`, and `skipRules`. Refer to Request Body Objects for additional information
Response Body Parameters	The JSON data for the approved quote.

Add from Favorites
Description	This 'Add From Catalog' type action returns a destination URL to launch the Favorites List in Oracle CPQ where users can select items to add to the transaction.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/addFromFavorites_t
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, `selectionMode`, `selections`, and `skipIntegration`. Refer to Request Body Objects for additional information
Response Body Parameters	The response contains "destinationURL" to launch the Favorites List.

Add Transaction Lines
Description	Use this endpoint to add line items to the specified transaction.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/addLineItem_t
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, `selectionMode`, `selections`, and `skipIntegration`. Refer to Request Body Objects for additional information
Response Body Parameters	documents	The JSON Transaction Line data

Alternate Address - Retrieve
Description	Use this endpoint to return alternative addresses that are associated with the current customer and transaction.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_retrieve_alternate_address
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	accountAddressCriteria	Captures the query definition for the current resource request.
Request Body Parameters	This endpoint supports the `cacheInstanceId` parameter. Refer to Request Body Objects for additional information
Response Body Parameters	accountAddressCriteria	Captures the query definition for the current resource request.
Response Body Parameters	accountAddressList	Alternative 'bill_to/ship_to' addresses associated with the current customer and Transaction.

Alternate Address - Select
Description	Use this endpoint to associate an alternate account address with a transaction. This action is only available when the Customer ID field associated with a transaction has multiple addresses.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_select_alternate_address_action
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	accountAddressId	The ID for the alternate address.
	alternateAddress	Alternative bill to and ship to addresses.
	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, `selectionMode`, `selections`, and `skipIntegration`. Refer to Request Body Objects for additional information
Response Body Parameters	documents	JSON data containing a link to the transaction with updated bill to and ship to addresses.

Archive Transactions
Description	Use this endpoint to archive the specified transactions. Note: This action is only available for CPQ administrators with superuser access.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/actions/_archive_transactions
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
Request Body Parameters	selectionCriteria	Captures the query definition for resource requests, specifically for collection-based process actions.
Request Body Parameters	This operation supports the following optional parameters: `fields`, `orderBy`, and `q`. Refer to Request Body Objects for additional information
HTTP Method	POST
Success Response	204 No Content

Auto-fill Account Information
Description	Use this endpoint to automatically fill related customer data using the specified Customer ID field.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_auto_fill_action
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	billToAddressNumber	The number for the bill to address information.
	shipToAddressNumber	The number for the ship to address information.
	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, `selectionMode`, `selections`, and `skipIntegration`. Refer to Request Body Objects for additional information
Response Body Parameters	JSON data containing a link to the transaction with updated bill to and shop to addresses.

Back to Quotes List / Transaction Manager
Description	Use this endpoint to navigate back to the specified Quotes List/Transaction Manager page.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/back_to_transactionmanager_t
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	This endpoint supports the optional `cacheInstanceId` and `revisionId` parameters. Refer to Request Body Objects for additional information
Response Body Parameters	The response contains the Destination URL

Back to Transaction
Description	Use this endpoint to return the user to the transaction page from the line items details page.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_back
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
	subDocVarName	The variable name of the sub-document.
	docNumber	The sub-document number
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `errorCriteria`, and `revisionId`. Refer to Request Body Objects for additional information
Success Response	JSON data for the parent transaction.

Calculate Transaction Line Item Price
Description	Use this endpoint to apply pricing changes for updates to transaction line price attributes.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_calculate_price_action
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
	subDocVarName	The variable name of the sub-document.
	docNumber	The sub-document number
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, and `revisionId`. Refer to Request Body Objects for additional information
Response Body Parameters	The JSON Transaction Line data

Change Transaction Currency
Description	Use this endpoint to change the currency of an existing transaction. This feature is not currently supported in the Base Reference Application but can be enabled via customization.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_change_currency
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	currencyCode	The requested currency code, this item is required
Request Body Parameters	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `documents`, `revisionId`, `selectionMode`, `selections`, and `skipIntegration`. Refer to Request Body Objects for additional information
Success Response	JSON data containing the transaction with the updated currency

Copy Sequence
Description	Use this endpoint to retrieve copy sequences for the Commerce process.
URI Endpoint	/rest/v17/ommerceDocuments{ProcessVarName}{MainDocVarName}/actions/_copy_sequence
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Parameters	None
Response Parameters	sequences	An array of sequence definitions

Copy to Favorites
Description	Use this endpoint to copy the specified line items from the transaction to the Favorites List.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/{copyToFavoritesActionVarName}
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
	copyToFavoritesActionVarName	The variable name of the Copy to Favorites type action.
HTTP Method	POST
Request Parameters	selections	Required, use to specify the transaction lines.
	favoriteData	Folder where the favorites will reside. An empty or -1 value indicates default folder.
	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, and `skipIntegration`. Refer to Request Body Objects for additional information
Response Parameters	createdFavoriteIds	List of created favorite root Ids.

Copy Transaction Lines
Description	Use this endpoint to copy specified transaction lines within the current transaction.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/copyLineItems_t
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	numberOfCopies	The "`numberOfCopies`" parameter is an array to specify the number of copies for each line listed in the "`selections`" parameter. The number of copies for each line is specified in an array in the same sequence as the "`selections`" array. The default value is '1', if the number of copies value is not provided. The "`numberOfCopies`" array size cannot be greater than the "`selections`" array size.
	selections	Required, use to specify the transaction line(s) This service can be used for transaction and line level actions that support line selection. Selection items are an array of `{subDocVarName}/{docNumber}` combinations. Line Selection Sample { "selections": ["transactionLine/2", "transactionLine/3"] }
	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `selectionMode`, and `revisionId`. Refer to Request Body Objects for additional information
Success Response	The JSON data for the parent transaction including the copied transaction lines, or a subset of transaction items, depending on the input request transaction

Create Sales Agreement
Description	Use this endpoint to create a sales agreement from the specified transaction.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_s_createAgreement
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, `selectMode`, `selections`, and `skipIntegration`. Refer to Request Body Objects for additional information
Success Response	The JSON data for the sales agreement.

Create Transaction Lines
Description	Use this endpoint to create transaction line items for the part items or models that are listed in the request body.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
	subDocVarName	The variable name of the sub-document.
HTTP Method	POST
Request Body Parameters	_part_number	The Part Number to be added to this transaction.
	_price_book_var_name	Variable Name of the Price Book used to get the price for this line item.
	_price_quantity	The quantity of parts to be added to this transaction.
Response Body	The JSON Transaction data

Create Transaction Version
Description	Use this endpoint to create a new version of the specified transaction.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/versionTransaction_t
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `documents`, and `revisionId`. Refer to Request Body Objects for additional information
Success Response	The JSON data of the new transaction version

Create Transaction with Line Items
Description	Use this endpoint to create a new transaction with parts and/or models as specified in the request payload.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method(s)	POST
Request Body	_currency_pref	Currency preference
Request Body	items	The transaction lines to be included in the new transaction.
Response Body	The JSON transaction data of the new transaction
Notes	Notes: When creating a transaction through a REST call, only a line item’s part number, quantity, and Price Book can be given values. The line items’ Price Book only needs to be declared when declaring the first line item in the payload. Other updateable sub-document attributes can be given values through a subsequent POST call by invoking a Commerce action. Similar to behavior in the Oracle CPQ user interface, transactions created through REST calls will exist in a temporary state until they are updated. In order to view a REST-call-created transaction in the Transaction manager, a subsequent UPDATE call must be made to update the transaction.

Delete Archived Transactions
Description	Use this endpoint to delete the specified archived transactions. Note: This action is only available for CPQ administrators with superuser access.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/actions/_delete_archived_transactions
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
Request Body Parameters	selectionCriteria	An array of archived transaction id items to be deleted.
HTTP Method	POST
Success Response	204 No Content

Drop Cache (Commerce)
Description	Use this endpoint to eliminate the cache created through REST web services. Drop Cache can improve site performance by removing cached objects that would otherwise remain in memory for the duration of the timeout specified in administration.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_dropCache
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	cacheInstanceId	The cache instance ID
Response Body Parameters	The requested cache instance is cleared.

Commerce REST APIs

Overview

Support to Add Unconfigured Models and Favorites to a Transaction

Administration

Calculate Transaction Line Item Price

Line Selection Sample

Related Topics

Email - Generate Transaction Email
Description	Use this endpoint to retrieve the objects required to send a transaction email.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_action_process_email_print
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`. Refer to Request Body Objects for additional information
Request Body Parameters	Specify one of the following parameters to filter the returned XSL views by the specified language: `languageAttributeValue` - Language attribute value for the print document (from Get Sales Company User REST API) `languageNumber` - Language attribute value for the print document (from Get Sales Company User REST API) `languagePreference` – Language attribute value for the print document Note: XSL views associated for Multi language templates are always returned irrespective of the language filter specified in the request payload.
Response Body Parameters	attachments	Attachments to send with the email
	availableAttachmentsForMerge	The list of attachments which can be merged with the proposal document
	bccEmail	bcc email address(es)
	cacheInstanceId	The cache instance ID, if requested
	ccEmail	cc email address(es)
	comments	Comments to be sent in the email body
	fromEmail	The sender's email address
	fromName	The sender's name
	generatedProposalAttachmentForMerge	The proposal attachment selected by default. The default ID value for the transaction is -2.
	revisionId	The revision Id of the transaction
	subject	The email subject line
	toEmail	The recipient's email address(es)
	toName	The recipient's name
	warnings	Warning messages
	xslViews	The list of all XSL Views selected for the Process level email action in Admin UI. `id` - the Id for the attachment `isAvaialbleForMerge` - This value will be true for XSL views that support merging of file attachments `name` - the name for the attachment

Email - Send Transaction Email
Description	Use this endpoint to collect email form data, generates the attachment, pushes the email to SMTP servers, and returns confirmation on email sent time. The email recipient receives an email with the comments in the email body and an attachment that contains the transaction information.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_send_email
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	actionVariableName	The email action variable name used to generate the email
	attachments	An array if attachment ID items
	attachmentIdsForMerge	The attachment IDs to merge
	bccEmail	bcc email address(es)
	cacheInstanceId	The cache instance ID
	ccEmail	cc email address(es)
	comments	Comments to be sent in the email body
	fromName	The sender's name
	languageCode	The language preference for sending email
	subject	The email subject line, this parameter is required to send email
	toEmail	The recipient's email address(es), this parameter is required to send email
	toName	The recipient's name
	xslView	Printer friendly proposals or history outputs generated from predefined XSL templates
Response Body Parameters	JSON with summary message for sending email

eSignature - Cancel Request
Description	Use this endpoint to cancel a pending eSignature request.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_action_esig_cancel
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	esigAttrSetVarName	Variable name of the eSignature attribute set
Request Body Parameters	This operation supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, `selections`, `selectionMode`, and `skipIntegration`. Refer to Request Body Objects for additional information.
Response Body Parameters	The JSON data for the requested transaction, or a subset of transaction items, depending on the input request.

eSignature - Request Details
Description	Use this endpoint to connect and view the eSignature related details from an integrated site, such as DocuSign.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_action_esig_details
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	esigAttrSetVarName	Variable name of the eSignature attribute set
Request Body Parameters	This operation supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, and `revisionId`, `selections`, `selectionMode`, and `skipIntegration`.
Response Body Parameters	The JSON data for the requested transaction, or a subset of transaction items, depending on the input request.

eSignature - Send Request
Description	Use this endpoint to send eSignature documents to recipients.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_action_esig_send
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	esigAttrSetVarName	Variable name of the eSignature attribute set
Request Body Parameters	This operation supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, `selections`, `selectionMode`, and `skipIntegration`. Refer to Request Body Objects for additional information.
Response Body Parameters	The JSON data for the requested transaction, or a subset of transaction items, depending on the input request.

Export Transaction Attachment
Description	Use this endpoint to export an Oracle CPQ generated document.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/exportAttachment
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	This operation supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, `selections`, `selectionMode`, and `skipIntegration`. Refer to Request Body Objects for additional information.
Response Body Parameters	The JSON Transaction Data

Forward Transactions
Description	Use this endpoint to forward selected transactions to the specified users and/or groups.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/actions/_forward
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
Request Body Parameters	company	The company name
	ids	The list of transactions that are forwarded to user / groups
	salesGroups	List of sales groups to forward the transaction to
	salesUsers	List of sales use logins to forward the transaction to
HTTP Method	POST
Success Response

Generate Proposal
Description	Use this endpoint to generate a file of the proposal document by merging the associated printer-friendly XSL document with the current transaction details.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/generateProposal
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
HTTP Method	POST
Request Body Parameters	This operation supports the following optional parameters: `cacheInstanceId`, `criteria`, `delta`, `documents`, `revisionId`, `selections`, `selectionMode`, and `skipIntegration`. Refer to Request Body Objects for additional information.
Response Body Parameters	documents	JSON data for the transaction
	xslView	Printer friendly proposals or history outputs generated from predefined XSL templates
	fileAttachmentAttribute	The file attachment attribute used of confirmation
	generatedProposalAttachmentForMerge	The default selected attachment for an email or print action
	cacheInstanceId	The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
	availableAttachmentsfoMerge	A list of attachments available to merge for an email or print action

Get Archived Transactions
Description	Use this endpoint to retrieve a list of archived transactions. Note: This action is only available for CPQ administrators with superuser access.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/actions/_get_archived_transactions
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
Request Body Parameters	criteria	The criteria object supports the following parameters to retrieve specific content and limit the size of the response. `actions`, `childDefs`, `enableHierarchy`, `excludeFieldTypes`, `expand`, `fields`, `groups`, `limit`, `offset`, `orderBy`, `q`, `state`, and `totalResults`. Refer to Criteria Object for additional information.
HTTP Method	POST
Response Body Parameters	The JSON data for the requested archived transactions.

Get History
Description	Use this endpoint to retrieve historical changes for a transaction using criteria defined in the request body.
URI Endpoint	/rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/{displayHistoryActionVarName}
Endpoint Parameters	Stage	The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
	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.
	displayHistoryActionVarName	The variable name of the Display History type action.
HTTP Method	POST
Request Body Parameters	criteria	Used to specify query parameters for the history response Refer to Request Body Criteria, Resources, and Sample for more information.
Request Body Parameters	This operation supports the following optional parameters: `cacheInstanceId` and `revisionId`. Refer to Request Body Objects for additional information.
Response Body Parameters	JSON data containing the transaction history