Commerce Transaction REST APIs

Commerce REST APIs use the following resource paths for the standard process:

• Main document /commerceDocumentsOraclecpqoTransaction

• Sub document /commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine

The following variable may differ for custom processes:

• {Stage} The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders) e.g. Documents

• {ProcessVarName} The variable name of the commerce process, note the first letter must be capitalized. e.g. Oraclecpqo

• {MainDocVarName} The variable name of the main document, note the first letter must be capitalized. e.g. Transaction

• {id} The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. e.g. 36365444

• {subDocVarName} The sub-document number e.g. transactionLine

Commerce REST APIs use the following resource paths for the standard process:

• Main document /commerceDocumentsOraclecpqoTransaction

• Sub document /commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine

The following variable may differ for custom processes:

• {Stage} The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders) e.g. Documents

• {ProcessVarName} The variable name of the commerce process, note the first letter must be capitalized. e.g. Oraclecpqo

• {MainDocVarName} The variable name of the main document, note the first letter must be capitalized. e.g. Transaction

• {id} The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. e.g. 36365444

• {subDocVarName} The sub-document number e.g. transactionLine

Accept Quote
Description	Use this endpoint to accept the specified transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_accept_quote
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. deleteRows: An array line items to delete. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. destinationURL: The destination url as defined in destination tab in action definition. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Sample

Response Sample

Add Coverage
Description	Use this endpoint to associate a coverage or subscription product to another item in the quote/order.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_add_coverage
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. deleteRows: An array line items to delete. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. destinationURL: The destination url as defined in destination tab in action definition. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Sample

Response Sample

Add from Favorites
Description	This 'Add From Catalog' type action returns a destination URL to launch the Favorites List in Oracle CPQ where users can select items to add to the transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_addFromFavorites_t
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. destinationURL: The destination url as defined in destination tab in action definition. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Response Sample

Alternate Address - Retrieve
Description	Use this endpoint to return alternative addresses that are associated with the current customer and transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_retrieve_alternate_address
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: accountAddressCriteria: The address query definition for the current resource request. cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database.
Response Body Parameters	This endpoint supports the following parameters: accountAddressCriteria: The address query definition for the current resource request. accountAddressList: A collection of addresses associated with the current customer and transaction. cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database.

URI Endpoint Sample

Response Body Sample

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/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_select_alternate_address_action
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: accountAddressId: The ID for the alternate address. alternateAddress: Alternative bill to and ship to addresses. cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. deleteRows: An array line items to delete. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Body Sample

Response Body Sample

{ "documents": { "_bill_to_country": { "value": "United States", "displayValue": "United States" }, "_id": 19642736, "_bill_to_state": { "value": "Arkansas", "displayValue": "Arkansas" }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/19642736" }, { "name": "lineItem", "rel": "child", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/19642736/lineItem", "kind": "" } ] }, "warnings": {} }

Auto-fill Account Information
Description	Use this endpoint to automatically fill related customer data using the specified Customer ID field.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_auto_fill_action
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: billToAddressNumber: The number for the bill to address information. cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. shipToAddressNumber: The number for the ship to address information. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Body Sample

Response Body Sample

URI Endpoint Sample

Sample Response

{ "revisionId": "24,0", "warnings": {}, "destinationURL": "/redwood/vp/cx-cpq/application/container/quotes?process=oraclecpqo" }

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/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_change_currency
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	POST
Request Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. currencyCode: The requested currency code documents: The transaction object revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied.
Response Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Body Sample

