Overview
Oracle CPQ exposes transactional objects and transaction data through REST web services. The Commerce REST APIs allow credentialed third-party systems to retrieve, create, update, and delete transactions and transaction lines.
The following REST APIs use the CPQ Reference Application, where the commerce process is Oraclecpqo, the main document is Transaction, and the sub-document is Transaction Line.
-
If you are using a clone of the commerce process, your commerce endpoints will use the following syntax:
/commerceDocuments{ProcessVarName}, where{ProcessVarName} is the variable name of the commerce process, note that the first letter must be capitalized. -
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.
Main document endpoints will use the following syntax:
/commerceDocuments{ProcessVarName}{MainDocVarName}Sub-document endpoints will use the following syntax:
/commerceDocuments{ProcessVarName}{MainDocVarName}/(id}/{subDocVarName}-
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 current unique user-side ID. This is the internal identifier for a transaction within an Oracle CPQ site. -
subDocVarName- The variable name for the sub-document.
-
Administration
Add Transaction Lines |
||
|---|---|---|
|
Description |
Use this endpoint to add parts to the transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/addLineItem_t |
|
| Endpoint Parameters |
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: |
|
| Response Body Parameters |
documents |
The JSON Transaction Line data |
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533 /actions/addLineItems_t
| Alternate Address - Retrieve |
||
|---|---|---|
|
Description |
Use this endpoint to return alternative addresses that are associated with the current customer and transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_retrieve_alternate_address |
|
| Endpoint Parameters |
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. |
|
This endpoint supports the |
||
|
Response Body Parameters |
accountAddressCriteria |
Captures the query definition for the current resource request. |
|
accountAddressList |
Alternative 'bill_to/ship_to' addresses associated with the current customer and Transaction. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/_retrieve_alternate_address
{ "accountAddressList": { "hasMore": false, "items": [{ "dateModified": "2011-01-18", "billing_phone": "555-555-5678", "shipping_state": "Arkansas", "billing_last_name": "Jones", "dateAdded": "2008-05-07", "billing_state": "Arkansas", "shipping_company_2": "Co.", "billing_email": "Bill.Jones@email.com", "shipping_address_2": "Unit 55", "id": 4162301, "shipping_address": "401 Main Street", "billing_country": "United States", "shipping_zip": "60081", "shipping_fax": "555-555-5678", "shipping_phone": "555-555-5678", "shipping_last_name": "Jones", "billing_fax": "555-555-5678", "shipping_country": "United States", "shipping_first_name": "Bill", "shipping_city": "Little Rock", "shipping_company": "Apple", "shipping_email": "Bill.Jones@email.com", "billing_company": "Apple", "billing_zip": "60081", "billing_first_name": "Bill", "billing_city": "Little Rock", "billing_company_2": "Co.", "billing_address_2": "Unit 55", "billing_address": "401 Main Street" }, { "dateModified": "2011-01-18", "billing_phone": "555-555-5679", "shipping_state": "California", "billing_last_name": "Brown", "dateAdded": "2008-05-15", "billing_state": "California", "shipping_company_2": "Inc.", "billing_email": "Steve.Brown@email.com", "shipping_address_2": "Suite 128", "id": 5676963, "shipping_address": "501 Pine Circle", "billing_country": "United States", "shipping_zip": "60082", "shipping_fax": "555-555-5679", "shipping_phone": "555-555-5679", "shipping_last_name": "Brown", "billing_fax": "555-555-5679", "shipping_country": "United States", "shipping_first_name": "Steve", "shipping_city": "Sacramento", "shipping_company": "Oracle", "shipping_email": "Steve.Brown@email.com", "billing_company": "Oracle", "billing_zip": "60082", "billing_first_name": "Steve", "billing_city": "Sacramento", "billing_company_2": "Inc.", "billing_address_2": "Suite 128", "billing_address": "501 Pine Circle" }, { "dateModified": "2011-01-18", "billing_phone": "555-555-5680", "shipping_state": "Colorado", "billing_last_name": "Davis", "dateAdded": "2008-05-15", "billing_state": "Colorado", "shipping_company_2": "Corp.", "billing_email": "Mark.Davis@email.com", "shipping_address_2": "PO Box 458", "id": 5676964, "shipping_address": "601 Maple Court", "billing_country": "United States", "shipping_zip": "60083", "shipping_fax": "555-555-5680", "shipping_phone": "555-555-5680", "shipping_last_name": "Davis", "billing_fax": "555-555-5680", "shipping_country": "United States", "shipping_first_name": "Mark", "shipping_city": "Denver", "shipping_company": "HP", "shipping_email": "Mark.Davis@email.com", "billing_company": "HP", "billing_zip": "60083", "billing_first_name": "Mark", "billing_city": "Denver", "billing_company_2": "Corp.", "billing_address_2": "PO Box 458", "billing_address": "601 Maple Court" } ] } }
| 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/v16//commerceDocumentsOraclecpqoTransaction/{id}/actions/_select_alternate_address_action |
|
| Endpoint Parameters |
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: |
||
| Response Body Parameters |
documents |
JSON data containing a link to the transaction with updated bill to and ship to addresses. |
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/_select_alternate_address
| 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/v16/commerceDocumentsOraclecpqoTransaction/actions/_archive_transactions |
|
| Endpoint Parameters |
None |
|
|
Request Body Parameters
|
selectionCriteria |
Captures the query definition for resource requests, specifically for collection-based process actions. |
|
This operation supports the following optional parameters: |
||
|
HTTP Method |
POST |
|
|
Success Response |
204 No Content |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_archive_transactions
{ "selectionCriteria": { "q": "{'bsid':{$eq:'3022127625'}}", "orderBy": ["field1:ASC", "field2:DESC"] } }
| Auto-fill Account Information |
||
|---|---|---|
|
Description |
Use this endpoint to automatically fill related customer data using the specified Customer ID field. |
|
|
URI Endpoint |
/rest/v16//commerceDocumentsOraclecpqoTransaction/{id}/actions/_auto_fill_action |
|
| Endpoint Parameters |
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: |
||
|
Response Body Parameters |
JSON data containing a link to the transaction with updated bill to and shop to addresses. |
|
https://sitename.oracl.come/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/_auto_fill_action
{ "billToAddressNumber": 2, "shipToAddressNumber": 3, "documents": { "quoteDescription": "updated quote description 5", "_customer_id": "account95", "_bill_to_address": "30777 Park Avenue", "lineItem": { "items": [{ "_price_quantity": 304, "_document_number": 3 } ] } } }
{ "documents": { "quoteDescription": "updated quote description 5", "_customer_id": "account95", "_bill_to_address": "307 Park Avenue", "_ship_to_address": "207 Second Street", "lineItem": { "items": [{ "_price_quantity": 304, "_document_number": 3 } ] } } }
|
Description |
Use this endpoint to take the user back to the destination specified on the Destination tab for the Back action. If the action is associated with the Unlock operation, then the current transaction will also be unlocked. |
|
|---|---|---|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/back |
|
| Endpoint Parameters |
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 Refer to Request Body Objects for additional information |
|
|
Response Body Parameters |
The response contains the Destination URL |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/actions/back
| Back from Transaction Line |
||
|---|---|---|
|
Description |
Use this endpoint to return the user to the transaction page from the line items details page. |
|
|
URI Endpoint |
/rest/v16commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/_back |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information |
|
|
Success Response |
The response contains the Destination URL. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/transactionLine/6/actions/back_l
Calculate Transaction Line Item Price
|
Description |
Use this endpoint to apply pricing changes made on the line to the Price Attributes. |
|
|---|---|---|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/_calculate_price_action |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information |
|
|
Response Body Parameters |
The JSON Transaction Line data |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/ transactionLine/3/actions/_calculate_price_action
{ "documents": { "_price_quantity": 10, "_price_override_quantity": true, "_price_item_price_each": { "value": 11, "currency": "USD" }, "_pricing_rule_price_each": { "value": 14, "currency": "USD" }, "_price_unit_price_each": { "value": 15, "currency": "USD" }, "_price_override_price": { "value": "Yes", "displayValue": "Yes" }, "_price_discount_percent": 18, "_price_override_discount": { "value": "Percent", "displayValue": "Percent" } } }
Notes:
- The following attributes are not allowed:
_price_list_price_each,_price_subtotal,_price_net_price, and_price_discount_comment - The "Override Price" attribute should be set to "Yes" to allow overrides when invoking the REST to perform recalculation.
- If "Override Price" is set to "No" and there are new price values, the values will be reset to the original values and returned via the REST API. There will be no warning or error message when new values are provided for recalculation.
- The recalculated values returned via the REST API are not saved in the database until a modify type action is invoked.
| 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/v16commerceDocumentsOraclecpqoTransaction/{id}/actions/_change_currency |
|
| Endpoint Parameters |
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 |
|
This endpoint supports the following optional parameters: |
||
|
Success Response |
JSON data containing the transaction with the updated currency |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/_change_currency
{"currencyCode": "USD"}
| Copy to Favorites |
||
|---|---|---|
|
Description |
Use this endpoint to copy the specified line items from the transaction to the Favorites List. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/copyToFavorites |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
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: Refer to Request Body Objects for additional information |
||
| Response Parameters |
createdFavoriteIds |
List of created favorite root Ids. |
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533 /actions/copyToFavorites
{ "selections": [lineItem/2, lineItem/4], "documents": { ... } }
| Copy Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to copy the specified transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_copy_transaction |
|
| Endpoint Parameters |
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: Refer to Request Body Objects for additional information |
|
|
Success Response |
The JSON data for the duplicated transaction, or a subset of transaction items, depending on the input request |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18103143/actions/_copy_transaction
| Copy Transaction Lines |
||
|---|---|---|
|
Description |
Use this endpoint to duplicate specified transaction lines within the current transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/copyLineItems_t |
|
| Endpoint Parameters |
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 |
Required, an array to
specify the number of copies for each line listed in
" |
|
selections |
Required, use to specify the transaction line(s) |
|
|
This endpoint supports the following optional parameters: 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 |
|
This action is used to duplicate transaction lines. Request body "selections" and "numberOfCopies" parameters are used to provide specifications.
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.
This enhancement supports using the REST call request body to select transaction lines. This service can be used for transaction and line level actions that support line selection. Selection items are an array of {subDocVarName}/{subDocNumber} combinations.
Line Selection Sample
{ "selections": ["transactionLine/2", "transactionLine/3"] }
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18097326/actions/copyLineItems_t
- Copy transaction lines 5 and 3, copy each item once
{ "numberOfCopies": [1,1], "selections": ["transactionLine/5", "transactionLine/3"] }
- Modify, and then copy transaction lines 5 and 7, copy each item once
{ "documents": {"transactionDescription": "Mar31", "transactionLine": { "items": [ {"_document_number": "5", "_price_quantity": "45"}, {"_document_number": "7", "_price_quantity": "45"} ] } }, "numberOfCopies": [1,1], "selections": ["transactionLine/5", "transactionLine/7"] }
| Create Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to create a new transaction without any line items. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_new_transaction |
|
| Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information |
|
|
Response Body |
The JSON data of the new Transaction |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_new_transaction
Create Transaction (with Parts)
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction
{ "lineItem": { "items": [{ "_part_number": "part10", "_price_quantity": "1", "_price_book_var_name": "_default_price_book" }, { "_part_number": "part1", "_price_quantity": "5", } ] }
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/36365444/transactionLine
| Create Transaction Version |
||
|---|---|---|
|
Description |
Use this endpoint to create a new version of the specified transaction and displays this new version for editing. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/versionTransaction_t |
|
| Endpoint Parameters |
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: Refer to Request Body Objects for additional information |
|
|
Success Response |
The JSON data of the new Transaction |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18097326/actions/versionTransaction_t
| Delete Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to soft delete a transaction by setting the transaction status and the document step to 'Deleted', where it can no longer be edited and is only visible to a technical administrator. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/deleteTransaction_t |
|
| Endpoint Parameters |
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: Refer to Request Body Objects for additional information |
|
|
Success Response |
The JSON data for the deleted transaction. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/deleteTransaction_t
|
Description |
Use this endpoint to delete the specified transaction line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber} |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
None |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/transactionLine/3
| Delete Transaction Lines |
||
|---|---|---|
|
Description |
Use this endpoint to delete the specified transaction line(s) from a transaction. |
|
|
URI Endpoint |
/rest/v16commerceDocumentsOraclecpqoTransaction/{id}/actions/_remove_transactionLine |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
Request Body Parameters
|
selections |
Required, this parameter is used for transaction level actions that support line selection. Selection items are an array of |
|
This operation supports the following optional parameters: |
||
|
HTTP Method |
POST |
|
|
Response Body Parameters |
The JSON Transaction data |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_remove_transactionLine
{"selections": ["transactionLine/2", "transactionLine/3"]}
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18330547/actions/_dropCache
{"cacheInstanceId": "E9JuyC9QCgTDS9edghTNxRGOVUm34EMR7RJt9alFbkGTN0X5byTjHGRu1CxrSl1p"}
|
Description |
Use this endpoint to cancel a pending eSignature request. |
|
|---|---|---|
|
URI Endpoint |
/rest/v16//commerceDocumentsOraclecpqoTransaction/{id}/actions/_action_esig_cancel |
|
| Endpoint Parameters |
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 |
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. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/20487343/actions/_action_esig_cancel
{ "esigAttrSetVarName": "eSignatureAttributeSet1_esig_set", "documents": { "_eSignatureAttributeSet1_esig_recipients": "John Doe<john.doe@oracle.com>;", "quoteDescription": "abcquote", "_eSignatureAttributeSet1_esig_file_attachment": { "fileID": "20600546", "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "isFileSaved": false, "fileName": "DocuSignTestDocument2Signers.docx" }, "criteria": { "state": true, "childDefs": [{ "name": "lineItem", "queryDef": { "state": true } } ] } } }
{ "documents": { "_eSignatureAttributeSet1_esig_recipients": "John Doe<john.doe@oracle.com>;", "_eSignatureAttributeSet1_esig_file_attachment": { "fileID": "20600546", "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "isFileSaved": false, "fileName": "DocuSignTestDocument2Signers.docx" }, "_eSignatureAttributeSet1_esig_envelope_id": null, "_eSignatureAttributeSet1_esig_date_modified": "2018-03-11T20:28:44Z", "_eSignatureAttributeSet1_esig_status": { "value": "Cancelled", "displayValue": "Cancelled" }, "sub": {}, "links": [{ "rel": "self", "href": "../rest/v16/commerceDocumentsTestMain/20905405" } ], "_state": {} }, "warnings": {} }
|
Description |
Use this endpoint to connect and view the eSignature related details from an integrated site, such as DocuSign. |
|
|---|---|---|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_action_esig_details |
|
| Endpoint Parameters |
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 |
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. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/_action_esig_details
{ "esigAttrSetVarName": "eSignatureAttributeSet1_esig_set", "documents": { "_eSignatureAttributeSet1_esig_recipients": "John Doe<john.doe@oracle.com>;", "quoteDescription": "abcquote", "_eSignatureAttributeSet1_esig_file_attachment": { "fileID": "20600546", "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "isFileSaved": false, "fileName": "DocuSignTestDocument2Signers.docx" }, "criteria": { "state": true, "childDefs": [{ "name": "lineItem", "queryDef": { "state": true } } ] } } }
{ ... "destinationNewWindowURL": "https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=4afcbf24-2808-4e61-8107-496f7bd9410b&DocuEnvelope=95f8dd4d-af4c-47b4-87ec-d0c523989385" ... }
|
Description |
Use this endpoint to send eSignature documents to recipients. |
|
|---|---|---|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_action_esig_send |
|
| Endpoint Parameters |
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 |
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. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/20563735/actions/_action_esig_send
{ "esigAttrSetVarName": "eSignatureAttributeSet1_esig_set", "documents": { "_eSignatureAttributeSet1_esig_recipients": "John Doe<john.doe@oracle.com>;", "quoteDescription": "abcquote", "_eSignatureAttributeSet1_esig_file_attachment": { "fileID": "20600546", "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "isFileSaved": false, "fileName": "DocuSignTestDocument2Signers.docx" }, "criteria": { "state": true, "childDefs": [{ "name": "lineItem", "queryDef": { "state": true } } ] } } }
{ "documents": { "_eSignatureAttributeSet1_esig_recipients": "John Doe<john.doe@oracle.com>;", "_eSignatureAttributeSet1_esig_file_attachment": { "fileID": "20600546", "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "isFileSaved": false, "fileName": "DocuSignTestDocument2Signers.docx" }, "_eSignatureAttributeSet1_esig_envelope_id": "5d28d6ca-0f7d-41d4-a1f1-fa12184a7b07", "_eSignatureAttributeSet1_esig_date_modified": "2018-03-11T20:16:44Z", "_eSignatureAttributeSet1_esig_status": { "value": "Pending", "displayValue": "Pending" }, "quoteDescription": "abcquote", "sub": {}, "links": [{ "rel": "self", "href": "../rest/v16/commerceDocumentsTestMain/20905405" } ], "_state": {} }, "warnings": {} }
|
Description |
Use this endpoint to export an Oracle CPQ generated document. |
|
|---|---|---|
|
URI Endpoint |
/rest/v16//commerceDocumentsOraclecpqoTransaction/{id}/actions/exportAttachment |
|
| Endpoint Parameters |
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: |
|
|
Response Body Parameters |
The JSON Transaction Data |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/actions/exportAttachment
{ "documents": { "quoteDescription": "updated quote description", "lineItem": { "items": [{ "_price_quantity": 304, "_document_number": 3 } ] } } }
| Export Transactions |
||
|---|---|---|
|
Description |
Use this endpoint to export the specified data column values for all the specified transactions in a zipped excel file. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_export_transactions |
|
| Endpoint Parameters |
None |
|
|
Request Body Parameters
|
selectionCriteria |
Captures the query definition for resource requests, specifically for collection-based process actions. |
|
This operation supports the following optional parameters: |
||
|
HTTP Method |
POST |
|
|
Response Body Parameters |
The file URL to retrieve the exported transactions zip file. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_export_transactions
{ "selectionCriteria": { "search": "_my_approval_search", "orderby": ["_id:desc", "searchViewName:asc"], "fields": ["_id", "_lock_status", "bs_id", "processManagerFloat"] } }
{ "warnings": {}, "fileUrl": "https://sitename.oracle.com/rest/v16/commerceExports/filename.zip" }
| 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/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/generateProposal |
|
| Endpoint Parameters |
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 |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18097326/actions/generateProposal
Get All Available Rate Plans |
||
|---|---|---|
|
Description |
Use this endpoint to retrieve a list of Available Rate Plans for the specified transaction line. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/_availableRatePlanSet |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
| Query Parameters |
This endpoint supports the following optional parameters: |
|
|
HTTP Method |
GET |
|
| Request Body Parameters |
None |
|
|
Success Response |
The response contains a collection of the available rate plans for the specified transaction line. |
|
Get All Transaction Line Charges
| Get All Transaction Line Charges |
||
|---|---|---|
|
Description |
Use this endpoint to retrieve all charges for the specified transaction line. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/_chargeSet |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
| Query Parameters |
This endpoint supports the following optional parameters: |
|
|
HTTP Method |
GET |
|
| Request Body Parameters |
None |
|
|
Success Response |
The response contains a collection of charge sets for the specified transaction line. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2/_chargeSet
{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2/_chargeSet" } ], "items": [{ "_chargeSet_chargeType": { "displayValue": "Activation Fee", "value": "activationFee_c" }, "_sequence_number": 1, "_chargeSet_calculationInfo": "[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price Model\",\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"Base Pricing Rule\",\"_runningUnitPrice\":250.0}]", "_chargeSet_netAmount": { "value": 250.0, "currency": "USD" }, "_chargeSet_rateCardInHTML": null, "_chargeSet_chargeDefinitionCode": "activationFee_c", "_chargeSet_pricePeriod": { "displayValue": "Per Month", "value": "Per Month" }, "_row_number": 1, "_chargeSet_discountValue": null, "_chargeSet_rateCardName": null, "_chargeSet_usageUOM": null, "_chargeSet_rateCardStructure": null, "_chargeSet_netPrice": { "value": 250.0, "currency": "USD" }, "_chargeSet_dynamicPricingType": "static", "_chargeSet_discountType": null, "_chargeSet_rateCardVariableName": null, "_transaction_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_chargeSet_chargeDefinition": "Activation Fee", "_chargeSet_chargeDefIntegrationId": "KI_ACTIVATION_CHARGE", "_chargeSet_discountAmount": { "value": 0.0, "currency": "USD" }, "_chargeSet_priceType": { "displayValue": "One Time", "value": "One Time" }, "_chargeSet_unitPrice": { "value": 250.0, "currency": "USD" }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2/_chargeSet/1" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2" } ] }, { "_chargeSet_chargeType": { "displayValue": "Data Charge", "value": "dataCharge_c" }, "_sequence_number": 2, "_chargeSet_calculationInfo": "[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price Model\",\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"Base Pricing Rule\"}]", "_chargeSet_netAmount": { "value": 0.0, "currency": "USD" }, "_chargeSet_rateCardInHTML": "<figure class=\"table\"><table style=\"border-collapse: collapse;\"><tbody><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\"><b>Usage From</b></td><td style=\"border:solid 1px;\"><b>Usage To</b></td><td style=\"border:solid 1px;\"><b>Rate</b></td></tr><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\">0</td><td style=\"border:solid 1px;\">100</td><td style=\"border:solid 1px;\">USD 0.9</td></tr><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\">100</td><td style=\"border:solid 1px;\">1000</td><td style=\"border:solid 1px;\">USD 0.8</td></tr><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\">1000</td><td style=\"border:solid 1px;\">null</td><td style=\"border:solid 1px;\">USD 0.5</td></tr></tbody></table></figure>", "_chargeSet_chargeDefinitionCode": "dataUsage_c", "_chargeSet_pricePeriod": { "displayValue": "Per Month", "value": "Per Month" }, "_row_number": 2, "_chargeSet_discountValue": null, "_chargeSet_rateCardName": "Supremo Remote Access Volume Rates", "_chargeSet_usageUOM": { "displayValue": "Gb", "value": "gb_c" }, "_chargeSet_rateCardStructure": "{\"type\":\"rateCard\",\"name\":\"Supremo Remote Access Volume Rates\",\"variableName\":\"supremoRemoteAccessVolumeRates\",\"schema\":{\"columns\":[{\"name\":\"Usage From\",\"variableName\":\"from\",\"dataType\":\"Integer\",\"translations\":[]},{\"name\":\"Usage To\",\"variableName\":\"to\",\"dataType\":\"Integer\",\"translations\":[]},{\"name\":\"Rate\",\"variableName\":\"rate\",\"dataType\":\"Currency\",\"translations\":[]}],\"lookupData\":[]},\"data\":[{\"rate\":{\"currency\":\"USD\",\"value\":0.9},\"from\":0,\"to\":100},{\"rate\":{\"currency\":\"USD\",\"value\":0.8},\"from\":100,\"to\":1000},{\"rate\":{\"currency\":\"USD\",\"value\":0.5},\"from\":1000}]}", "_chargeSet_netPrice": { "value": 0.0, "currency": "USD" }, "_chargeSet_dynamicPricingType": "rateCard", "_chargeSet_discountType": null, "_chargeSet_rateCardVariableName": "supremoRemoteAccessVolumeRates", "_transaction_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_chargeSet_chargeDefinition": "Data Usage", "_chargeSet_chargeDefIntegrationId": "KI_DATA_CHARGE", "_chargeSet_discountAmount": { "value": 0.0, "currency": "USD" }, "_chargeSet_priceType": { "displayValue": "Usage", "value": "Usage" }, "_chargeSet_unitPrice": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2/_chargeSet/2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2" } ] } ] }
| Get All Transaction Lines |
||
|---|---|---|
|
Description |
Use this endpoint to retrieve all transaction lines for the specified transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
| Query Parameters |
This endpoint supports the following optional parameters: |
|
|
HTTP Method |
GET |
|
| Request Body Parameters |
None |
|
|
Success Response |
The JSON data for the requested transaction lines. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/36365444/transactionLine
| Get All Transactions |
||
|---|---|---|
|
Description |
This operation retrieves all transactions. |
|
|
URI Endpoint |
/rest/v16//commerceDocumentsOraclecpqoTransaction |
|
|
Endpoint Parameters |
None |
|
| Query Parameters |
This endpoint supports the following optional parameters: Notes:
|
|
|
HTTP Method |
GET |
|
| Request Body Parameters |
None |
|
|
Success Response |
The JSON data for the requested transactions. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction
| Get Available Rate Plan |
||
|---|---|---|
|
Description |
Use this endpoint to retrieve the specified rate plan. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/_availableRatePlanSet/{_row_number} |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
_row_number |
Unique row number to be used to specify the rate plan. | |
| Query Parameters |
This endpoint supports the optional |
|
|
HTTP Method |
GET |
|
| Request Body Parameters |
None |
|
|
Success Response |
The response contains the available rate plan integration Id, available rate plan name, available rate plan number, and transaction currency preference. |
|
| Get History |
||
|---|---|---|
|
Description |
Use this endpoint to retrieve historical changes for a transaction using criteria defined in the request body. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/{displayHistoryActionVarName} |
|
| Endpoint Parameters |
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. |
|
This operation supports the following optional parameters: |
||
|
Response Body Parameters |
JSON data containing the transaction history | |
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18097326/actions/getHistory
Request Body Resources, Examples, and Sample
Resources
- historyHeader - used to specify fields for the history header in the response. Available fields:
dateFormatand_history_header_key - history - used to specify criteria for the history response. Available fields:
actionName,actionVarName,changeDate,userLogin,userFirstName,userLastName,userCompany,stepVarName,saved,resetReason,performComment,reasonVarName -
historyItem - used to specify attributes for history items included in the history response. Available fields:
attrName,attrVarName,docNumber,oldValue,newValue
Examples
-
history
"q": "{\"userLogin\":{\"$eq\" : \"superuser\"}}"
"q": "{ $or: [ { \"userLogin\": { $eq: \"superuser\" }}, { \"actionVarName\": { $eq: \"_update_line_items\" }} ] }"
"q": "{\"actionVarName\":{\"$exists\" : true}}"
"q":"{\"changeDate\":{\"$lt\":\"2020-06-30\"}}"
-
historyItem
"q": "{\"attrVarName\":{\"$eq\" : \"autoUpdateHidingConditionSubDoc\"}}"
"q": "{\"attrName\":{\"$eq\" : \"Price Book Custom Field Text\"}}"
Request Body Sample
{ "cacheInstanceId": "-1", "criteria": { "childDefs": [{ "name": "historyHeader", "queryDef": { "fields": ["dateFormat", "_history_header_key"], "childDefs": [{ "name": "history", "queryDef": { "q": "{\"userLogin\":{\"$eq\" : \"superuser\"}}", "limit": 2, "offset": 0, "fields": ["_history_key", "actionName"], "childDefs": [{ "name": "historyItem", "queryDef": { "limit": 2, "offset": 0, "fields": ["attrName", "attrVarName", "docNumber", "oldValue", "newValue", "_history_item_key"] } } ] } } ] } } ] } }
{ "revisionId": "6,1", "documents": { "_id": 3023033799, "historyHeader": { "hasMore": false, "items": [{ "dateFormat": "MM/dd/yyyy h:mm a", "_history_header_key": 1, "history": { "offset": 0, "limit": 2, "count": 1, "hasMore": false, "items": [{ "_history_key": 3023040162, "actionName": "Save", "actionVarName": "saveWithAdvancedValidation", "changeDate": "06/13/2023 6:30 p", "userLogin": "superuser", "userFirstName": "Super", "userLastName": "User", "userCompany": "cpqqa212", "stepVarName": "start_step", "saved": null, "resetReason": null, "performComment": "-N/A-", "reasonVarName": null, "historyItem": { "offset": 0, "limit": 2, "count": 2, "hasMore": true, "items": [{ "attrVarName": "_price_net_price", "newValue": "3", "_history_item_key": "_price_net_price2", "docNumber": 2, "oldValue": "1", "attrName": "Net Price" }, { "attrVarName": "_transaction_total", "newValue": "2269", "_history_item_key": "_transaction_total1", "docNumber": 1, "oldValue": "2267", "attrName": "Transaction Total (Net)" } ] } } ] } } ] } } }
| Get Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to retrieve the specified transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id} |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
| Query Parameters |
This endpoint supports optional |
|
|
HTTP Method |
GET |
|
| Request Body Parameters |
None |
|
|
Success Response |
The JSON data for the requested transaction. Attributes returned are based on the user's access. If an attribute is defined to be not accessible by the user within Commerce (for example, it is marked as Hide in the Document Views tab of the attribute), the JSON response will not include the attribute-value pair for that attribute.
|
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18097326
| Get Transaction Line |
||
|---|---|---|
|
Description |
Use this endpoint to retrieve the specified transaction line. |
|
|
URI Endpoint |
/rest/v16commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber} |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
| Query Parameters |
This endpoint supports optional |
|
|
HTTP Method |
GET |
|
| Request Body Parameters |
None |
|
|
Success Response |
The JSON data for the requested transaction line. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/36365444/transactionLine/2
| Get Transaction Line Charge |
||
|---|---|---|
|
Description |
Use this endpoint to retrieve the specified charge for a transaction line. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/_chargeSet/{_row_number} |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
_row_number |
Unique row number to be used as a charge identifier in an charge set. | |
| Query Parameters |
This endpoint supports the optional |
|
|
HTTP Method |
GET |
|
| Request Body Parameters |
None |
|
|
Success Response |
The JSON data for the requested transaction line charge set. |
|
http://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/actions_aggregate
{ "aggregate": { "attr": "processManagerSSM", "limit": 20 }, "criteria": { "fields": ["_customer_id", "_id", "_date_modified"], "limit": 100, "totalResults": true, "q": "{'_customer_id':{$ne:'account112'}}", "orderby": ["_date_modified"] } }
{ "groups": [{ "groupName": "", "totalCount": 808, "nextlink": { "rel": "next", "href": "http://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction?offset=100&limit=100&q={\"_customer_id\":{\"$ne\":\"account112\"},\"processManagerSSM\":{\"$exists\":false}}&fields=_customer_id,_id&totalResults=true" } }, { "groupName": "value1", "totalCount": 3, "nextlink": { "rel": "self", "href": "http://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction?offset=0&limit=100&q={\"_customer_id\":{\"$ne\":\"account112\"},\"processManagerSSM\":\"value1\"}&fields=_customer_id,_id&totalResults=true" } }, { "groupName": "value2", "totalCount": 2, "nextlink": { "rel": "self", "href": "http://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction?offset=0&limit=100&q={\"_customer_id\":{\"$ne\":\"account112\"},\"processManagerSSM\":\"value2\"}&fields=_customer_id,_id&totalResults=true" } } ], "primaryResults": { "totalResults": 808, "offset": 0, "limit": 100, "count": 100, "hasMore": true, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction" } ], "items": [{ "_customer_id": "SpecialAccount6", "_id": 15555314, "links": [{ ... ], }, { "_customer_id": "SpecialAccount6", "_id": 15556582, "links": [{ ... ] }, ... ] } }
| Interact - Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to modify transaction attribute values, and optionally triggers auto-update rules without committing or retrieving the latest data from the database. Since this action does not save the transaction to the CPQ database, it does not affect how other users see the transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_interact |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
HTTP Method |
POST |
|
|
Request Body Parameters
|
deleteRows |
Used to select specific items for deletion. |
|
focus |
The attribute that the user is currently editing. The format matches that of the triggerAttrVarName parameter. If the value of the focus param is empty string, the user will be considered to be focused on no attribute | |
|
refreshCache |
Allows users to invoke the interact service without prior initiation of a cache instance on the server. Additionally, administrators can pass a new parameter, "refreshCache" = true, to reload the current cache and discard the changes. | |
|
triggerAttrVarName |
The attribute which trigger the interact action. When the trigger attribute is in current document, it is the variable name of the attribute. |
|
This operation supports the following optional parameters: cacheInstanceId, criteria, delta, documents, and revisionId.Refer to Request Body Objects for additional information. |
||
|
Response Body Parameters |
The requested cached transaction is returned |
|
Modify Item in Cache
Interact with an item within transaction 18330547
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18330547/actions/_interact
Retrieve a cache instance, modify the "_price_quantity" for transaction line 2, and save the updates to cache using "transactionLine/2/_price_quantity" as the triggering attribute
{ "cacheInstanceId": "E9JuyC9QCgTDS9edghTNxRGOVUm34EMR7RJt9alFbkGTN0X5byTjHGRu1CxrSl1p", "triggerAttrVarName": "transactionLine/2/_price_quantity", "documents": { "transactionLine": { "items": [{"_price_quantity": "100", "_document_number": "2"}] } } }
Re-Sequence Line Items via Interact
This action re-sequences Transaction Lines via the interact action.
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/actions/_interact
{ "cacheInstanceId": "3VSdeAMI1mjG0EHV72FfsvaMSXFhEiN7NIIYPt8qc0qXSuHOMypodFVi0vomLJ7d", "documents": { "sub": { "items": [{ "_sequence_number": "5", "_document_number": "2" } ] } }, "criteria": { "state": false, "fields": ["_id"], "childDefs": [{ "name": "sub", "queryDef": { "state": false, "limit": 10, "offset": 0, "totalResults": true, "enableHierarchy": true, "expandNodes": true, "nodesExceptionList": [], "orderby": ["_sequence_number:ASC"], "fields": ["_sequence_number", "_part_number", "_document_number"] } } ], "expandedDomains": [] } }
| Lock Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to lock a single transaction to prevent other users from editing it. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/lockTransaction |
|
| Endpoint Parameters |
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: |
|
|
Success Response |
The JSON data for the requested transaction |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18097326/actions/lockTransaction
| My Approval Search |
||
|---|---|---|
|
Description |
This endpoint retrieves a user's pending approvals waiting in a queue when there are quotes they need to approve. |
|
|
URI Endpoint |
/rest/v16//commerceDocumentsOraclecpqoTransaction/actions/_my_approval_search |
|
| Endpoint Parameters |
None |
|
|
Request Body Parameters
|
criteria |
Captures the query definition for resource requests. Refer to Criteria Object for additional information. |
|
HTTP Method |
POST |
|
|
Response Body Parameters |
The file URL to retrieve the exported transactions zip file. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_my_approval_search
{ "criteria": { "fields": [ "projectName", "_id", "_lock_status", "_currency_pref", "mainMathInput_Float1" ], "orderby": [ "_currency_pref:DESC", "projectName:ASC" ], "limit": 10, "offset": 20 } }
{ "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqo" } ], "items": [{ "_lock_status": null, "mainMathInput_Float1": null, "_currency_pref": { "id": 14619668, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_id": 3023106049, "projectName": "Super User's project 11/07/2023 08:13:39" }, { "_lock_status": null, "mainMathInput_Float1": null, "_currency_pref": { "id": 14619668, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_id": 3023123297, "projectName": "Super User's project 11/08/2023 22:06:16" }, { "_lock_status": null, "mainMathInput_Float1": null, "_currency_pref": { "id": 14619668, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_id": 3023123306, "projectName": "Super User's project 11/08/2023 22:06:16" }, { "_lock_status": null, "mainMathInput_Float1": null, "_currency_pref": { "id": 14619668, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_id": 3023120057, "projectName": "Super User's project 11/08/2023 07:43:34" }, { "_lock_status": null, "mainMathInput_Float1": null, "_currency_pref": { "id": 14619668, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_id": 3023120066, "projectName": "Super User's project 11/08/2023 07:43:54" }, { "_lock_status": null, "mainMathInput_Float1": null, "_currency_pref": { "id": 14619668, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_id": 3023123276, "projectName": "Super User's project 11/08/2023 21:53:31" }, { "_lock_status": null, "mainMathInput_Float1": null, "_currency_pref": { "id": 14619668, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_id": 3023123288, "projectName": "Super User's project 11/08/2023 22:05:37" }, { "_lock_status": null, "mainMathInput_Float1": null, "_currency_pref": { "id": 14619668, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_id": 3023123315, "projectName": "Super User's project 11/08/2023 22:06:16" }, { "_lock_status": null, "mainMathInput_Float1": 4.35, "_currency_pref": { "id": 14619668, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v16/currencies" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/currencies/USD" } ] }, "_id": 15555481, "projectName": "Test" } ] }
| Open Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to open a previously saved transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_open_transaction |
|
| Endpoint Parameters |
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, errorCriteria, revisionId, and skipIntegration.Refer to Request Body Objects for additional information. |
|
|
Success Response |
The JSON data for the requested transaction, or a subset of transaction items, depending on the input request |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18097326/actions/_open_transaction
| Open Transaction
Line |
||
|---|---|---|
|
Description |
Use this endpoint to display the Line Items Details for a specified transaction line. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_open_transactionLine |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
HTTP Method |
POST |
|
|
Request Body Parameters |
selections |
Required, use to specify the transaction line to open. This action only accepts a single line selection. |
|
selectionNavigation |
Use this parameter to navigate between line item detail pages. Supported values are: When query parameters are provided, the navigation flow is within the filtered and/or sorted line items. |
|
This operation supports the following optional parameters: cacheInstanceId, criteria, documents, errorCriteria, revisionId, selectionMode, and skipIntegration.Refer to Request Body Objects for additional information. |
||
|
Response Body Parameters |
The JSON data for the parent transaction, or a subset of transaction items, depending on the input request |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18094477/actions/_open_transactionLine
{ "selections": ["transactionLine/3"] }
Request Body Sample with Selection Navigation
{ "cacheInstanceId": "bDYxrCAnUwiVpYXUGDoT1GilCF0CFMPEGTcuKCPER3QFuxHJf33AYtAU1atZItpt", "selections": ["transactionLine/12"], "selectionNavigation": "next" } }
| Orders - Cancel Order |
||
|---|---|---|
|
Description |
Use this endpoint to set the transaction status and the commerce step for this transaction to 'Canceled'. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_cancel |
|
| Endpoint Parameters |
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: |
|
|
Response Body |
The JSON Transaction data |
|
/rest/v16/commerceDocumentsOraclecpqoTransaction/18103143/actions/order_cancel
| Orders - Change Order |
||
|---|---|---|
|
Description |
Use this endpoint to initiate a Change Order that reflects updates to a Sales Order previously placed with an external fulfillment system. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_change |
|
| Endpoint Parameters |
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: |
|
|
Response Body |
The JSON Transaction data |
|
/rest/v16/commerceDocumentsOraclecpqoTransaction/18103143/actions/order_change
| Orders - Create Order |
||
|---|---|---|
|
Description |
Use this endpoint to create a sales order for submission to an external fulfillment system. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_start |
|
| Endpoint Parameters |
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: |
|
|
Response Body |
The JSON Transaction data |
|
/rest/v16/commerceDocumentsOraclecpqoTransaction/18103143/actions/order_start
Orders - Place Alternate Order
| Orders - Place Alternate Order |
||
|---|---|---|
|
Description |
Use this endpoint to transition the transaction to the 'Alternate Version Ordered' step. This action is used to record that this version is no longer active. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_alternate |
|
|
MainDocVarName |
The variable name of the main document, note the first letter must be capitalized. |
|
| Endpoint Parameters |
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: |
|
|
Response Body |
The JSON Transaction data |
|
/rest/v16/commerceDocumentsOraclecpqoTransaction/18103143/actions/order_alternate
| Orders - Reject Order |
||
|---|---|---|
|
Description |
Use this endpoint to transition the Commerce Step for this transaction to 'Rejected by Customer'. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_reject |
|
| Endpoint Parameters |
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: |
|
|
Response Body |
The JSON Transaction data |
|
/rest/v16/commerceDocumentsOraclecpqoTransaction/18103143/actions/order_reject
|
Description |
Use this endpoint to display the rules that are in effect for the current Commerce process. This operation returns both transaction and transaction line items. |
|
|---|---|---|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_pipelineViewer |
|
| Endpoint Parameters |
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 |
Optional, only valid cache instance ids are supported The "-1" value is not supported |
|
Response Body Parameters |
Pipeline Viewer rules and impacted main document and sub-document attributes and actions. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/actions/_pipelineViewer
{ "cacheInstanceId": "bDYxrCAnUwiVpYXUGDoT1GilCF0CFMPEGTcuKCPER3QFuxHJf33AYtAU1atZItpt" }
{ "pipelineViewerRules": [{ "name": "Hide Level 2 Reason Approver", "type": "Hiding Rule", "components": { "mainDoc": { "attributes": [{ "name": "Hiding Attribute 1", "variableName": "hidingAttribute1" }, { ... } ], "actions": [{ "name": "Hiding Action 1", "variableName": "hidingAction1" }, { ... } ] }, "subDoc": { "attributes": [{ "name": "Hiding Attribute 10", "variableName": "hidingAttribute10" }, { ... } ], "actions": [{ "name": "Hiding Action 10", "variableName": "hidingAction10" }, { ... } ] } } }, { "name": "Hide Level 3 Reason Approver", "type": "Hiding Rule", "components": { "mainDoc": { ... }, "subDoc": { ... } } } ] }
Pipeline Viewer - Transaction Line
|
Description |
Use this endpoint to display rules that are in effect for the current Commerce process. This action returns only transaction line items. |
|
|---|---|---|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/_pipelineViewer |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
cacheInstanceId |
Optional, only valid cache instance ids are supported. The "-1" value is not supported. |
|
Response Body Parameters |
Pipeline Viewer rules and impacted sub-document attributes and actions |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/transactionLine/2actions/_pipelineViewer
{ "cacheInstanceId": "bDYxrCAnUwiVpYXUGDoT1GilCF0CFMPEGTcuKCPER3QFuxHJf33AYtAU1atZItpt" }
{ "pipelineViewerRules": [{ "name": "Hiding: Unhide Rules- Hiding Panel Subdoc", "type": "Hiding Rule", "components": { "mainDoc": { "attributes": [], "actions": [] }, "subDoc": { "attributes": [ "Hiding Tab 3 Attribute 1 Subdoc [hidingTab3Attribute1Subdoc]", "Hiding Tab 1 Attribute 2 Subdoc [hidingTab1Attribute2Subdoc]", "Hiding Tab 2 Attribute 2 Subdoc [hidingTab2Attribute2Subdoc]", "Hiding Tab 1 Attribute 1 Subdoc [hidingTab1Attribute1Subdoc]" ], "actions": [] } } }, { "name": "Composite Sub Hiding", "type": "Hiding Rule", "components": { "mainDoc": { ... }, "subDoc": { ... } } }, { "name": "Constrain Commerce BOM Attribute Mapping Rules - Float to Float", "type": "Constraint Rule", "components": { "mainDoc": { ... }, "subDoc": { ... } } } ] }
In the Oracle CPQ application, the print feature is implemented using a two-step process. The first step modifies the transaction for print. The second step prints the transaction, using the data collected during modification.
| Modify a Transaction for Print |
||
|---|---|---|
|
Description |
Use this endpoint to modify and save a transaction for print. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/{printActionVarName} |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
printActionVarName |
The variable name of the print preparation action |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
documents and cacheInstanceId are optionalRefer to Request Body Objects for additional information |
|
|
Success Response |
Returns the transaction, XSL views, available attachments for merge, generated proposal attachment for merge, and the cache instance ID (if requested) |
|
|
Response Body Parameters |
xslView |
Printer friendly proposals or history outputs generated from predefined XSL templates |
|
availableAttachmentsForMerge |
The list of attachments which can be merged with the print document |
|
|
generatedProposalAttachmentForMerge |
The Attachment Selected by Default. The default ID value for the transaction is -2. |
|
|
fileAttachmentAttribute |
The file to be printed |
|
|
cacheInstanceId |
The cache instance ID, if requested |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/transactionPrintAction
Change language to German, update the price quantity for documents 2 and 3, and load the complete transaction to the user's cache.
"documents": { "languageForEmailAndPrint": "de", "transactionLine": { "items": [{ "_price_quantity": 33, "_document_number": 3 }, { "_price_quantity": 22, "_document_number": 2 } ] } }, "cacheInstanceId": "-1" }
{ "documents": { "items": [{ "languageForEmailAndPrint": "de", "transactionLine": { "items": [{ "_price_quantity": 33, "_document_number": 3 }, { "_price_quantity": 22, "_document_number": 2 } ] } } ] }, "xslView": "XSL for Multi-Languages for Email and Print(Printer Friendly/History)", "generatedProposalAttachmentForMerge": [{ "id": "-2", "name": "GENERATED PROPOSAL" } ], "availableAttachmentsForMerge": [{ "id": "18763342", "name": "Merge1.pdf (Quote - Attach for File Merge)" }, { "id": "18763344", "name": "Merge3.pdf (Quote - fa_includeFromPDFMerge)" }, { "id": "18763576", "name": "Merge1.pdf (Line Item{1} - File Attachment Sub Doc 1)" }, { "id": "18763577", "name": "Merge2.pdf (Line Item{1} - File Attachment Sub Doc 2)" } ], "fileAttachmentAttribute": "File Attachment", "cacheInstanceId": "sKtuHHB4bc2LkKSjmJEK6Gl2xaRXI49bOWCWjuwOPMDcqRYyhEn355YbKRQ3fbcs" }
| Print Transaction Document |
||
|---|---|---|
|
Description |
Use this endpoint to print the generated transaction document. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_print_document |
|
| Endpoint Parameters |
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 print preparation action variable name |
|
attachmentsIdsForMerge |
The attachment IDs to merge |
|
|
cacheInstanceId |
The cache instance ID |
|
|
saveToQuote |
Indicates if the print document is saved to the transaction, valid values are {true, false} Note: If this value conflicts with the setting in the print action (e.g. the
"Save Document Upon Printing - Desktop", an error is returned.
|
|
|
updateQuoteWithAttachment |
Indicates if quote has to be updated with print document attachment file, valid values are {true, false} | |
|
Success Response |
Application/PDF format summary message for printing transaction The response is in application/PDF format by default. To receive the response in JSON format, the "Accept: application/json" header is required.
|
|
|
Response Body Parameters |
fileContent |
The Base64 encoded binary document value |
|
fileContentType |
The file content type |
|
|
fileTitle |
The file name used when saving to the transaction file attachment attribute, or when downloading the file |
|
|
fileAttachmentAttribute |
Used for confirmation |
|
|
cacheInstanceId |
The cache instance ID |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/_print_document
{ "actionVariableName": "transactionPrintAction", "saveToQuote": "true", "attachmentIdsForMerge": ["-2", "18763342", "18763344", "18763576", "18763577"], "cacheInstanceId": "sKtuHHB4bc2LkKSjmJEK6Gl2xaRXI49bOWCWjuwOPMDcqRYyhEn355YbKRQ3fbcs" }
{ "fileContent": "base64 encoded binary document value here", "fileContentType": "application/pdf", "fileTitle": "Document.pdf", "fileAttachmentAttribute": "File Attachment", "cacheInstanceId": "sKtuHHB4bc2LkKSjmJEK6Gl2xaRXI49bOWCWjuwOPMDcqRYyhEn355YbKRQ3fbcs" }
Print a Transaction Line Document
In the Oracle CPQ application, the print feature is implemented using a two-step process. The first step modifies the transaction line for print. The second step prints the transaction, using the data collected during modification.
|
Modify Transaction Line for Print |
||
|---|---|---|
|
Description |
Use this endpoint to modify and save transaction lines for print. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/{printActionVarName} |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
printActionVarName |
The variable name of the print preparation action |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
documents and cacheInstanceIdare optionalRefer to Request Body Objects for additional information |
|
|
Success Response |
Returns the transaction line, XSL views, available attachments for merge, generated proposal attachment for merge, and the cache instance ID (if requested) |
|
|
Response Body Parameters |
documents |
The JSON transaction |
|
xslView |
Printer friendly proposals or history outputs generated from predefined XSL templates |
|
|
availableAttachmentsForMerge |
The list of attachments which can be merged with the print document |
|
|
generatedProposalAttachmentForMerge |
The Attachment Selected by Default. The default value for the transaction is -2. |
|
|
fileAttachmentAttribute |
The file to be printed |
|
|
cacheInstanceId |
The cache instance ID, if requested |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/transactionLine/3/actions/linePrintAction
{ "documents": {"_price_quantity": 101}, "cacheInstanceId": "-1" }
{ "documents": { "items": [{ "_price_quantity": 101, "_document_number": 2 } ] }, "xslView": "Print RTE (PDF)(Printer Friendly/History)", "generatedProposalAttachmentForMerge": [{ "id": "-2", "name": "GENERATED PROPOSAL" } ], "availableAttachmentsForMerge": [{ "id": "18763576", "name": "Merge1.pdf (Transaction Line - File Attachment Sub Doc 1)" }, { "id": "18763577", "name": "Merge2.pdf (Transaction Line - File Attachment Sub Doc 2)" } ], "fileAttachmentAttribute": "File Attachment", "cacheInstanceId": "8ddwWVX37LMIC9oO1zs0ZOFkmUp93ZFxL5v9s2hT2p1q6Zmph9u1LKjkRLIOasNo" }
|
Print a Transaction Line Document |
||
|---|---|---|
|
Description |
Use this endpoint to print the generated transaction line document. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/_print_document |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
actionVariableName |
The print preparation action variable name |
|
saveToQuote |
Indicates if the print document is saved to the transaction, valid values are {true, false} If this value conflicts with the setting in the print action (e.g. the
"Save Document Upon Printing - Desktop", an error is returned.
|
|
|
attachmentsIdsForMerge |
The attachment IDs to merge |
|
|
cacheInstanceId |
The cache instance ID |
|
|
Success Response |
JSON with summary message for printing transaction |
|
|
Response Body Parameters |
fileContent |
The Base64 encoded binary document value |
|
fileContentType |
The file content type |
|
|
fileTitle |
The file name used when saving to the transaction file attachment attribute, or when downloading the file |
|
|
fileAttachmentAttribute |
Used for confirmation |
|
|
cacheInstanceId |
The cache instance ID |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/transactionLine/2/actions/_print_document
{ "documents": { "actionVariableName": "linePrintAction", "saveToQuote": "true", "attachmentIdsForMerge": ["-2", "18763576", "18763577"] }, "cacheInstanceId": "8ddwWVX37LMIC9oO1zs0ZOFkmUp93ZFxL5v9s2hT2p1q6Zmph9u1LKjkRLIOasNo" }
{ "fileContent": "base64 encoded binary document value here", "fileContentType": "application/pdf", "fileTitle": "Document.pdf", "fileAttachmentAttribute": "File Attachment", "cacheInstanceId": "8ddwWVX37LMIC9oO1zs0ZOFkmUp93ZFxL5v9s2hT2p1q6Zmph9u1LKjkRLIOasNo" }
| Reconfigure Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to edit a configuration after its been added to the transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_reconfigure_action |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
HTTP Method |
POST |
|
|
Request Body Parameters |
selections |
Required, used to specify the transaction line to reconfigure This action only accepts a single line selection
|
|
This operation supports the following optional parameters: |
||
|
Response Body |
The response contains the Destination URL, which can be used to launch the product catalog page to select and configure a product. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/actions/_reconfigure_action
{ "documents": {"displayHistoryLanguage": "en"}, "selections": ["transactionLine/2"] }
{ "destinationURL": "https://sitename.oracle.com/commerce/buyside/reconfig_form.jsp?action_id=4356762&doc_number=1&document_id=4356178&id=18016533&destination_url=&_line_item_list=2", "documents": { "conditionsOperatorsHelp": null, "formulaContains": null, "reconfigureFormulasInbound": "0" } }
Reconfigure Transaction - Inbound
| Reconfigure Transaction - Inbound |
||
|---|---|---|
|
Description |
Use this endpoint when saving the reconfiguration of a transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_reconfigure_inbound_action |
|
| Endpoint Parameters |
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: |
|
|
Response Body |
The response contains the cache instance Id, revision Id, and warnings. |
|
| Reconfigure Transaction Line |
||
|---|---|---|
|
Description |
Use this endpoint to edit a configuration after its been added to the transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/_reconfigure_action |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
This operation supports the following optional parameters: |
|
|
Response Body |
The response contains the "Destination URL", which can be used to launch the product catalog page to select and configure a product. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/transactionLine/2/actions/_reconfigure_action
{
"documents": {"_price_quantity": "20"}
}
{
"destinationURL": "https://sitename.oracle.com/commerce/buyside/reconfig_form.jsp?action_id=4356762&doc_number=1&document_id=4356178&id=18016533&destination_url=&_line_item_list=2",
"documents": {
"orderOfOpsInputSubDoc": null,
"_line_bom_item_quantity": null,
"copyLineProductsInitializationMSM": "Value 3~Value 4"
}
}
Reconfigure Transaction Line - Inbound
| Reconfigure Transaction Line - Inbound |
||
|---|---|---|
|
Description |
Use this endpoint when saving the reconfiguration of a transaction line. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/_reconfigure_inbound_action |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
This operation supports the following optional parameters: |
|
|
Response Body |
The response contains the cache instance Id, revision Id, and warnings. |
|
| Refresh Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to refresh the current transaction with last saved data; the refresh action removes the existing values and replaces with the last saved data. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/refresh |
|
| Endpoint Parameters |
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, and revisionId.Refer to Request Body Objects for additional information. |
|
|
Response Body |
The JSON data for the requested transaction, or a subset of transaction items, depending on the input request. |
|
https://sitename.oracle.com/rest/v16/commerceDoucmentsTransaction2Quote/18097326/actions/refresh
{ "cacheInstanceId":"-1" }
| Save Transaction |
||
|---|---|---|
|
Description |
Use this endpoint to save the current state of the transaction (which may have been edited in the UI) to the CPQ database. |
|
|
URI Endpoint |
/rest/v16//commerceDocumentsOraclecpqoTransaction/{id}/actions/cleanSave_t |
|
| Endpoint Parameters |
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: Refer to Request Body Objects for additional information |
|
|
Response Body |
The JSON data for the saved transaction. |
|
/rest/v16/commerceDocumentsOraclecpqoTransaction/36365444/actions/cleanSave_t
| Save Transaction Line |
||
|---|---|---|
|
Description |
Use this endpoint to save the current state of the line item to the database. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/save_l |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information |
|
|
Response Body |
The JSON data for the saved transaction. |
|
| Save Transaction Version |
||
|---|---|---|
|
Description |
Use this endpoint to invoke a special Save action used to save a transaction version. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/versionSave_t |
|
| Endpoint Parameters |
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: Refer to Request Body Objects for additional information |
|
|
Response Body |
The JSON data for the saved transaction version. |
|
In the Oracle CPQ application, the email feature is implemented using a two-step process. The first action modifies the transaction and returns the objects required to send an email. The second action generates the email attachment and sends the email.
|
Modify Transaction for Email |
||
|---|---|---|
|
Description |
Use this endpoint to modify and save a transaction for email. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/{emailActionVarName} |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
emailActionVarName |
The variable name of the modify email action |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information |
|
|
Success Response |
Returns the transaction, email fields, XSL views, attachments, available attachments for merge, generated proposal attachment for merge, and the cache instance ID (if requested) |
|
|
Response Body Parameters |
ccEmail |
cc email address(es) |
|
fromName |
The sender's name |
|
|
fromEmail |
The sender's email address |
|
|
subject |
The email subject line |
|
|
bccEmail |
bcc email address(es) |
|
|
toEmail |
The recipient's email address(es) |
|
|
toName |
The recipient's name |
|
|
comments |
Comments to be sent in the email body |
|
|
xslView |
Printer friendly proposals or history outputs generated from predefined XSL templates |
|
|
attachments |
Attachments to send with the email |
|
|
availablAttachmentsForMerge |
The list of attachments which can be merged with the proposal document |
|
|
generatedProposalAttachmentForMerge |
The proposal attachment selected by default. The default ID value for the transaction is -2. |
|
|
cacheInstanceId |
The cache instance ID, if requested |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/transactionEmailAction
Change language to German, update the price quantity for documents 2 and 3, and load the complete transaction to the user's cache.
{ "documents": { "languageForEmailAndPrint": "de", "transactionLine": { "items": [ {"_price_quantity": 33, "_document_number": 3}, {"_price_quantity": 22, "_document_number": 2} ] } }, "cacheInstanceId": "-1" }
{ "documents": { "items": [{ "languageForEmailAndPrint": "de", "transactionLine": { "items": [{ "_price_quantity": 33, "_document_number": 3 }, { "_price_quantity": 22, "_document_number": 2 } ] } } ] }, "ccEmail": null, "fromName": null, "fromEmail": "first.last@oracle.com", "subject": "testing subject", "bccEmail": null, "toEmail": "first.last@oracle.com", "toName": null, "comments": "testing comments", "xslView": "Print RTE (PDF)(Printer Friendly/History)", "generatedProposalAttachmentForMerge": [{ "id": "-2", "name": "GENERATED PROPOSAL" } ], "attachments": [{ "id": 18763342, "name": "Merge1.pdf" }, { "id": 18763343, "name": "Merge2.pdf" }, { "id": 18763344, "name": "Merge3.pdf" } ], "availableAttachmentsForMerge": [{ "id": "18763342", "name": "Merge1.pdf (Quote - Attach for File Merge)" }, { "id": "18763344", "name": "Merge3.pdf (Quote - fa_includeFromPDFMerge)" }, { "id": "18763576", "name": "Merge1.pdf (Line Item{1} - File Attachment Sub Doc 1)" }, { "id": "18763577", "name": "Merge2.pdf (Line Item{1} - File Attachment Sub Doc 2)" } ], "cacheInstanceId": "5J9MTQAbF1ZmcJGnul6y4WOrAydsRpSyR2vvW1o7fWkrEkO89aiFxbEQSIUCEnF4" }
| Send Email - Transaction |
||
|---|---|---|
|
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/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_send_email |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
HTTP Method |
POST |
|
|
Request Body Parameters |
fromName |
The sender's name |
|
ccEmail |
cc email address(es) |
|
|
subject |
The email subject line, this parameter is required to send email |
|
|
bccEmail |
bcc email address(es) |
|
|
toEmail |
The recipient's email address(es), this parameter is required to send email |
|
|
toName |
The recipient's name |
|
|
comments |
Comments to be sent in the email body |
|
|
actionVariableName |
The email action variable name |
|
|
attachmentIds |
The attachment IDs |
|
|
attachmentIdsForMerge |
The attachment IDs to merge |
|
|
cacheInstanceId |
The cache instance ID |
|
|
Response Body |
JSON with summary message for sending email |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/_send_email
{ "ccEmail": null, "fromName": null, "subject": "From REST: Quote Email Action Subject", "bccEmail": null, "toEmail": "firstname.lastname@oracle.com", "toName": null, "comments": "Comments for Quote Email", "actionVariableName": "quoteEmailAction", "attachmentIds": ["18763342", "18763343", "18763344"], "attachmentIdsForMerge": ["-2", "18763342", "18763577"], "cacheInstanceId": "5J9MTQAbF1ZmcJGnul6y4WOrAydsRpSyR2vvW1o7fWkrEkO89aiFxbEQSIUCEnF4" }
{ "message": "Your email was sent on 08/26/2016 4: 42PM", "cacheInstanceId": "5J9MTQAbF1ZmcJGnul6y4WOrAydsRpSyR2vvW1o7fWkrEkO89aiFxbEQSIUCEnF4" }
In the Oracle CPQ application, the email feature is implemented using a two-step process. The first action modifies the transaction line and returns the objects required to send an email. The second action generates the email attachment and sends the email.
|
Modify Transaction Line for Email |
||
|---|---|---|
|
Description |
Use this endpoint to modify and save transaction lines for email. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/{emailActionVarName} |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
emailActionVarName |
The variable name of the modify email action |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information |
|
|
Success Response |
Returns the transaction line, email fields, XSL views, attachments, available attachments for merge, generated proposal attachment for merge, and the cache instance ID (if requested) |
|
|
Response Body Parameters |
ccEmail |
cc email address(es) |
|
fromName |
The sender's name |
|
|
fromEmail |
The sender's email address |
|
|
subject |
The email subject line |
|
|
bccEmail |
bcc email address(es) |
|
|
toEmail |
The recipient's email address(es) |
|
|
toName |
The recipient's name |
|
|
comments |
Comments to be sent in the email body |
|
|
xslView |
Printer friendly proposals or history outputs generated from predefined XSL templates |
|
|
attachments |
Attachments to send with the email |
|
|
availableAttachmentsForMerge |
The list of attachments which can be merged with the proposal document |
|
|
generatedProposalAttachmentForMerge |
The proposal attachment selected by default. The default ID value for the transaction is -2. |
|
|
cacheInstanceId |
The cache instance ID, if requested |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/transactionLine/3/actions/lineEmailAction
{ "documents": {"_price_quantity": 101}, "cacheInstanceId": "-1" }
{ "documents": { "items": [{ "_price_quantity": 101, "_document_number": 2 } ] }, "cc_email": null, "from_name": null, "from_email": "firstname.lastname@oracle.com", "subject": "testing subject", "bcc_email": null, "to_email": "firstname.lastname@oracle.com", "to_name": null, "comments": "testing comments", "xsl_view": "Print RTE (PDF)(Printer Friendly/History)", "generatedProposalAttachmentForMerge": [{ "id": "-2", "name": "GENERATED PROPOSAL" } ], "attachments": [{ "id": 18763576, "name": "Merge1.pdf" }, { "id": 18763577, "name": "Merge2.pdf" } ], "availableAttachmentsForMerge": [{ "id": "18763576", "name": "Merge1.pdf (Line Item - File Attachment Sub Doc 1)" }, { "id": "18763577", "name": "Merge2.pdf (Line Item - File Attachment Sub Doc 2)" } ], "cacheInstanceId": "8ddwWVX37LMIC9oO1zs0ZOFkmUp93ZFxL5v9s2hT2p1q6Zmph9u1LKjkRLIOasNo" }
|
Send Email - Transaction Line |
||
|---|---|---|
|
Description |
This action collects 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/v16/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/actions/_send_email |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
documentNumber |
The sub-document number |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
fromName |
The sender's name |
|
ccEmail |
cc email address(es) |
|
|
subject |
The email subject line This parameter is required to send email. |
|
|
bccEmail |
bcc email address(es) |
|
|
toEmail |
The recipient's email address(es) This parameter is required to send email. |
|
|
toName |
The recipient's name |
|
|
comments |
Comments to be sent in the email body |
|
|
actionVariableName |
The email action variable name |
|
|
attachmentIds |
The attachment IDs |
|
|
attachmentIdsForMerge |
The attachment IDs to merge |
|
|
cacheInstanceId |
The cache instance ID |
|
|
Success Response |
JSON with summary message for sending email |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/transactionLine/3/actions/_send_email
{ "ccEmail": null, "fromName": null, "subject": "From REST: Line Email Action Subject", "bccEmail": null, "toEmail": "firstname.lastname@oracle.com", "toName": null, "comments": "Comments for Send Transaction Line Email", "actionVariableName": "lineEmailAction", "attachmentIds": ["18763576", "18763577"], "attachmentIdsForMerge": ["-2", "18763576", "18763577"], "cacheInstanceId": "8ddwWVX37LMIC9oO1zs0ZOFkmUp93ZFxL5v9s2hT2p1q6Zmph9u1LKjkRLIOasNo" }
{ "message": "Your email was sent on 08/26/2016 4: 42PM", "cacheInstanceId": "8ddwWVX37LMIC9oO1zs0ZOFkmUp93ZFxL5v9s2hT2p1q6Zmph9u1LKjkRLIOasNo" }
| Submit for Approval |
||
|---|---|---|
|
Description |
Use this endpoint to submits the transaction for approval. If no approvals are defined or triggered for the transaction, the status will move directly to the approved step. The Submit action set is a series of Commerce actions that are essentially sub-actions of Submit. The Submit action set is comprised of Submit, Request Approval, Approve, Reject, and Revise. If no approvals are defined or triggered for the transaction, the status will move directly to the 'Approved' step. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/submit_t |
|
| Endpoint Parameters |
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: Refer to Request Body Objects for additional information. |
|
|
Response Body |
The pending approval object. |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/1801963/actions/submit_t
{ "documents": { "approval_history_submit": "", "approval_status_submit": [{ "approverNames": ["superuser [slc09vel]"], "reasonName": "Always True Reason", "reasonVarName": "alwaysTrueReason" } ], "_step_var_name": "savedTransaction", "_submitted_by_submit": "superuser", "approve_reject_icon_submit": "", "approval_revision_submit": 1 } }
| Submit - Approve |
||
|---|---|---|
|
Description |
Use this endpoint when an approval sequence reason is approved by the approver. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/approve_submit_t |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
HTTP Method |
POST |
|
|
Request Body Parameters |
performer_comment |
Comment provided for approval. |
|
reason_var_name |
Approval reason. | |
|
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information. |
||
|
Response Body |
The JSON Transaction data |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsTransaction/1801963/actions/approve_submit_t
{ "performer_comment": "Approving the quote", "reason_var_name": "alwaysTrueReason", "documents": { ..., "approval_history_submit_t": [{ "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 1, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting quote for approval", "actionPerformed": "Submit" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 1, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "", "actionPerformed": "Revised" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 2, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting quote approval after revision", "actionPerformed": "Submit" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 2, "performerCompany": "slc09vel", "reasonName": "Always True Reason", "reasonVarName": "alwaysTrueReason", "performerComment": "Approving the quote", "actionPerformed": "Approve" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 2, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting quote approval after revision", "actionPerformed": "Approval Completed" } ], "approval_status_submit_t": "", "_step_var_name": "approvedQuote", "_submitted_by_submit_t": "superuser", "approve_reject_icon_submit_t": "", "approval_revision_submit_t": 2, ... } }
| Submit - Reject |
||
|---|---|---|
|
Description |
Use this endpoint when an approval sequence reason is approved by the approver. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/reject_submit_t |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
HTTP Method |
POST |
|
|
Request Body Parameters |
performer_comment |
Comment provided for rejecting request. |
|
reason_var_name |
Rejection reason. | |
|
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information. |
||
|
Response Body |
The JSON Transaction data |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/1801963/actions/reject_submit_t
{ "performer_comment": "Rejecting the quote", "reason_var_name": "alwaysTrueReason", "documents": { ..., "approval_history_submit_t": [{ "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 1, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting quote for approval", "actionPerformed": "Submit" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 1, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "", "actionPerformed": "Revised" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 2, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting quote approval after revision", "actionPerformed": "Submit" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 2, "performerCompany": "slc09vel", "reasonName": "Always True Reason", "reasonVarName": "alwaysTrueReason", "performerComment": "Approving the quote", "actionPerformed": "Approve" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 2, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting quote approval after revision", "actionPerformed": "Approval Completed" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 2, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "", "actionPerformed": "Revised" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 3, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting the quote for approval after revision", "actionPerformed": "Submit" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 3, "performerCompany": "slc09vel", "reasonName": "Always True Reason", "reasonVarName": "alwaysTrueReason", "performerComment": "Rejecting the quote", "actionPerformed": "Reject" } ], "approval_status_submit_t": "", "_step_var_name": "savedTransaction", "_submitted_by_submit_t": "superuser", "approve_reject_icon_submit_t": "", "approval_revision_submit_t": 3, ... } }
| Submit - Request Approval |
||
|---|---|---|
|
Description |
Use this endpoint to move the quote into an approval pathway. Request Approval is automatically initiated when the Submit action is invoked and there is a Reason to approve the quote. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/request_approval_submit_t |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
HTTP Method |
POST |
|
|
Request Body Parameters |
performer_comment |
Comment provided when requesting approval. |
|
reason_var_name |
Reason for requesting approval | |
|
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information. |
||
|
Response Body |
The JSON Transaction data |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsTransaction/1801963/actions/request_approval_submit_t
{ "performer_comment": "Requesting quote for approval", "documents": { ..."approval_history_submit_t": [{ "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 1, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting quote for approval", "actionPerformed": "Submit" } ], "approval_status_submit_t": [{ "approverNames": ["superuser [slc09vel]"], "reasonName": "Always True Reason", "reasonVarName": "alwaysTrueReason" } ], "_step_var_name": "underRevision", "_submitted_by_submit_t": "superuser", "approve_reject_icon_submit_t": [{ "rejectActionId": 15444715, "approveIcon": "/img/bmx/icons/tick.png", "rejectIcon": "/img/bmx/icons/cross.png", "approveActionLabel": "Approve[Submit Testbed]", "rejectIconLabel": "Reject[Submit Testbed]", "reasonName": "Always True Reason", "reasonVarName": "alwaysTrueReason", "approvalId": 19637132, "approveActionId": 15444717 } ], "approval_revision_submit_t": 1, ... } }
| Submit - Revise |
||
|---|---|---|
|
Description |
Use this endpoint to cancel an approval flow and permit revision of a transaction that has been submitted for approval. |
|
|
URI Endpoint |
/rest/v16commerceDocumentsOraclecpqoTransaction/{id}/actions/revise_submit_t |
|
| Endpoint Parameters |
id |
The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. |
|
HTTP Method |
POST |
|
|
Request Body Parameters
|
performer_comment |
Comment provided for revision. |
|
reason_var_name |
Revision reason. | |
|
This endpoint supports the following optional parameters: Refer to Request Body Objects for additional information. |
||
| Response Body | The JSON Transaction data | |
https://sitename.oracle.com/rest/v16/commerceDocumentsTransaction/1801963/actions/revise_submit_t
{ "reason_var_name": "alwaysTrueReason", "documents": { ..."approval_history_submit_t": [{ "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 1, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting quote for approval", "actionPerformed": "Submit" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 1, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "", "actionPerformed": "Revised" } ], "approval_status_submit_t": "", "_step_var_name": "savedTransaction", "_submitted_by_submit_t": "superuser", "approve_reject_icon_submit_t": "", "approval_revision_submit_t": 2, ... } }
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_process_unlock
{ "selections": [3022127625, 3022127628, 3022127629] }
| Update Transaction Line |
||
|---|---|---|
|
Description |
This operation modifies transaction line details and updates the existing transaction. |
|
|
URI Endpoint |
/rest/v16/commerceDocumentsOraclecpqoTransaction/{id}/actions/_update_line_items |
|
| Endpoint Parameters |
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: Refer to Request Body Objects for additional information. |
|
|
Response Body |
JSON data for the transaction, including the updated transaction line |
|
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/17994570/actions/_update_line_items