{"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/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/{copyToFavoritesActionVarName}
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
	copyToFavoritesActionVarName	The variable name of the Copy to Favorites type action.
HTTP Method	POST
Request Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object favoriteData: Folder where the favorites will reside. An empty or -1 value indicates default folder.. revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied.
Response Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. documents: The transaction object favoriteIds: List of created favorite root Ids. layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Sample

Copy Transaction
Description	Use this endpoint to copy the specified transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_copy_transaction
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. copy_sequence_id: Copy Sequence Id uniquely identifies a sequence associated to the copy action. A sequence informs the system which Commerce actions to perform while copying a Transaction and who should have access to the Copy action criteria: This query definition is used to retrieve specific content and limit the size of the response. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. destinationURL: The destination url as defined in destination tab in action definition. layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Response Sample

{ "revisionId": "4,0", "documents": { "totalOneTimeListAmount_t": { "value": 61725.0, "currency": "USD" }, "contactState_t": null, "contactCity_t": null, "_s_soldToPartyName_t": null, "_customer_id": "300100122967029", "_eSignatureAttributeSet_esig_file_attachment": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/36893204/attachmentAttributes/_eSignatureAttributeSet_esig_file_attachment/transactions/38892718/documentNumbers/1" }, "_invoiceTo_t_state": null, "orderKey_t": "ORA_BM_CPQ:38468889", "mSDYNIsPrimaryQuote_c": false, "_invoiceTo_t_city": null, "transactionTotalDiscountPercent_t": 0.0, "_s_billTo_t_city": null, "_s_billTo_t_fax": null, "_customer_t_state": null, "totalContractValue_t": { "value": 65725.0, "currency": "USD" }, "contractTypeName_t": null, "_s_billTo_t_phone": null, "contractStartDate_t": null, "_s_billTo_t_zip": null, "_s_shipToPartySiteID_t": null, "addressType_t": null, "_date_modified": "2024-06-09T17:54:28.000Z", "_invoiceTo_t_email": null, "_customer_t_address": "111 Vision St", "_soldTo_t_state": null, "hasRecurringPricing_t": true, "contactType_t": null, "contactProvince_t": null, "_s_contactNumber_t": null, "accountAddressElementAttribute5_t": null, "totalAnnualCostAmount_t": { "value": 0.0, "currency": "USD" }, "_shipTo_t_last_name": null, "contractEndDate_t": null, "mSDYNObjectName_c": null, "_invoiceTo_t_company_name_2": null, "contactUniqueName_t": null, "_soldTo_t_zip": null, "contractName_t": null, "_soldTo_t_fax": null, "_customer_t_country": { "displayValue": "US", "value": "US" }, "totalOneTimeNetAmount_t": { "value": 61725.0, "currency": "USD" }, "bs_id": "38892718", "contactAddressLine4_t": null, "_s_soldToCustomerAccountID_t": null, "contactMiddleName_t": null, "currentStepForTesting_tempDisplay_t": "Start", "_submitted_by_submit_t": "", "_customer_t_email": null, "oRCL_SFA_PrimaryOrgID_t": null, "accountUniqueName_t": null, "billToSiteUseId_t": null, "_partner_price_book_id": null, "opportunityNumber_t": null, "totalContractDiscount_t": { "value": 0.0, "currency": "USD" }, "priceWithinPolicy_t": true, "_soldTo_t_first_name": null, "totalOneTimeCostAmount_t": { "value": 0.0, "currency": "USD" }, "subscription_Status_t": null, "_invoiceTo_t_company_name": null, "accountPostalCode_t": null, "_locked_by_user_login": null, "_reject_link": "", "_soldTo_t_country": null, "_shipTo_t_zip": null, "oRCL_SFA_TransactionID_t": null, "_shipTo_t_fax": null, "_customer_t_company_name": "Vision Development US)", "accountEmailAddress_t": null, "contactAddressLine3_t": null, "_s_accountIntegrationResponse_t": null, "userKey_t": "CPQ-90824Bv1", "totalContractCostAmount_t": { "value": 0.0, "currency": "USD" }, "_s_isPublished_t": null, "priceExpirationDate_t": null, "_s_customerStatus_t": null, "_locked_time": null, "_transaction_total": null, "annualContractListValue_t": { "value": 4000.0, "currency": "USD" }, "_s_billTo_t_address": null, "approve_reject_icon_submit_t": null, "oRCL_ERP_OrderID_t": "38468889", "_s_accountPartyId_t": "1001", "accountAddressLine1_t": null, "totalRecurRevenue_t": { "value": 4000.0, "currency": "USD" }, "_s_customerVisibilityIdentifier_t": null, "priceType_t": null, "_customer_t_city": null, "_esigTest_c_esig_date_modified": null, "totalOneTimeMarginAmount_t": { "value": 61725.0, "currency": "USD" }, "_esigTest_c_esig_status": { "displayValue": "Not Sent", "value": "Not Sent" }, "_eSignatureAttributeSet_esig_date_modified": null, "proposalExists_t": false, "accountAddressElementAttribute3_t": null, "oRCL_SFA_Status_t": "ZCA_IN_PROGRESS", "coverLetter_t": null, "contactAddressElementAttribute4_t": null, "transactionName_t": "01/16 Vision Development US)", "contactLastName_t": null, "_pp_id": 36918293, "_document_number": "1", "_esigTest_c_esig_recipients": null, "_shipTo_t_phone": null, "owner_t": "Albert M", "_soldTo_t_email": null, "contactFirstName_t": null, "_invoiceTo_t_first_name": null, "_customer_t_zip": null, "_lock_status": false, "_customer_t_fax": null, "currency_t": { "displayValue": "USD", "value": "USD" }, "totalMonthlyListAmount_t": { "value": 4000.0, "currency": "USD" }, "_s_contractID_t": null, "_s_transactionSource_t": null, "renewalProcess_t": null, "totalContractListValue_t": { "value": 65725.0, "currency": "USD" }, "_eSignatureAttributeSet_esig_status": { "displayValue": "Not Sent", "value": "Not Sent" }, "accountAddressLine2_t": null, "_soldTo_t_company_name": null, "_shipTo_t_first_name": null, "_s_soldToPartyID_t": null, "_s_soldToPartySiteID_t": null, "_invoiceTo_t_country": null, "version_t": 1, "_shipTo_t_company_name": null, "accountName_t": null, "contactAddressLine2_t": null, "accountAddressElementAttribute4_t": null, "accountState_t": null, "_price_book_custom_fields": { "value": null }, "contactAddressElementAttribute5_t": null, "_price_book_var_name": "_default_price_book", "_locked_by_user": -1, "_s_billToCustomerAccountID_t": null, "_revenueCategory_t": null, "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_shipTo_t_address": null, "contactEmailAddress_t": null, "totalOneTimeDiscount_t": { "value": 0.0, "currency": "USD" }, "totalMonthlyNetAmount_t": { "value": 4000.0, "currency": "USD" }, "winLossStatus_t": { "displayValue": "In Progress", "value": "IN PROGRESS" }, "freezePriceFlag_t": true, "lastUpdatedDate_t": "2024-06-09T17:54:00Z", "accountProvince_t": null, "_s_billTo_t_state": null, "_price_book_desc": "Default Price Book (1.0 x base price)", "_document_var_name": "transaction", "_s_accountContactNumber_t": null, "_invoiceTo_t_address": null, "renewalErrorEmailAddress_t": null, "accountType_t": null, "_customer_t_phone": null, "lastPricedDate_t": "2024-01-16T11:52:00Z", "lastUpdatedBy_t": "Albert M", "_price_book_name": "Base Price", "_s_contractTypeID_t": null, "accountAddressElementAttribute1_t": null, "partialShipAllowedFlag_t": false, "oRCL_ERP_OrderNumber_t": "522074", "_soldTo_t_city": null, "primaryFlag_t": false, "paymentTerms_t": null, "totalMonthlyUsageRev_t": { "value": 0.0, "currency": "USD" }, "createdDate_t": "2024-06-09", "oRCL_SFA_SyncTime_t": "1900-01-01T00:00:00", "accountAddressLine3_t": null, "approval_status_submit_t": null, "contactAddressLine1_t": null, "transactionDescription_t": null, "totalMonthlyCostAmount_t": { "value": 0.0, "currency": "USD" }, "_date_added": "2024-06-09T17:54:26.000Z", "_s_contactPartyNumber_t": null, "contactAddressElementAttribute2_t": null, "contactName_t": null, "_invoiceTo_t_phone": null, "_s_invoiceToPartySiteID_t": null, "oRCL_ERP_PartialShipAllowed_t": false, "_s_billTo_t_address_2": null, "_shipTo_t_state": null, "totalUsageRevenue_t": { "value": 0.0, "currency": "USD" }, "fileAttachment_t": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/36893204/attachmentAttributes/fileAttachment_t/transactions/38892718/documentNumbers/1" }, "_soldTo_t_address_2": null, "invoiceToPartyID_t": null, "_esigTest_c_esig_file_attachment": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/36893204/attachmentAttributes/_esigTest_c_esig_file_attachment/transactions/38892718/documentNumbers/1" }, "_process_var_name": "oraclecpqo", "_locked_by_user_first_name": null, "_invoiceTo_t_zip": null, "_s_billTo_t_country": null, "createdBy_t": "Albert M", "contractedPeriods_t": 1, "_soldTo_t_last_name": null, "contactNameSuffix_t": null, "_s_assignedTo_t": null, "_s_shipToPartyID_t": null, "_s_accountPartyNumber_t": null, "accountCity_t": null, "_locked_by_user_last_name": null, "accountAddressLine4_t": null, "_s_billTo_t_last_name": null, "renewalProcessUsed_t": null, "_eSignatureAttributeSet_esig_envelope_id": null, "mSDYNPrimaryQuoteId_c": null, "transactionID_t": "CPQ-90824B", "accountAddressElementAttribute2_t": null, "_buyer_company_name": "cpq-techwriter1", "opportunityName_t": null, "renewDraftSubscriptionNumber_t": null, "totalMonthlyDiscount_t": { "value": 0.0, "currency": "USD" }, "_invoiceTo_t_fax": null, "_shipTo_t_email": null, "contactAddressElementAttribute3_t": null, "_s_hostCompanyFullName_t": null, "parent_transaction_id_versionTransaction_t": null, "_s_billTo_t_company_name": null, "opportunityID_t": null, "_date_tx_modified": "2024-06-09T17:54:28.000Z", "fulfillmentStatus_t": null, "_soldTo_t_phone": null, "_s_billToCustomerAccountName_t": null, "_eSignatureAttributeSet_esig_recipients": null, "accountMiddleName_t": null, "accountLastName_t": null, "accountNameSuffix_t": null, "approval_history_submit_t": null, "_customer_t_last_name": null, "salesChannel_t": null, "totalAnnualValue_t": { "value": 4000.0, "currency": "USD" }, "_shipTo_t_city": null, "_shipTo_t_country": null, "contactCountry_t": null, "defaultRequestDate_t": null, "mSDYNOpportunityLineIds_c": null, "priceScore_t": 9, "transactionMarginPercent_t": 100.0, "purchaseOrderNumber_t": null, "_last_document_number": 2, "_approve_link": "", "_price_book_custom_field_text": { "value": null }, "_customer_t_address_2": null, "requireApprovalIfChecked_temporary_t": false, "_id": 38892718, "_invoiceTo_t_address_2": null, "subscriptionProfileId_t": "300100172161473", "_shipTo_t_company_name_2": null, "transactionSourceSystem_t": "ORA_BM_CPQ", "accountFirstName_t": null, "triggerUpdateAssetForLineStatus_t": "AWAIT_BILLING~ACTIVATED", "totalAnnualMarginAmount_t": { "value": 4000.0, "currency": "USD" }, "_s_billTo_t_email": null, "createOrderRestResponse": "2~status_l~CREATED|2~fulfillmentLineId_l~300100623978594|", "_shipTo_t_address_2": null, "contactPostalCode_t": null, "_step_var_name": "pending_process", "_soldTo_t_company_name_2": null, "oRCL_SFA_OwnerResourcePartyID_t": null, "accountCountry_t": null, "_esigTest_c_esig_envelope_id": null, "businessUnitName_t": "Vision Operations", "_s_billTo_t_first_name": null, "TotalAnnualDiscount_t": { "value": 0.0, "currency": "USD" }, "_soldTo_t_address": null, "_invoiceTo_t_last_name": null, "totalContractMarginAmount_t": { "value": 65725.0, "currency": "USD" }, "_customer_t_company_name_2": null, "_s_subscriptionId_t": null, "approval_revision_submit_t": 1, "contactAddressElementAttribute1_t": null, "_supplier_company_name": "cpq-techwriter1", "_s_customerPartySiteID_t": null, "version_number_versionTransaction_t": "1", "businessUnitId_t": null, "_customer_t_first_name": null, "oRCL_billingFrequency_t": null, "_s_billTo_t_company_name_2": null, "totalMonthlyMarginAmount_t": { "value": 4000.0, "currency": "USD" }, "_pp_name": "Sales User", "status_t": { "displayValue": "Created", "value": "CREATED" }, "transactionLine": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892718/transactionLine" } ], "items": [{ "_line_bom_attributes": null, "_availableRatePlans": { "displayValue": "Headspace Apps Plan1", "value": "headspaceAppsPlan1" }, "listAmount_l": { "value": 61725.0, "currency": "USD" }, "discountAmount_l": { "value": 0.0, "currency": "USD" }, "rollupFlag_l": false, "contractStartDate_l": "2024-01-04", "_model_partner_entity_id": null, "listPriceRollup_l": { "value": 13145.0, "currency": "USD" }, "_config_attributes": { "value": null }, "_part_sale_enabled": "Y", "recurringRevSummable_l": { "value": 0.0, "currency": "USD" }, "fulfillmentLineId_l": "300100623978594", "_part_display_number": "Headspace Apps", "_model_attributes": { "value": null }, "_price_list_price_each": { "value": 0.0, "currency": "USD" }, "_line_bom_effective_date": null, "includedInBasePrice": null, "_parent_line_item": null, "_date_modified": "2024-06-09T17:54:28.000Z", "rootAssetKey_l": "abo_386ae2d7-c3b5-4eb3-bde0-7d7a1b2623df", "annualMargin_l": { "value": 0.0, "currency": "USD" }, "_model_product_line_attributes": { "value": null }, "_price_configurable_price": { "value": 0.0, "currency": "USD" }, "costAmount_l": { "value": 0.0, "currency": "USD" }, "_is_part_pricing_rule_price": true, "_part_default_uom": "Ea", "discountPercent_l": 0.0, "_part_sales_product_type": "SUBSCRIPTION", "contractEndDate_l": "2024-02-03", "_last_modified_date": "2024-06-09 17:54:28", "_s_freezeNegotiationFlag_l": null, "subscriptionId_l": null, "_config_extra_info": null, "suspendDate_l": null, "unitMargin_l": { "value": 12345.0, "currency": "USD" }, "resumeDate_l": null, "_part_number": "Headspace Apps", "_sequence_number": 1, "_line_bom_display_name": null, "unitCost_l": null, "_price_applied_agreement_integrationId": null, "_price_unit_price_each": { "value": 12345.0, "currency": "USD" }, "_model_base_price": null, "customDiscountValue_l": null, "_model_product_line_name": null, "_price_item_price_each": { "value": 0.0, "currency": "USD" }, "recurRevRollup_l": { "value": 4000.0, "currency": "USD" }, "monthlyUsageRevRollup_l": { "value": 0.0, "currency": "USD" }, "_transaction_currency_pref": { "id": 5190368, "currencyCode": "USD" }, "oRCL_ABO_ComponentAttributes_l": null, "_price_applied_ratePlan_integrationId": "300100622063874", "priceWithinPolicy_l": true, "_part_serv_req_enabled": "Y", "_model_supplier_company_id": null, "_model_segment_id": null, "_partner_entity_id": "300100620537618", "requestDate_l": null, "_part_base_price": { "value": 0.0, "currency": "USD" }, "contractMargin_l": { "value": 61725.0, "currency": "USD" }, "pricePeriod_l": null, "changeCode_l": null, "associatedLineId_l": null, "_model_partner_organization_id": null, "_model_segment_name": null, "priceType_l": { "displayValue": "One Time", "value": "One Time" }, "nonRecurRevRollup_l": { "value": 61725.0, "currency": "USD" }, "oRCL_SFA_Status_l": "ZCA_IN_PROGRESS", "_config_attr_info": { "value": null }, "_s_partID_l": null, "contractListValueRollup_l": { "value": 65725.0, "currency": "USD" }, "contractValue_l": { "value": 61725.0, "currency": "USD" }, "netAmountRollup_l": { "value": 65725.0, "currency": "USD" }, "_prior_price": null, "customDiscountAmount_l": { "value": 0.0, "currency": "USD" }, "_parent_doc_number": null, "requestShipDate_l": "2024-01-16", "_reconfiguration_date": "1970-01-01 00:00:00", "annualCost_l": { "value": 0.0, "currency": "USD" }, "_part_desc": "Headspace Apps", "_chargeSetControl": 1, "_pp_id": 36918293, "_document_number": 2, "parentAssetKey_l": null, "_rollup_delta_price": null, "_is_bom_price": false, "winLossStatus_l": { "displayValue": "In Progress", "value": "IN PROGRESS" }, "_price_calculation_info": "[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price Model\",\"_isAgreement\":false,\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"Base Pricing Rule\",\"_runningUnitPrice\":12345.0}]", "associatedOrderId_l": null, "_price_applied_ratePlan": "Headspace Apps Plan1", "_price_component_prices": { "value": null }, "discountPercentRollup_l": 0.0, "_part_supplier_company_id": "4118171", "_original_document_number": "-1", "contractListValue_l": { "value": 61725.0, "currency": "USD" }, "_line_item_spare_rule_var_name": null, "_price_applied_agreement_name": null, "_revenueCategory_l": null, "_part_id": "37768173", "_part_company_associations": null, "_part_default_periods": "N/A", "marginPercent_l": 100.0, "_price_book_var_name": "_default_price_book", "customDiscountType_l": null, "_model_sales_product_type": null, "_group_sequence_number": "1.0", "_price_applied_ratePlan_number": "headspaceAppsPlan1", "lastUpdatedDate_l": null, "_price_quantity": 5, "paymentTerms_l": null, "lastUpdatedBy_l": "Albert M", "_part_supplier_company_name": "cpqext-009", "_document_var_name": "transactionLine", "mSDYNOpportunityLineId_c": null, "_part_default_price_type": null, "createdDate_l": "2024-06-09T17:54:00Z", "contractCost_l": { "value": 0.0, "currency": "USD" }, "contractDiscount_l": { "value": 0.0, "currency": "USD" }, "_line_bom_name": null, "oRCL_ERP_OrderNumber_l": "522074", "_model_is_valid": false, "_part_external_key2": null, "_part_external_key1": null, "changeReason_l": null, "_config_attr_text": { "value": null }, "itemInstanceName_l": null, "priceRecurFrequencyRollup_l": { "displayValue": "Per Month", "value": "MONTHLY" }, "_price_applied_agreement_number": null, "_line_bom_model_path": null, "_model_id": null, "_availableRatePlanSetControl": 1, "_date_added": "2024-06-09T17:54:26.000Z", "_model_product_line_id": null, "requestedUnitOfMeasure_l": { "displayValue": "Each", "value": "Ea" }, "usageRevSummable_l": { "value": 0.0, "currency": "USD" }, "monthlyRecurRevRollup_l": { "value": 4000.0, "currency": "USD" }, "_configuration_id": null, "_model_bom": null, "contractedPeriods_l": 1, "createdBy_l": "Albert M", "parentdocumentNumber_l": null, "fulfillmentStatus_l": { "displayValue": "Fulfilled", "value": "FULFILLED" }, "_model_variable_name": null, "monthlyRecurRevSummable_l": { "value": 0.0, "currency": "USD" }, "_model_product_line_var_name": null, "_is_recommended_price": false, "_transactionLine_id": "38892718_2", "annualListValue_l": { "value": 0.0, "currency": "USD" }, "lastPriced_c": null, "_line_bom_id": "SPI_2", "_model_supplier_company_name": null, "rootLine_l": { "displayValue": "Y", "value": "Y" }, "lineType_l": { "displayValue": "Part", "value": "PART" }, "transactionID_l": "38892718", "_line_bom_part_number": "Headspace Apps", "usageRevRollup_l": { "value": 0.0, "currency": "USD" }, "itemInstanceId_l": "abo_51703643-9f03-46ea-aad3-abbb0d4dd8b8", "_s_coverageOrderNumber": null, "_s_coverageLineNumber": null, "_line_bom_item_quantity": 1, "annualDiscount_l": { "value": 0.0, "currency": "USD" }, "_model_segment_var_name": null, "_line_bom_level": 0, "_bs_id": 38892718, "netAmount_l": { "value": 61725.0, "currency": "USD" }, "orderDate_l": null, "_part_units": null, "_part_direct_buy": "1", "salesChannel_l": null, "oRCL_SFA_InventoryItemID_l": "300100620537618", "oRCL_ABO_ActionCode_l": { "displayValue": "Add", "value": "ADD" }, "priceRecurFrequency_l": null, "_line_bom_parent_id": null, "priceScore_l": 9, "_line_item_type": null, "_part_default_periodicity": null, "_delta_price": null, "_line_display_name": "Headspace Apps", "netPrice_l": { "value": 12345.0, "currency": "USD" }, "_revenueId_l": null, "freezeNegotiationFlag_l": true, "renewDate_l": null, "_price_type": "One Time", "listPrice_l": { "value": 12345.0, "currency": "USD" }, "_part_extended_desc_2": null, "documentNumber_l": "2", "_part_extended_desc_1": null, "nonRecurRevSummable_l": { "value": 61725.0, "currency": "USD" }, "priceTypeRollup_l": { "displayValue": "Mixed", "value": "Mixed" }, "contractedPeriodsRollup_l": 1, "_is_line_item_mandatory": false, "_price_period": null, "ownerResourceId_l": null, "_id": 38892720, "_is_coverage": false, "_part_lead_time": "N/A", "lineNumber_l": null, "_part_css_enabled": "N", "subscriptionLineId_l": null, "status_l": { "displayValue": "Created", "value": "CREATED" }, "_line_item_comment": null, "contractValueRollup_l": { "value": 65725.0, "currency": "USD" }, "_line_bom_sequence_index": null, "_step_var_name": "pending_process", "_model_name": null, "_config_attr_values": null, "_part_drawing_position": null, "fulfillmentOrganizationCode_l": null, "_pricing_rule_price_each": { "value": 12345.0, "currency": "USD" }, "monthlyUsageRevSummable_l": { "value": 0.0, "currency": "USD" }, "_line_bom_variable_name": null, "marginAmount_l": { "value": 61725.0, "currency": "USD" }, "_partner_organization_id": "204", "netPriceRollup_l": { "value": 13145.0, "currency": "USD" }, "annualValue_l": { "value": 0.0, "currency": "USD" }, "_pp_name": "Sales User", "oRCL_SFA_InventoryOrgID_l": "204", "_line_bom_condition_index": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892718/transactionLine/2" }, { "kind": "", "rel": "child", "name": "_chargeSet", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892718/transactionLine/2/_chargeSet" }, { "kind": "", "rel": "child", "name": "_availableRatePlanSet", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892718/transactionLine/2/_availableRatePlanSet" }, { "kind": "", "rel": "child", "name": "oRCL_charges", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892718/transactionLine/2/oRCL_charges" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892718" } ] } ] } }, "warnings": {}, "destinationURL": "document.jsp?bm_cm_process_id=36892642&error_redirect=" }

Create New Transaction
Description	Use this endpoint to create a new transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_new_transaction
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method(s)	POST
Request Body Parameters	This endpoint supports the following parameters: _modify_action: The main document or sub-document content for change to be posted or retrieved. For main document case, it may contains sub-document information as well. cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. partnerInfo: Contains partner object IDs to be linked to the CPQ resource revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Response Sample

{ "documents": { "totalOneTimeListAmount_t": { "value": 0.0, "currency": "USD" }, "contactState_t": null, "contactCity_t": null, "_s_soldToPartyName_t": null, "_customer_id": "300100122967029", "_eSignatureAttributeSet_esig_file_attachment": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/36893204/attachmentAttributes/_eSignatureAttributeSet_esig_file_attachment/transactions/38892736/documentNumbers/1" }, "_invoiceTo_t_state": null, "orderKey_t": null, "mSDYNIsPrimaryQuote_c": false, "_invoiceTo_t_city": null, "transactionTotalDiscountPercent_t": 0.0, "_s_billTo_t_city": null, "_s_billTo_t_fax": null, "_customer_t_state": null, "totalContractValue_t": { "value": 0.0, "currency": "USD" }, "contractTypeName_t": null, "_s_billTo_t_phone": null, "contractStartDate_t": null, "_s_billTo_t_zip": null, "_s_shipToPartySiteID_t": null, "addressType_t": null, "_date_modified": "2024-06-09T18:20:37.000Z", "_invoiceTo_t_email": null, "_customer_t_address": "111 Vision St", "_soldTo_t_state": null, "hasRecurringPricing_t": false, "contactType_t": null, "contactProvince_t": null, "_s_contactNumber_t": null, "accountAddressElementAttribute5_t": null, "totalAnnualCostAmount_t": { "value": 0.0, "currency": "USD" }, "_shipTo_t_last_name": null, "contractEndDate_t": null, "mSDYNObjectName_c": null, "_invoiceTo_t_company_name_2": null, "contactUniqueName_t": null, "_soldTo_t_zip": null, "contractName_t": null, "_soldTo_t_fax": null, "_customer_t_country": { "displayValue": "US", "value": "US" }, "totalOneTimeNetAmount_t": { "value": 0.0, "currency": "USD" }, "bs_id": "38892736", "contactAddressLine4_t": null, "_s_soldToCustomerAccountID_t": null, "contactMiddleName_t": null, "currentStepForTesting_tempDisplay_t": "Start", "_submitted_by_submit_t": "", "_customer_t_email": null, "oRCL_SFA_PrimaryOrgID_t": "204", "accountUniqueName_t": null, "billToSiteUseId_t": null, "_partner_price_book_id": null, "opportunityNumber_t": null, "totalContractDiscount_t": { "value": 0.0, "currency": "USD" }, "priceWithinPolicy_t": true, "_soldTo_t_first_name": null, "totalOneTimeCostAmount_t": { "value": 0.0, "currency": "USD" }, "subscription_Status_t": null, "_invoiceTo_t_company_name": null, "accountPostalCode_t": null, "_locked_by_user_login": null, "_reject_link": "", "_soldTo_t_country": null, "_shipTo_t_zip": null, "oRCL_SFA_TransactionID_t": null, "_shipTo_t_fax": null, "_customer_t_company_name": "Vision Development US)", "accountEmailAddress_t": null, "contactAddressLine3_t": null, "_s_accountIntegrationResponse_t": null, "userKey_t": "CPQ-90924Bv1", "totalContractCostAmount_t": { "value": 0.0, "currency": "USD" }, "_s_isPublished_t": false, "priceExpirationDate_t": null, "_s_customerStatus_t": null, "_locked_time": null, "_transaction_total": null, "annualContractListValue_t": { "value": 0.0, "currency": "USD" }, "_s_billTo_t_address": null, "approve_reject_icon_submit_t": null, "oRCL_ERP_OrderID_t": null, "_s_accountPartyId_t": "300100122967029", "accountAddressLine1_t": null, "totalRecurRevenue_t": { "value": 0.0, "currency": "USD" }, "_s_customerVisibilityIdentifier_t": null, "priceType_t": null, "_customer_t_city": null, "_esigTest_c_esig_date_modified": null, "totalOneTimeMarginAmount_t": { "value": 0.0, "currency": "USD" }, "_esigTest_c_esig_status": { "displayValue": "Not Sent", "value": "Not Sent" }, "_eSignatureAttributeSet_esig_date_modified": null, "proposalExists_t": false, "accountAddressElementAttribute3_t": null, "oRCL_SFA_Status_t": "ZCA_IN_PROGRESS", "coverLetter_t": null, "contactAddressElementAttribute4_t": null, "transactionName_t": "06/09 Vision Development US)", "contactLastName_t": null, "_pp_id": 36918013, "_document_number": "1", "_esigTest_c_esig_recipients": null, "_shipTo_t_phone": null, "owner_t": "Albert M", "_soldTo_t_email": null, "contactFirstName_t": null, "_invoiceTo_t_first_name": null, "_customer_t_zip": null, "_lock_status": false, "_customer_t_fax": null, "currency_t": { "displayValue": "USD", "value": "USD" }, "totalMonthlyListAmount_t": { "value": 0.0, "currency": "USD" }, "_s_contractID_t": null, "_s_transactionSource_t": { "displayValue": "Seller Initiated", "value": "sellerInitiated" }, "renewalProcess_t": null, "totalContractListValue_t": { "value": 0.0, "currency": "USD" }, "_eSignatureAttributeSet_esig_status": { "displayValue": "Not Sent", "value": "Not Sent" }, "accountAddressLine2_t": null, "_soldTo_t_company_name": null, "_shipTo_t_first_name": null, "_s_soldToPartyID_t": null, "_s_soldToPartySiteID_t": null, "_invoiceTo_t_country": null, "version_t": 1, "_shipTo_t_company_name": null, "accountName_t": null, "contactAddressLine2_t": null, "accountAddressElementAttribute4_t": null, "accountState_t": null, "_price_book_custom_fields": { "value": null }, "contactAddressElementAttribute5_t": null, "_price_book_var_name": null, "_locked_by_user": -1, "_s_billToCustomerAccountID_t": null, "_revenueCategory_t": null, "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_shipTo_t_address": null, "contactEmailAddress_t": null, "totalOneTimeDiscount_t": { "value": 0.0, "currency": "USD" }, "totalMonthlyNetAmount_t": { "value": 0.0, "currency": "USD" }, "winLossStatus_t": { "displayValue": "In Progress", "value": "IN PROGRESS" }, "freezePriceFlag_t": true, "lastUpdatedDate_t": "2024-06-09T18:20:00Z", "accountProvince_t": null, "_s_billTo_t_state": null, "_price_book_desc": null, "_document_var_name": "transaction", "_s_accountContactNumber_t": null, "_invoiceTo_t_address": null, "renewalErrorEmailAddress_t": null, "accountType_t": null, "_customer_t_phone": null, "lastPricedDate_t": "2024-06-09T18:20:00Z", "lastUpdatedBy_t": "Albert M", "_price_book_name": null, "_s_contractTypeID_t": null, "accountAddressElementAttribute1_t": null, "partialShipAllowedFlag_t": false, "oRCL_ERP_OrderNumber_t": null, "_soldTo_t_city": null, "primaryFlag_t": false, "paymentTerms_t": null, "totalMonthlyUsageRev_t": { "value": 0.0, "currency": "USD" }, "createdDate_t": "2024-06-09", "oRCL_SFA_SyncTime_t": "1900-01-01T00:00:00", "accountAddressLine3_t": null, "approval_status_submit_t": null, "contactAddressLine1_t": null, "transactionDescription_t": null, "totalMonthlyCostAmount_t": { "value": 0.0, "currency": "USD" }, "_date_added": "2024-06-09T18:20:14.000Z", "_s_contactPartyNumber_t": null, "contactAddressElementAttribute2_t": null, "contactName_t": null, "_invoiceTo_t_phone": null, "_s_invoiceToPartySiteID_t": null, "oRCL_ERP_PartialShipAllowed_t": false, "_s_billTo_t_address_2": null, "_shipTo_t_state": null, "totalUsageRevenue_t": { "value": 0.0, "currency": "USD" }, "fileAttachment_t": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/36893204/attachmentAttributes/fileAttachment_t/transactions/38892736/documentNumbers/1" }, "_soldTo_t_address_2": null, "invoiceToPartyID_t": null, "_esigTest_c_esig_file_attachment": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/36893204/attachmentAttributes/_esigTest_c_esig_file_attachment/transactions/38892736/documentNumbers/1" }, "_process_var_name": "oraclecpqo", "_locked_by_user_first_name": null, "_invoiceTo_t_zip": null, "_s_billTo_t_country": null, "createdBy_t": "Albert M", "contractedPeriods_t": 1, "_soldTo_t_last_name": null, "contactNameSuffix_t": null, "_s_assignedTo_t": { "displayValue": "Seller", "value": "SELLER" }, "_s_shipToPartyID_t": null, "_s_accountPartyNumber_t": null, "accountCity_t": null, "_locked_by_user_last_name": null, "accountAddressLine4_t": null, "_s_billTo_t_last_name": null, "renewalProcessUsed_t": null, "_eSignatureAttributeSet_esig_envelope_id": null, "mSDYNPrimaryQuoteId_c": null, "transactionID_t": "CPQ-90924B", "accountAddressElementAttribute2_t": null, "_buyer_company_name": "cpq-techwriter1", "opportunityName_t": null, "renewDraftSubscriptionNumber_t": null, "totalMonthlyDiscount_t": { "value": 0.0, "currency": "USD" }, "_invoiceTo_t_fax": null, "_shipTo_t_email": null, "contactAddressElementAttribute3_t": null, "_s_hostCompanyFullName_t": "cpq-techwriter1", "parent_transaction_id_versionTransaction_t": null, "_s_billTo_t_company_name": null, "opportunityID_t": null, "_date_tx_modified": "2024-06-09T18:20:37.000Z", "fulfillmentStatus_t": null, "_soldTo_t_phone": null, "_s_billToCustomerAccountName_t": null, "_eSignatureAttributeSet_esig_recipients": null, "accountMiddleName_t": null, "accountLastName_t": null, "accountNameSuffix_t": null, "approval_history_submit_t": null, "_customer_t_last_name": null, "salesChannel_t": null, "totalAnnualValue_t": { "value": 0.0, "currency": "USD" }, "_shipTo_t_city": null, "_shipTo_t_country": null, "contactCountry_t": null, "defaultRequestDate_t": null, "mSDYNOpportunityLineIds_c": null, "priceScore_t": null, "transactionMarginPercent_t": 0.0, "purchaseOrderNumber_t": null, "_last_document_number": 1, "_approve_link": "", "_price_book_custom_field_text": { "value": null }, "_customer_t_address_2": null, "requireApprovalIfChecked_temporary_t": false, "_id": 38892736, "_invoiceTo_t_address_2": null, "subscriptionProfileId_t": "300100172161473", "_shipTo_t_company_name_2": null, "transactionSourceSystem_t": "ORA_BM_CPQ", "accountFirstName_t": null, "triggerUpdateAssetForLineStatus_t": "AWAIT_BILLING~ACTIVATED", "totalAnnualMarginAmount_t": { "value": 0.0, "currency": "USD" }, "_s_billTo_t_email": null, "createOrderRestResponse": null, "_shipTo_t_address_2": null, "contactPostalCode_t": null, "_step_var_name": null, "_soldTo_t_company_name_2": null, "oRCL_SFA_OwnerResourcePartyID_t": null, "accountCountry_t": null, "_esigTest_c_esig_envelope_id": null, "businessUnitName_t": "Vision Operations", "_s_billTo_t_first_name": null, "TotalAnnualDiscount_t": { "value": 0.0, "currency": "USD" }, "_soldTo_t_address": null, "_invoiceTo_t_last_name": null, "totalContractMarginAmount_t": { "value": 0.0, "currency": "USD" }, "_customer_t_company_name_2": null, "_s_subscriptionId_t": null, "approval_revision_submit_t": null, "contactAddressElementAttribute1_t": null, "_supplier_company_name": "cpq-techwriter1", "_s_customerPartySiteID_t": null, "version_number_versionTransaction_t": null, "businessUnitId_t": null, "_customer_t_first_name": null, "oRCL_billingFrequency_t": null, "_s_billTo_t_company_name_2": null, "totalMonthlyMarginAmount_t": { "value": 0.0, "currency": "USD" }, "_pp_name": "Admin", "status_t": { "displayValue": "Created", "value": "CREATED" }, "transactionLine": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892736/transactionLine" } ], "items": [] } }, "warnings": {} }

Create Sales Agreement
Description	Use this endpoint to create a sales agreement from the specified transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_createAgreement
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Sample

Response Body

{ "revisionId": "8,0", "documents": { "_pp_id": 3023226565, "approve_reject_icon_submit_t": null, "fileAttachment_t": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "http://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/3023201613/attachmentAttributes/fileAttachment_t/transactions/3023482862/documentNumbers/1" }, "approval_history_submit_t": [{ "reasonName": null, "actionPerformed": "Approval Completed", "performerComment": null, "reasonVarName": null, "revisionNumber": 1, "performerName": "Automation_Default", "performDate": "08/30/2024", "performerCompany": "mumbai54516" } ], "approval_status_submit_t": null, "_step_var_name": "agreementFinalized", "_id": 3023482862, "orderDate_t": null, "orderPlacedBy_t": null, "_pp_name": "Sales User", "status_t": { "displayValue": "Agreement Created", "value": "AGREEMENT_CREATED" }, "transactionLine": { "totalResults": 1, "offset": 0, "_state": { "insertable": false, "attributes": { "netAmount_l": { "visible": true }, "_document_number": { "visible": true }, "_price_quantity": { "visible": true }, "contractStartDate_l": { "visible": true }, "contractedPeriods_l": { "visible": false }, "_price_applied_ratePlan": { "visible": true }, "fulfillmentStatus_l": { "visible": false }, "oRCL_ABO_ActionCode_l": { "visible": true }, "pricePeriod_l": { "visible": false }, "_part_number": { "visible": true }, "_model_name": { "visible": true }, "priceScore_l": { "visible": true }, "_part_display_number": { "visible": true }, "contractDiscount_l": { "visible": true }, "contractListValue_l": { "visible": true }, "netPrice_l": { "visible": true }, "_price_applied_agreement_name": { "visible": true }, "_model_is_valid": { "visible": true }, "customDiscountValue_l": { "visible": true }, "listPrice_l": { "visible": true }, "documentNumber_l": { "visible": true }, "contractValue_l": { "visible": true }, "_model_id": { "visible": true }, "customDiscountAmount_l": { "visible": true }, "_parent_doc_number": { "visible": true }, "_is_line_item_mandatory": { "visible": true }, "partNumberCustom_c": { "visible": true }, "contractEndDate_l": { "visible": true }, "customDiscountType_l": { "visible": true }, "requestedUnitOfMeasure_l": { "visible": true }, "_is_coverage": { "visible": true }, "_group_sequence_number": { "visible": true }, "_chargeSetControl": { "visible": true }, "pricePeriodCustom_c": { "visible": true } } }, "limit": 10, "count": 1, "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023482862/transactionLine" } ], "items": [{ "_document_number": 2, "_chargeSet": { "totalResults": 0, "offset": 0, "_state": { "insertable": false, "queryable": false, "sortable": false, "attributes": { "_chargeSet_rateCardName": { "visible": true }, "_chargeSet_chargeType": { "visible": true }, "_chargeSet_usageUOM": { "visible": true }, "_chargeSet_rateCardStructure": { "visible": true }, "_chargeSet_netPrice": { "visible": true }, "_chargeSet_dynamicPricingType": { "visible": true }, "_chargeSet_discountType": { "visible": true }, "_chargeSet_rateCardVariableName": { "visible": true }, "_chargeSet_netAmount": { "visible": true }, "_chargeSet_calculationInfo": { "visible": true }, "_chargeSet_chargeDefinition": { "visible": true }, "_chargeSet_rateCardInHTML": { "visible": true }, "_chargeSet_chargeDefinitionCode": { "visible": true }, "_chargeSet_chargeDefIntegrationId": { "visible": true }, "_chargeSet_discountAmount": { "visible": true }, "_chargeSet_pricePeriod": { "visible": true }, "_chargeSet_priceType": { "visible": true }, "_chargeSet_unitPrice": { "visible": true }, "_chargeSet_discountValue": { "visible": true } } }, "limit": 1000, "count": 0, "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023482862/transactionLine/2/_chargeSet" } ], "items": [] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023482862/transactionLine/2" }, { "kind": "", "rel": "child", "name": "oRCL_charges", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023482862/transactionLine/2/oRCL_charges" }, { "kind": "", "rel": "child", "name": "_availableRatePlanSet", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023482862/transactionLine/2/_availableRatePlanSet" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023482862" } ], "_state": { "actions": { "save_l": { "visible": false }, "_calculate_price_action": { "visible": false }, "oRCL_ABO_CreateFollowOnOrder": { "enabled": false, "visible": false }, "saveChanges_l": { "visible": false }, "order_update_line": { "visible": false } }, "attributes": { "_price_quantity": { "updatable": false }, "contractStartDate_l": { "updatable": false }, "fulfillmentStatus_l": { "updatable": false, "visible": false }, "oRCL_ABO_ActionCode_l": { "updatable": false }, "priceScore_l": { "updatable": false }, "contractEndDate_l": { "updatable": false }, "_group_sequence_number": { "updatable": false } }, "queryState": { "hierarchyMatchStatus": "M", "hierarchyDepth": 0, "numOfAllDirectChildren": 0, "numOfMatchedDirectChildren": 0 } } } ] }, "_state": { "actions": { "_select_alternate_address_action": { "visible": false }, "_action_esig_send": { "enabled": true }, "_s_createAgreement": { "visible": false }, "_auto_fill_action": { "visible": false }, "updateAsset": { "visible": false }, "oRCL_ABO_DisplayAssets": { "visible": false }, "_s_publish_quote": { "visible": false }, "_action_esig_cancel": { "visible": false }, "order_update": { "visible": false }, "_browse_action": { "visible": false }, "oRCL_SFA_UpdateOpportunity": { "visible": false }, "versionTransaction_t": { "visible": false }, "revise_submit_t": { "visible": false }, "_view_crm_action": { "visible": false }, "_s_request_quote_revision": { "visible": false }, "order_reject": { "visible": false }, "oRCL_SFA_Return": { "visible": false }, "_action_esig_details": { "visible": false } }, "attributes": { "lastUpdatedDate_t": { "updatable": false }, "_s_billTo_t_state": { "updatable": false }, "_customer_t_phone": { "updatable": false }, "_customer_id": { "updatable": false }, "_s_billTo_t_city": { "updatable": false }, "_soldTo_t_city": { "updatable": false }, "_customer_t_state": { "updatable": false }, "contractTypeName_t": { "updatable": false }, "paymentTerms_t": { "updatable": false }, "_s_billTo_t_zip": { "updatable": false }, "contractStartDate_t": { "updatable": false }, "_s_shipToPartySiteID_t": { "updatable": false }, "_soldTo_t_state": { "updatable": false }, "_customer_t_address": { "updatable": false }, "oRCL_SFA_SyncTime_t": { "updatable": false }, "_shipTo_t_last_name": { "updatable": false }, "contractEndDate_t": { "updatable": false }, "_shipTo_t_state": { "updatable": false }, "fileAttachment_t": { "updatable": false }, "_soldTo_t_zip": { "updatable": false }, "contractName_t": { "updatable": false }, "_s_billTo_t_country": { "updatable": false }, "_customer_t_country": { "updatable": false }, "_s_soldToCustomerAccountID_t": { "updatable": false }, "_soldTo_t_last_name": { "updatable": false }, "_customer_t_email": { "updatable": false }, "_s_shipToPartyID_t": { "updatable": false }, "_s_quoteForAgreement_t": { "updatable": false }, "opportunityName_t": { "updatable": false }, "billToSiteUseId_t": { "updatable": false }, "_shipTo_t_email": { "updatable": false }, "_s_billTo_t_company_name": { "updatable": false }, "opportunityID_t": { "updatable": false }, "opportunityNumber_t": { "updatable": false }, "_soldTo_t_first_name": { "updatable": false }, "orderPlacedBy_t": { "visible": true }, "_soldTo_t_country": { "updatable": false }, "_shipTo_t_zip": { "updatable": false }, "oRCL_SFA_TransactionID_t": { "updatable": false }, "_customer_t_last_name": { "updatable": false }, "_customer_t_company_name": { "updatable": false }, "_s_accountIntegrationResponse_t": { "updatable": false }, "_shipTo_t_city": { "updatable": false }, "_shipTo_t_country": { "updatable": false }, "defaultRequestDate_t": { "updatable": false }, "orderDate_t": { "visible": true }, "priceScore_t": { "updatable": false }, "_s_billTo_t_address": { "updatable": false }, "_customer_t_city": { "updatable": false }, "_customer_t_address_2": { "updatable": false }, "transactionName_t": { "updatable": false }, "owner_t": { "updatable": false }, "_soldTo_t_email": { "updatable": false }, "_customer_t_zip": { "updatable": false }, "_customer_t_fax": { "updatable": false }, "_s_contractID_t": { "updatable": false }, "_s_soldToPartyID_t": { "updatable": false }, "_soldTo_t_company_name": { "updatable": false }, "_shipTo_t_first_name": { "updatable": false }, "_s_soldToPartySiteID_t": { "updatable": false }, "_soldTo_t_address": { "updatable": false }, "_customer_t_company_name_2": { "updatable": false }, "_shipTo_t_company_name": { "updatable": false }, "_s_billToCustomerAccountID_t": { "updatable": false }, "businessUnitId_t": { "updatable": false }, "_customer_t_first_name": { "updatable": false }, "_shipTo_t_address": { "updatable": false }, "status_t": { "updatable": false } } } }, "warnings": {}, "cacheInstanceId": "aEB9KWLAWCM9oxT3I1hzMD5HZnlStyortgql6CFvC6pOpgZJERtGQNtopEvuIcwf" }

Create Transaction
Description	Use this endpoint to create a new transaction with the part items, models, or favorite items listed in the request body.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following parameters: _currency_pref: The currency preference transactionLine: An array of items to be included in the new transaction. _favorite_id: The favorite Id to be added to this transaction. _model_path: The model path to be added to this transaction. _part_number: The part number to be added to this transaction. _price_book_var_name: The variable name of the price book used to get the price for this line item. _price_quantity: The quantity of parts to be added to this transaction.
Response Body Parameters	The JSON transaction data of the new transaction

URI Endpoint Sample

Request Sample

Response Sample

Create Transaction Version
Description	Use this endpoint to create a new version of the specified transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/versionTransaction_t
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

Response Body

{ "revisionId": "4,0", "documents": { "totalOneTimeListAmount_t": { "value": 200.0, "currency": "USD" }, "contactState_t": null, "contactCity_t": null, "_s_soldToPartyName_t": null, "_customer_id": "300100077646105", "_eSignatureAttributeSet_esig_file_attachment": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/36893204/attachmentAttributes/_eSignatureAttributeSet_esig_file_attachment/transactions/38892783/documentNumbers/1" }, "_invoiceTo_t_state": null, "orderKey_t": null, "mSDYNIsPrimaryQuote_c": false, "_invoiceTo_t_city": null, "transactionTotalDiscountPercent_t": 0.0, "_s_billTo_t_city": null, "_s_billTo_t_fax": null, "_customer_t_state": null, "totalContractValue_t": { "value": 401.0, "currency": "USD" }, "contractTypeName_t": null, "_s_billTo_t_phone": null, "contractStartDate_t": null, "_s_billTo_t_zip": null, "_s_shipToPartySiteID_t": null, "addressType_t": null, "_date_modified": "2024-06-09T19:08:31.000Z", "_invoiceTo_t_email": null, "_customer_t_address": null, "_soldTo_t_state": null, "hasRecurringPricing_t": true, "contactType_t": null, "contactProvince_t": null, "_s_contactNumber_t": null, "accountAddressElementAttribute5_t": null, "totalAnnualCostAmount_t": { "value": 0.0, "currency": "USD" }, "_shipTo_t_last_name": null, "contractEndDate_t": null, "mSDYNObjectName_c": null, "_invoiceTo_t_company_name_2": null, "contactUniqueName_t": null, "_soldTo_t_zip": null, "contractName_t": null, "_soldTo_t_fax": null, "_customer_t_country": null, "totalOneTimeNetAmount_t": { "value": 200.0, "currency": "USD" }, "bs_id": "38892783", "contactAddressLine4_t": null, "_s_soldToCustomerAccountID_t": null, "contactMiddleName_t": null, "currentStepForTesting_tempDisplay_t": "Signed", "_submitted_by_submit_t": "", "_customer_t_email": null, "oRCL_SFA_PrimaryOrgID_t": null, "accountUniqueName_t": null, "billToSiteUseId_t": null, "_partner_price_book_id": null, "opportunityNumber_t": null, "totalContractDiscount_t": { "value": 0.0, "currency": "USD" }, "priceWithinPolicy_t": true, "_soldTo_t_first_name": null, "totalOneTimeCostAmount_t": { "value": 0.0, "currency": "USD" }, "subscription_Status_t": null, "_invoiceTo_t_company_name": null, "accountPostalCode_t": null, "_locked_by_user_login": null, "_reject_link": "", "_soldTo_t_country": null, "_shipTo_t_zip": null, "oRCL_SFA_TransactionID_t": null, "_shipTo_t_fax": null, "_customer_t_company_name": null, "accountEmailAddress_t": null, "contactAddressLine3_t": null, "_s_accountIntegrationResponse_t": null, "userKey_t": "CPQ-83v2", "totalContractCostAmount_t": { "value": 0.0, "currency": "USD" }, "_s_isPublished_t": null, "priceExpirationDate_t": null, "_s_customerStatus_t": null, "_locked_time": null, "_transaction_total": null, "annualContractListValue_t": { "value": 201.0, "currency": "USD" }, "_s_billTo_t_address": null, "approve_reject_icon_submit_t": null, "oRCL_ERP_OrderID_t": null, "_s_accountPartyId_t": "300100077646105", "accountAddressLine1_t": null, "totalRecurRevenue_t": { "value": 201.0, "currency": "USD" }, "_s_customerVisibilityIdentifier_t": null, "priceType_t": null, "_customer_t_city": null, "_esigTest_c_esig_date_modified": null, "totalOneTimeMarginAmount_t": { "value": 200.0, "currency": "USD" }, "_esigTest_c_esig_status": null, "_eSignatureAttributeSet_esig_date_modified": null, "proposalExists_t": false, "accountAddressElementAttribute3_t": null, "oRCL_SFA_Status_t": "ZCA_IN_PROGRESS", "coverLetter_t": null, "contactAddressElementAttribute4_t": null, "transactionName_t": "01/08 ", "contactLastName_t": null, "_pp_id": 36918117, "_document_number": "1", "_esigTest_c_esig_recipients": null, "_shipTo_t_phone": null, "owner_t": "Albert M", "_soldTo_t_email": null, "contactFirstName_t": null, "_invoiceTo_t_first_name": null, "_customer_t_zip": null, "_lock_status": false, "_customer_t_fax": null, "currency_t": { "displayValue": "USD", "value": "USD" }, "totalMonthlyListAmount_t": { "value": 0.0, "currency": "USD" }, "_s_contractID_t": null, "_s_transactionSource_t": null, "renewalProcess_t": null, "totalContractListValue_t": { "value": 401.0, "currency": "USD" }, "_eSignatureAttributeSet_esig_status": { "displayValue": "Not Sent", "value": "Not Sent" }, "accountAddressLine2_t": null, "_soldTo_t_company_name": null, "_shipTo_t_first_name": null, "_s_soldToPartyID_t": null, "_s_soldToPartySiteID_t": null, "_invoiceTo_t_country": null, "version_t": 2, "_shipTo_t_company_name": null, "accountName_t": null, "contactAddressLine2_t": null, "accountAddressElementAttribute4_t": null, "accountState_t": null, "_price_book_custom_fields": { "value": null }, "contactAddressElementAttribute5_t": null, "_price_book_var_name": "_default_price_book", "_locked_by_user": -1, "_s_billToCustomerAccountID_t": null, "_revenueCategory_t": null, "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_shipTo_t_address": null, "contactEmailAddress_t": null, "totalOneTimeDiscount_t": { "value": 0.0, "currency": "USD" }, "totalMonthlyNetAmount_t": { "value": 0.0, "currency": "USD" }, "winLossStatus_t": { "displayValue": "In Progress", "value": "IN PROGRESS" }, "freezePriceFlag_t": true, "lastUpdatedDate_t": "2024-06-09T19:08:00Z", "accountProvince_t": null, "_s_billTo_t_state": null, "_price_book_desc": "Default Price Book (1.0 x base price)", "_document_var_name": "transaction", "_s_accountContactNumber_t": null, "_invoiceTo_t_address": null, "renewalErrorEmailAddress_t": null, "accountType_t": null, "_customer_t_phone": null, "lastPricedDate_t": "2024-01-08T18:34:00Z", "lastUpdatedBy_t": "Albert M", "_price_book_name": "Base Price", "_s_contractTypeID_t": null, "accountAddressElementAttribute1_t": null, "partialShipAllowedFlag_t": false, "oRCL_ERP_OrderNumber_t": null, "_soldTo_t_city": null, "primaryFlag_t": false, "paymentTerms_t": null, "totalMonthlyUsageRev_t": { "value": 0.0, "currency": "USD" }, "createdDate_t": "2024-06-09", "oRCL_SFA_SyncTime_t": "1900-01-01T00:00:00", "accountAddressLine3_t": null, "approval_status_submit_t": null, "contactAddressLine1_t": null, "transactionDescription_t": null, "totalMonthlyCostAmount_t": { "value": 0.0, "currency": "USD" }, "_date_added": "2024-06-09T19:08:31.000Z", "_s_contactPartyNumber_t": null, "contactAddressElementAttribute2_t": null, "contactName_t": null, "_invoiceTo_t_phone": null, "_s_invoiceToPartySiteID_t": null, "oRCL_ERP_PartialShipAllowed_t": false, "_s_billTo_t_address_2": null, "_shipTo_t_state": null, "totalUsageRevenue_t": { "value": 0.0, "currency": "USD" }, "fileAttachment_t": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/36893204/attachmentAttributes/fileAttachment_t/transactions/38892783/documentNumbers/1" }, "_soldTo_t_address_2": null, "invoiceToPartyID_t": null, "_esigTest_c_esig_file_attachment": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/36893204/attachmentAttributes/_esigTest_c_esig_file_attachment/transactions/38892783/documentNumbers/1" }, "_process_var_name": "oraclecpqo", "_locked_by_user_first_name": null, "_invoiceTo_t_zip": null, "_s_billTo_t_country": null, "createdBy_t": "Albert M", "contractedPeriods_t": 1, "_soldTo_t_last_name": null, "contactNameSuffix_t": null, "_s_assignedTo_t": null, "_s_shipToPartyID_t": null, "_s_accountPartyNumber_t": null, "accountCity_t": null, "_locked_by_user_last_name": null, "accountAddressLine4_t": null, "_s_billTo_t_last_name": null, "renewalProcessUsed_t": null, "_eSignatureAttributeSet_esig_envelope_id": null, "mSDYNPrimaryQuoteId_c": null, "transactionID_t": "CPQ-83", "accountAddressElementAttribute2_t": null, "_buyer_company_name": "cpq-techwriter1", "opportunityName_t": null, "renewDraftSubscriptionNumber_t": null, "totalMonthlyDiscount_t": { "value": 0.0, "currency": "USD" }, "_invoiceTo_t_fax": null, "_shipTo_t_email": null, "contactAddressElementAttribute3_t": null, "_s_hostCompanyFullName_t": null, "parent_transaction_id_versionTransaction_t": "38456469", "_s_billTo_t_company_name": null, "opportunityID_t": null, "_date_tx_modified": "2024-06-09T19:08:31.000Z", "fulfillmentStatus_t": null, "_soldTo_t_phone": null, "_s_billToCustomerAccountName_t": null, "_eSignatureAttributeSet_esig_recipients": null, "accountMiddleName_t": null, "accountLastName_t": null, "accountNameSuffix_t": null, "approval_history_submit_t": null, "_customer_t_last_name": null, "salesChannel_t": null, "totalAnnualValue_t": { "value": 201.0, "currency": "USD" }, "_shipTo_t_city": null, "_shipTo_t_country": null, "contactCountry_t": null, "defaultRequestDate_t": null, "mSDYNOpportunityLineIds_c": null, "priceScore_t": 9, "transactionMarginPercent_t": 100.0, "purchaseOrderNumber_t": null, "_last_document_number": 2, "_approve_link": "", "_price_book_custom_field_text": { "value": null }, "_customer_t_address_2": null, "requireApprovalIfChecked_temporary_t": false, "_id": 38892783, "_invoiceTo_t_address_2": null, "subscriptionProfileId_t": "300100172161473", "_shipTo_t_company_name_2": null, "transactionSourceSystem_t": "ORA_BM_CPQ", "accountFirstName_t": null, "triggerUpdateAssetForLineStatus_t": "AWAIT_BILLING~ACTIVATED", "totalAnnualMarginAmount_t": { "value": 201.0, "currency": "USD" }, "_s_billTo_t_email": null, "createOrderRestResponse": null, "_shipTo_t_address_2": null, "contactPostalCode_t": null, "_step_var_name": "signed", "_soldTo_t_company_name_2": null, "oRCL_SFA_OwnerResourcePartyID_t": null, "accountCountry_t": null, "_esigTest_c_esig_envelope_id": null, "businessUnitName_t": "Vision Operations", "_s_billTo_t_first_name": null, "TotalAnnualDiscount_t": { "value": 0.0, "currency": "USD" }, "_soldTo_t_address": null, "_invoiceTo_t_last_name": null, "totalContractMarginAmount_t": { "value": 401.0, "currency": "USD" }, "_customer_t_company_name_2": null, "_s_subscriptionId_t": null, "approval_revision_submit_t": 1, "contactAddressElementAttribute1_t": null, "_supplier_company_name": "cpq-techwriter1", "_s_customerPartySiteID_t": null, "version_number_versionTransaction_t": "2", "businessUnitId_t": null, "_customer_t_first_name": null, "oRCL_billingFrequency_t": null, "_s_billTo_t_company_name_2": null, "totalMonthlyMarginAmount_t": { "value": 0.0, "currency": "USD" }, "_pp_name": "Default", "status_t": { "displayValue": "Created", "value": "CREATED" }, "transactionLine": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892783/transactionLine" } ], "items": [{ "_line_bom_attributes": null, "_availableRatePlans": null, "listAmount_l": { "value": 200.0, "currency": "USD" }, "discountAmount_l": { "value": 0.0, "currency": "USD" }, "rollupFlag_l": false, "contractStartDate_l": "2024-01-09", "_model_partner_entity_id": null, "listPriceRollup_l": { "value": 401.0, "currency": "USD" }, "_config_attributes": { "value": null }, "_part_sale_enabled": "Y", "recurringRevSummable_l": { "value": 0.0, "currency": "USD" }, "fulfillmentLineId_l": null, "_part_display_number": "Sentinel Standard Desktop - TP", "_model_attributes": { "value": null }, "_price_list_price_each": { "value": 0.0, "currency": "USD" }, "_line_bom_effective_date": null, "includedInBasePrice": null, "_parent_line_item": null, "_date_modified": "2024-06-09T19:08:31.000Z", "rootAssetKey_l": "abo_f4cff40d-6df9-4b3d-bab1-c19ab3f087c0", "annualMargin_l": { "value": 0.0, "currency": "USD" }, "_model_product_line_attributes": { "value": null }, "_price_configurable_price": { "value": 0.0, "currency": "USD" }, "costAmount_l": { "value": 0.0, "currency": "USD" }, "_is_part_pricing_rule_price": true, "_part_default_uom": "Ea", "discountPercent_l": 0.0, "_part_sales_product_type": null, "contractEndDate_l": "2024-01-24", "_last_modified_date": "2024-06-09 19:08:31", "_s_freezeNegotiationFlag_l": null, "subscriptionId_l": null, "_config_extra_info": null, "suspendDate_l": null, "unitMargin_l": { "value": 200.0, "currency": "USD" }, "resumeDate_l": null, "_part_number": "AS54111", "_sequence_number": 1, "_line_bom_display_name": null, "unitCost_l": null, "_price_applied_agreement_integrationId": null, "_price_unit_price_each": { "value": 200.0, "currency": "USD" }, "_model_base_price": null, "customDiscountValue_l": null, "_model_product_line_name": null, "_price_item_price_each": { "value": 0.0, "currency": "USD" }, "recurRevRollup_l": { "value": 201.0, "currency": "USD" }, "monthlyUsageRevRollup_l": { "value": 0.0, "currency": "USD" }, "_transaction_currency_pref": { "id": 5190368, "currencyCode": "USD" }, "oRCL_ABO_ComponentAttributes_l": null, "_price_applied_ratePlan_integrationId": null, "priceWithinPolicy_l": true, "_part_serv_req_enabled": "Y", "_model_supplier_company_id": null, "_model_segment_id": null, "_partner_entity_id": "45382", "requestDate_l": null, "_part_base_price": { "value": 0.0, "currency": "USD" }, "contractMargin_l": { "value": 200.0, "currency": "USD" }, "pricePeriod_l": null, "changeCode_l": null, "associatedLineId_l": null, "_model_partner_organization_id": null, "_model_segment_name": null, "priceType_l": { "displayValue": "One Time", "value": "One Time" }, "nonRecurRevRollup_l": { "value": 200.0, "currency": "USD" }, "oRCL_SFA_Status_l": "ZCA_IN_PROGRESS", "_config_attr_info": { "value": null }, "_s_partID_l": null, "contractListValueRollup_l": { "value": 401.0, "currency": "USD" }, "contractValue_l": { "value": 200.0, "currency": "USD" }, "netAmountRollup_l": { "value": 401.0, "currency": "USD" }, "_prior_price": null, "customDiscountAmount_l": { "value": 0.0, "currency": "USD" }, "_parent_doc_number": null, "requestShipDate_l": "2024-01-08", "_reconfiguration_date": "1970-01-01 00:00:00", "annualCost_l": { "value": 0.0, "currency": "USD" }, "_part_desc": "1 GHz Pentium® IV processor. 128MB SDRAM memory at 100MHz. Hard Drive 20GB RAM. 1 - 5.25\" drive bay, 4 PCI slots. Maximum Microsoft Windows® 2000. CD-Rom drive.", "_chargeSetControl": 1, "_pp_id": 36918117, "_document_number": 2, "parentAssetKey_l": null, "_rollup_delta_price": null, "_is_bom_price": false, "winLossStatus_l": { "displayValue": "In Progress", "value": "IN PROGRESS" }, "_price_calculation_info": "[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price Model\",\"_isAgreement\":false,\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"Base Pricing Rule\",\"_runningUnitPrice\":200.0}]", "associatedOrderId_l": null, "_price_applied_ratePlan": null, "_price_component_prices": { "value": null }, "discountPercentRollup_l": 0.0, "_part_supplier_company_id": "4118171", "_original_document_number": "-1", "contractListValue_l": { "value": 200.0, "currency": "USD" }, "_line_item_spare_rule_var_name": null, "_price_applied_agreement_name": null, "_revenueCategory_l": null, "_part_id": "37834120", "_part_company_associations": null, "_part_default_periods": "N/A", "marginPercent_l": 100.0, "_price_book_var_name": "_default_price_book", "customDiscountType_l": null, "_model_sales_product_type": null, "_group_sequence_number": "1.0", "_price_applied_ratePlan_number": null, "lastUpdatedDate_l": null, "_price_quantity": 1, "paymentTerms_l": null, "lastUpdatedBy_l": "Albert M", "_part_supplier_company_name": "cpqext-009", "_document_var_name": "transactionLine", "mSDYNOpportunityLineId_c": null, "_part_default_price_type": null, "createdDate_l": "2024-01-08T18:34:00Z", "contractCost_l": { "value": 0.0, "currency": "USD" }, "contractDiscount_l": { "value": 0.0, "currency": "USD" }, "_line_bom_name": null, "oRCL_ERP_OrderNumber_l": null, "_model_is_valid": false, "_part_external_key2": null, "_part_external_key1": null, "changeReason_l": null, "_config_attr_text": { "value": null }, "itemInstanceName_l": null, "priceRecurFrequencyRollup_l": { "displayValue": "Per Year", "value": "YEARLY" }, "_price_applied_agreement_number": null, "_line_bom_model_path": null, "_model_id": null, "_availableRatePlanSetControl": 0, "_date_added": "2024-06-09T19:08:31.000Z", "_model_product_line_id": null, "requestedUnitOfMeasure_l": { "displayValue": "Each", "value": "Ea" }, "usageRevSummable_l": { "value": 0.0, "currency": "USD" }, "monthlyRecurRevRollup_l": { "value": 0.0, "currency": "USD" }, "_configuration_id": null, "_model_bom": null, "contractedPeriods_l": 1, "createdBy_l": "Albert M", "parentdocumentNumber_l": null, "fulfillmentStatus_l": { "displayValue": "Created", "value": "CREATED" }, "_model_variable_name": null, "monthlyRecurRevSummable_l": { "value": 0.0, "currency": "USD" }, "_model_product_line_var_name": null, "_is_recommended_price": false, "_transactionLine_id": "38892783_2", "annualListValue_l": { "value": 0.0, "currency": "USD" }, "lastPriced_c": null, "_line_bom_id": "SPI_2", "_model_supplier_company_name": null, "rootLine_l": { "displayValue": "Y", "value": "Y" }, "lineType_l": { "displayValue": "Part", "value": "PART" }, "transactionID_l": "38892783", "_line_bom_part_number": "AS54111", "usageRevRollup_l": { "value": 0.0, "currency": "USD" }, "itemInstanceId_l": "abo_f4cff40d-6df9-4b3d-bab1-c19ab3f087c0", "_s_coverageOrderNumber": null, "_s_coverageLineNumber": null, "_line_bom_item_quantity": 1, "annualDiscount_l": { "value": 0.0, "currency": "USD" }, "_model_segment_var_name": null, "_line_bom_level": 0, "_bs_id": 38892783, "netAmount_l": { "value": 200.0, "currency": "USD" }, "orderDate_l": null, "_part_units": null, "_part_direct_buy": "1", "salesChannel_l": null, "oRCL_SFA_InventoryItemID_l": "45382", "oRCL_ABO_ActionCode_l": { "displayValue": "Add", "value": "ADD" }, "priceRecurFrequency_l": null, "_line_bom_parent_id": null, "priceScore_l": 9, "_line_item_type": null, "_part_default_periodicity": null, "_delta_price": null, "_line_display_name": "Sentinel Standard Desktop - TP", "netPrice_l": { "value": 200.0, "currency": "USD" }, "_revenueId_l": null, "freezeNegotiationFlag_l": false, "renewDate_l": null, "_price_type": "One Time", "listPrice_l": { "value": 200.0, "currency": "USD" }, "_part_extended_desc_2": null, "documentNumber_l": "2", "_part_extended_desc_1": null, "nonRecurRevSummable_l": { "value": 200.0, "currency": "USD" }, "priceTypeRollup_l": { "displayValue": "Mixed", "value": "Mixed" }, "contractedPeriodsRollup_l": 1, "_is_line_item_mandatory": false, "_price_period": null, "ownerResourceId_l": null, "_id": 38892785, "_is_coverage": false, "_part_lead_time": "N/A", "lineNumber_l": null, "_part_css_enabled": "N", "subscriptionLineId_l": null, "status_l": { "displayValue": "Created", "value": "CREATED" }, "_line_item_comment": null, "contractValueRollup_l": { "value": 401.0, "currency": "USD" }, "_line_bom_sequence_index": null, "_step_var_name": "signed", "_model_name": null, "_config_attr_values": null, "_part_drawing_position": null, "fulfillmentOrganizationCode_l": null, "_pricing_rule_price_each": { "value": 200.0, "currency": "USD" }, "monthlyUsageRevSummable_l": { "value": 0.0, "currency": "USD" }, "_line_bom_variable_name": null, "marginAmount_l": { "value": 200.0, "currency": "USD" }, "_partner_organization_id": "204", "netPriceRollup_l": { "value": 401.0, "currency": "USD" }, "annualValue_l": { "value": 0.0, "currency": "USD" }, "_pp_name": "Default", "oRCL_SFA_InventoryOrgID_l": "204", "_line_bom_condition_index": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892783/transactionLine/2" }, { "kind": "", "rel": "child", "name": "_chargeSet", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892783/transactionLine/2/_chargeSet" }, { "kind": "", "rel": "child", "name": "_availableRatePlanSet", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892783/transactionLine/2/_availableRatePlanSet" }, { "kind": "", "rel": "child", "name": "oRCL_charges", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892783/transactionLine/2/oRCL_charges" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38892783" } ] } ] } }, "warnings": {} }

Display History
Description	Use this endpoint to retrieve historical changes for a transaction using criteria defined in the request body.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/{displayHistoryActionVarName}
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used tospecify query parameters for the history response. historyHeader - used to specify fields for the history header in the response. Available fields: dateFormat and _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, documentNumber, oldValue, newValue revisionId: This string parameter contains the revision information.
Response Body Parameters	JSON data containing the transaction history

URI Endpoint Sample

Request Body Examples and Sample

Response Body Sample

Drop Cache
Description	Use this endpoint to eliminate the cache created through REST web services. Drop Cache can improve site performance by removing cached objects that would otherwise remain in memory for the duration of the timeout specified in administration.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_dropCache
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	POST
Request Body Parameters	cacheInstanceId	The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database.
Response Body Parameters	cacheInstanceId	The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database.

URI Endpoint Sample

Request Sample

{"cacheInstanceId": "E9JuyC9QCgTDS9edghTNxRGOVUm34EMR7RJt9alFbkGTN0X5byTjHGRu1CxrSl1p"}

URI Endpoint Sample

Response Body Sample

Email - Send Transaction Email
Description	Use this endpoint to collect email form data, generates the attachment, pushes the email to SMTP servers, and returns confirmation on email sent time. The email recipient receives an email with the comments in the email body and an attachment that contains the transaction information.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_send_email
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: actionVariableName: The email action variable name used to generate the email attachmentIds: An array of attachments to send with the email availableAttachmentsForMerge: An array of attachments which can be merged with the proposal document bccEmail: The bcc email address(es) cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. ccEmail: The cc email address(es) comments: Comments to be sent in the email body fromEmail: The sender's email address fromName: The sender's name languageCode: The language preference for sending email subject: The email subject line toEmail: The recipient's email address(es) toName: The recipient's name xslViews: Printer friendly proposals or history outputs generated from predefined XSL templates.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. message: The summary message for sending email

URI Endpoint Sample

Request Body Sample

Response Body Sample

{ "message": "Your email was sent on 06/26/2024 4: 42PM", "cacheInstanceId": "5J9MTQAbF1ZmcJGnul6y4WOrAydsRpSyR2vvW1o7fWkrEkO89aiFxbEQSIUCEnF4" }

URI Endpoint Sample

Sample Request Body

Sample Response Body

URI Endpoint Sample

Sample Request Body

Sample Response Body

URI Endpoint Sample

Sample Request Body

Sample Response Body

URI Endpoint Sample

Request Body Sample

{ "documents": { "quoteDescription": "updated quote description", "lineItem": { "items": [{ "_price_quantity": 304, "_document_number": 3 } ] } } }

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/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/generateProposal
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied.
Response Body Parameters	This endpoint supports the following parameters: availableAttachmentsForMerge: An array of attachments which can be merged with the proposal document cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. documents: The transaction object fileAttachmentAttribute: The file attachment attribute used for confirmation generatedProposalAttachmentForMerge: The default selected attachment for an email or print action. languageAttributeValue: Language attribute value for the print document layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object. xslViews: Printer friendly proposals or history outputs generated from predefined XSL templates.

URI Endpoint Sample

Request Sample

Response Sample

Get Transaction
Description	Use this endpoint to retrieve the specified transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 query parameters to limit results or retrieve specific content: excludeFieldTypes - An array of field names that you want to exclude in the response. expand - An array of child resource names that you want to expand so that the contents return with the parent in the same request.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	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.

URI Endpoint Sample

Sample Response Body

{ "_last_document_number" : "1", "paymentTerms_t" : "Net 30", "bs_id" : "36311839", "_price_book_var_name" : "", "totalOneTimeNetAmount_t" : "60045.28", "currentStepForTesting_tempDisplay_t" : "start_step", "totalMonthlyDiscount_t" : "0", "_customer_t_address" : "1234 Test Rd", "_step_var_name" : "start_step", "_curr_reason_variable_name" : "", "transactionName_t" : "TestCo1 #1", "parent_transaction_id_versionTransaction_t" : "36311839", "_supplier_company_name" : "cpq", "status_t" : "CREATED", "approve_reject_icon_submit_t" : "", "_document_link" : "", "createdDate_t" : "2015-02-26 00:00:00", "_customer_t_state" : "IL", "_curr_reason_desc" : "", "_document_number" : "1", "requireApprovalIfChecked_temporary_t" : "false", "opportunityName_t" : "", "totalMonthlyNetAmount_t" : "4899.89", "_date_added" : "2015-11-15 19:49:25.0", "_process_var_name" : "oraclecpqo", "userKey_t" : "CPQ-3v12", "_date_modified" : "2015-11-15 21:05:41.0", "_customer_t_address_2" : "", "taxExempt_t" : "false", "totalAnnualValue_t" : "118843.96", "salesChannel_t" : "", "approval_revision_submit_t" : "1", "_id" : "36365138", "_invoiceTo_t_last_name" : "Co", "_invoiceTo_t_phone" : "555-555-5555", "statusPartial_t" : "false", "_invoiceTo_t_company_name" : "TestCo1", "_customer_t_city" : "Chicago", "_customer_t_email" : "testco1@testco1.com", "createdBy_t" : "Anna Howell", "_customer_t_last_name" : "Co", "priceExpirationDate_t" : "", "lastPricedDate_t" : "2015-02-26 10:15:00", "_curr_reason_name" : "", "_invoiceTo_t_state" : "IL", "_customer_t_first_name" : "Test", "statusDate_t" : "", "totalContractValue_t" : "236133.32", "_invoiceTo_t_address_2" : "", "purchaseOrderNumber_t" : "", "version_t" : "1", "_invoiceTo_t_email" : "testco1@testco1.com", "approval_status_submit_t" : "", "_customer_t_company_name_2" : "", "opportunityID_t" : "", "totalOneTimeDiscount_t" : "310", "currency_t" : "USD", "_document_var_name" : "transaction", "hasRecurringPricing_t" : "true", "_customer_t_zip" : "60641", "_customer_t_company_name" : "TestCo1", "_invoiceTo_t_zip" : "60641", "_invoiceTo_t_company_name_2" : "", "totalMonthlyListAmount_t" : "4899.89", "taxExemptReason_t" : "", "_buyer_company_name" : "cpq", "_next_approver" : "", "totalOneTimeListAmount_t" : "60355.28", "_submitted_by_submit_t" : "", "_invoiceTo_t_address" : "1234 Test Rd", "approval_history_submit_t" : "", "_customer_t_fax" : "555-555-5555", "_customer_t_phone" : "555-555-5555", "_transaction_total" : "236133.32", "_invoiceTo_t_first_name" : "Test", "lastUpdatedBy_t" : "Super User", "priceWithinPolicy_t" : "true", "owner_t" : "Anna Howell", "lastUpdatedDate_t" : "2015-02-26 10:23:00", "_approve_reject_comment" : "", "transactionID_t" : "CPQ-3", "_currency_pref" : "USD", "_submit_comment" : "", "_invoiceTo_t_fax" : "555-555-5555", "_curr_approver" : "", "version_number_versionTransaction_t" : "2", "_customer_t_country" : "United States", "_invoiceTo_t_city" : "Chicago", "_invoiceTo_t_country" : "United States", "links" : [ { "rel" : "self", "href" : "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/36365138" }, { "name" : "transactionLine", "rel" : "child", "href" : "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/36365138/transactionLine", "kind" : "" } ] }

Get Transactions
Description	This operation retrieves all transactions.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
Query Parameters	This endpoint supports the following optional query parameters to limit results or retrieve specific content: excludeFieldTypes - An array of field names that you want to exclude in the response. expand - An array of child resource names that you want to expand so that the contents return with the parent in the same request. fields - An array of field names to be returned. The fields array values determine the "attributes" in the response's state object. limit - A positive integer value that specifies the maximum number of items returned by the server. offset - A non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection. orderby - An array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload. q - A filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied. totalResults - This Boolean parameter specifies whether to calculate the total results. By default, this value is set to false indicating that total results is not calculated.
	Notes: When using the "q" parameter, Transactions attributes must be defined as Data Columns. Additionally, query any strings cannot exceed the Data Column 100 character limit. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The JSON data for the requested transaction.

URI Endpoint Sample

Get Transaction Comment
Description	Use this endpoint to retrieve the specified transaction comment.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/_s_transactionComments_t/{_row_number}
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
	_row_number	Unique row number to be used as row identifier for the comment.
Query Parameters	This endpoint supports the optional excludeFieldTypes to exclude fields in the response.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	bs_id	The commerce transaction Id.
	currency_pref	The currency preference.
	_document_number	The sub-document number.
	_row_number	Unique row number to be used as row identifier for the comment.
	_s_commentDate	The date of the comment
	_s_commentor	Name of the person who created this comment.
	_s_customerComment	The comment text
	_s_isInternalComment	Determines if this comment should be visible to customer/buyer persona.
	_sequence_number	The sequence number
	_state	Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.

URI Endpoint Sample

Sample Response Body

{ "_sequence_number": 2, "_document_number": 1, "_s_commentDate": "2024-08-29T14:31:00Z", "_s_commentor": "Adam Jones", "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_bs_id": 40155914, "_row_number": 2, "_s_customerComment": "Accepting the Quote", "_s_isInternalComment": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/40155914/_s_transactionComments_t/2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/40155914" } ] }

Get Transaction Comments
Description	Use this endpoint to retrieve comments for the specified transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/_s_transactionComments_t
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 query parameters to limit results or retrieve specific content: excludeFieldTypes - An array of field names that you want to exclude in the response. fields - An array of field names to be returned. The fields array values determine the "attributes" in the response's state object. limit - A positive integer value that specifies the maximum number of items returned by the server. offset - A non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection. orderby - An array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload. q - A filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied. totalResults - This Boolean parameter specifies whether to calculate the total results. By default, this value is set to false indicating that total results is not calculated.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The JSON data for the requested transaction comments.
	bs_id	The commerce transaction Id.
	currency_pref	The currency preference.
	_document_number	The sub-document number.
	_row_number	Unique row number to be used as row identifier for the comment.
	_s_commentDate	The date of the comment
	_s_commentor	Name of the person who created this comment.
	_s_customerComment	The comment text
	_s_isInternalComment	Determines if this comment should be visible to customer/buyer persona.
	_sequence_number	The sequence number
	_state	Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.

URI Endpoint Sample

Sample Response Body

{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/40155914/_s_transactionComments_t" } ], "items": [{ "_sequence_number": 1, "_document_number": 1, "_s_commentDate": "2024-08-29T13:51:00Z", "_s_commentor": "James Horton (Sales Rep)", "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_bs_id": 40155914, "_row_number": 1, "_s_customerComment": "Please review the published quote and take an appropriate action.", "_s_isInternalComment": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/40155914/_s_transactionComments_t/1" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/40155914" } ] }, { "_sequence_number": 2, "_document_number": 1, "_s_commentDate": "2024-08-29T14:31:00Z", "_s_commentor": "Adam Jones", "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_bs_id": 40155914, "_row_number": 2, "_s_customerComment": "Accepting the Quote", "_s_isInternalComment": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/40155914/_s_transactionComments_t/2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/40155914" } ] } ] }

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/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_interact
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	POST
Request Body Parameters	focus	The attribute that the user is currently editing. The format matches that of the triggerAttrVarName parameter. If the value of the focus parameter 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 is 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 endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. deleteRows: An array line items to delete. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object revisionId: This string parameter contains the revision information.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information.

Modify Item in Cache

URI Endpoint Sample

Request Sample

Re-Sequence Line Items via Interact

This action re-sequences Transaction Lines via the interact action.

URI Endpoint Sample

Request Body Sample

{ "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/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/lockTransaction
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. revisionId: This string parameter contains the revision information.
Response Body Parameters	The JSON data for the requested transaction

URI Endpoint Sample

Open Transaction
Description	Use this endpoint to open a previously saved transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_open_transaction
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. deleteRows: An array line items to delete. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. destinationURL: The destination url as defined in destination tab in action definition. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/18097326/actions/_open_transaction

Orders - Cancel Sales Order
Description	Use this endpoint to cancel a sales order or order lines in an external order management system.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_cancel
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. deleteRows: An array line items to delete. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. destinationURL: The destination url as defined in destination tab in action definition. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

/rest/v19/commerceDocumentsOraclecpqoTransaction/18103143/actions/order_cancel

Orders - Reject Sales Order
Description	Use this endpoint to reject an external order management system sales order.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_reject
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. deleteRows: An array line items to delete. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. destinationURL: The destination url as defined in destination tab in action definition. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

/rest/v19/commerceDocumentsOraclecpqoTransaction/18103143/actions/order_reject

Orders - Start Sales Order
Description	Use this endpoint to create a sales order for submission to an external order management system.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_start
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. deleteRows: An array line items to delete. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. destinationURL: The destination url as defined in destination tab in action definition. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

/rest/v19/commerceDocumentsOraclecpqoTransaction/18103143/actions/order_start

Orders - Update Sales Order
Description	Use this endpoint to update an external order management system sales order.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/order_update
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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 parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. criteria: This query definition is used to retrieve specific content and limit the size of the response. deleteRows: An array line items to delete. delta: This Boolean parameter is used to request a delta response for data as well as state in the context of current criteria. documents: The transaction object freezePrice: This Boolean parameter indicates if prices are frozen for this transaction. If true, then CPQ pricing calculation won't impact prices. revisionId: This string parameter contains the revision information. selectionMode: This parameter Indicates how selections content should be interpreted. selections: An array of selected items. skipIntegration: This Boolean parameter indicates if the integration tab logic is applied. skipRules: An array of rules to skip.
Response Body Parameters	This endpoint supports the following parameters: cacheInstanceId: The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from the first create transaction or open transaction action and passed along in subsequent modify or Interact actions to avoid reloading transaction data from the database. destinationURL: The destination url as defined in destination tab in action definition. documents: The transaction object layoutVariableName: The Redwood quote variable name. revisionId: This string parameter contains the revision information. warnings: An array of messages that have been generated for a specific object.

URI Endpoint Sample

/rest/v19/commerceDocumentsOraclecpqoTransaction/18103143/actions/order_update

URI Endpoint Sample

Request Body Sample

Response Body Sample

URI Endpoint Sample

Request Body Sample

Response Body Sample

{ "revisionId": "125,0", "generatedProposalAttachmentForMerge": [{ "id": -2, "name": "GENERATED PROPOSAL" } ], "availableAttachmentsForMerge": [{ "id": 3023197953, "name": "Document.pdf (Transaction - File Attachment)" } ], "warnings": {}, "xslViews": [{ "id": 3023147879, "name": "Document(Printer Friendly/History)", "isMergeAttachmentSupported": true, "isPDFReadOnly": true, "xslOutPutType": "PDF", "languageSupportType": "SINGLE", "defaultLanguageName": "English(en)", "defaultLanguageCode": "en" }, { "id": 3023196507, "name": "Document2(Printer Friendly/History)", "isMergeAttachmentSupported": true, "isPDFReadOnly": false, "xslOutPutType": "PDF", "languageSupportType": "MULTIPLE", "defaultLanguageName": "English(en)", "defaultLanguageCode": "en" }, { "id": 3023198367, "name": "GermanDocument(Printer Friendly/History)", "isMergeAttachmentSupported": true, "isPDFReadOnly": true, "xslOutPutType": "PDF", "languageSupportType": "SINGLE", "defaultLanguageName": "German(de)", "defaultLanguageCode": "de" }, { "id": 3023222058, "name": "RTFDocument(Printer Friendly/History)", "isMergeAttachmentSupported": false, "isPDFReadOnly": false, "xslOutPutType": "RTF", "languageSupportType": "SINGLE", "defaultLanguageName": "English(en)", "defaultLanguageCode": "en" }, { "id": 3023222062, "name": "docxDocument(Printer Friendly/History)", "isMergeAttachmentSupported": false, "isPDFReadOnly": false, "xslOutPutType": "DOCX", "languageSupportType": "SINGLE", "defaultLanguageName": "English(en)", "defaultLanguageCode": "en" }, { "id": 3023222066, "name": "xmlTemplateDocument(Printer Friendly/History)", "isMergeAttachmentSupported": false, "isPDFReadOnly": false, "xslOutPutType": "XML", "languageSupportType": "SINGLE", "defaultLanguageName": "English(en)", "defaultLanguageCode": "en" }, { "id": 3023222070, "name": "noneDocument(Printer Friendly/History)", "isMergeAttachmentSupported": false, "isPDFReadOnly": false, "xslOutPutType": "SIMPLE", "languageSupportType": "SINGLE", "defaultLanguageName": "English(en)", "defaultLanguageCode": "en" } ] }

Print Transaction Document
Description	Use this endpoint to print the generated transaction document.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_print_document
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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
	languagePref	The language preference selected by user
	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}
	xslview	Printer friendly proposals or history outputs generated from predefined XSL templates
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

URI Endpoint Sample

Request Body Sample

Publish Quote
Description	Use this endpoint to notify the self service channel that the quote is ready for review for customer/buyer. Note: Customer Id, [Contact First Name, Contact Last Name, Contact Email Address] or Contact Party Number should be populated otherwise the integration associated with this action will fail.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_publish_quote
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: cacheInstanceId, criteria, deleteRows, delta, documents, revisionId, selectionMode, selections, skipIntegration, and skipRules. Refer to Request Body Objects for additional information
Response Body Parameters	The JSON data for the approved quote.

URI Endpoint Sample

Request Sample

Response Sample

Reconfigure Transaction
Description	Use this endpoint to edit a configuration after its been added to the transaction. Note: Reconfiguration updates are not automatically applied to Commerce when invoking the Reconfiguration or Save Reconfiguration REST APIs. The Reconfigure Inbound REST API should be invoked to save reconfiguration updates to Commerce.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_reconfigure_action
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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: cacheInstanceId, criteria, delta, documents, revisionId, selectionMode, and skipIntegration. Refer to Request Body Objects for additional information.
Response Body	The response contains the Destination URL, which can be used to launch the product catalog page to select and configure a product.

URI Endpoint Sample

Request Body Sample

Response Body Sample

{ "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" } }

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/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/refresh
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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.

URI Endpoint Sample

Sample Request Body

Request Quote Revision
Description	Use this endpoint to request a quote revision for the specified transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_publish_quote
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: cacheInstanceId, criteria, deleteRows, delta, documents, revisionId, selectionMode, selections, skipIntegration, and skipRules. Refer to Request Body Objects for additional information
Response Body Parameters	The JSON data for the quote to be revised.

URI Endpoint Sample

Request Sample

Response Sample

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/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/cleanSave_t
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: cacheInstanceId, criteria, deleteRows, delta, documents, revisionId, selections, selectionMode, skipIntegration, and skipRules. Refer to Request Body Objects for additional information
Response Body	The JSON data for the saved transaction.

URI Endpoint Sample

Self-Service Checkout
Description	Use this endpoint to update the quote to a closed phase when an order corresponding to this quote is placed using an external system. By default, this action will put the Quote in Canceled step and External Order status.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_selfServiceCheckout
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: cacheInstanceId, criteria, deleteRows, delta, documents, revisionId, selectionMode, selections, skipIntegration, and skipRules. Refer to Request Body Objects for additional information
Response Body Parameters	The JSON data for the quote using self-service checkout.

URI Endpoint Sample

Request Sample

Response Sample

Submit Transaction for Approval
Description	Use this endpoint to submit the specified transaction for approval. If no approvals are needed for this transaction, it is automatically approved.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/submit_t
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	id	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	POST
Request Body Parameters	This endpoint supports the following optional parameters: cacheInstanceId, criteria, deleteRows, delta, documents, revisionId, selections, selectionMode, and skipIntegration. Refer to Request Body Objects for additional information.
Response Body	The pending approval object.

URI Endpoint Sample

Sample Response Body

{ "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 Transaction
Description	Use this endpoint to approve the transaction submitted for approval.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/approve_submit_t
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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: cacheInstanceId, criteria, delta, documents, revisionId, selections, selectionMode, and skipIntegration. Refer to Request Body Objects for additional information.
Response Body	The JSON Transaction data

URI Endpoint Sample

Sample Response Body

{ "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 Transaction
Description	Use this endpoint to reject the transaction submitted for approval.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/reject_submit_t
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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: cacheInstanceId, criteria, delta, documents, revisionId, selections, selectionMode, and skipIntegration. Refer to Request Body Objects for additional information.
Response Body	The JSON Transaction data

URI Endpoint Sample

Sample Response Body

{ "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 Transaction Approval
Description	Use this endpoint to request approval for a transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/request_approval_submit_t
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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: cacheInstanceId, criteria, delta, documents, revisionId, selections, selectionMode, and skipIntegration. Refer to Request Body Objects for additional information.
Response Body	The JSON Transaction data

URI Endpoint Sample

Sample Response Body

{ "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 Transaction
Description	Use this endpoint to revise the transaction submitted for approval.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/revise_submit_t
Endpoint Parameters	Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.
	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: cacheInstanceId, criteria, delta, documents, revisionId, selections, selectionMode, and skipIntegration. Refer to Request Body Objects for additional information.
Response Body	The JSON Transaction data

URI Endpoint Sample

Sample Response Body

{ "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, ... } }