Commerce Transaction Line 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

Add Transaction Lines
Description	Use this endpoint to add line items to the specified transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/addLineItem_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	cacheInstanceId	The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first create Transaction or Open Transaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
	criteria	The query definition for the current resource request.
	delta	The boolean parameter to request a delta response for data as well as state in the context of current criteria.
	documents	The transaction object
	revisionId	The revision Id
	selectionMode	Indicating how selections content should be interpreted, supported values are: Content of the 'selections' parameter, or 'ResultSetExceptSelected' - all entries in result set except those listed in 'selections' parameter
	selections	An array of selected line items
	skipIntegration	If the value for 'skipIntegration' is true, integration tab logic is skipped, otherwise(value is false or absent) it is executed.
Response Body Parameters	cacheInstanceId	The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first create Transaction or Open Transaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
	destinationURL	The destination url as defined in destination tab in action definition.
	documents	The transaction object
	layoutVariableName	The string parameter that contains selected redwood layout's variable name.
	revsionId	The string parameter that contains the revision information.
	warnings	Array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Sample

Response Sample

Back to Transaction
Description	Use this endpoint to return the user to the transaction page from the line items details page.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine/{documentNumber}/actions/_back
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.
	documentNumber	The sub-document number
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 first create Transaction or Open Transaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
	criteria	The query definition for the current resource request.
	errorCriteria	The error query definition for the current resource request.
	revsionId	The string parameter that contains the revision information.
Response Body Parameters	cacheInstanceId	The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first create Transaction or Open Transaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
	destinationURL	The destination url as defined in destination tab in action definition.
	documents	The transaction object
	layoutVariableName	The string parameter that contains selected redwood layout's variable name.
	revsionId	The string parameter that contains the revision information.
	warnings	Array of messages that have been generated for a specific object.

URI Endpoint Sample

Response Sample

{ "revisionId": "25,0", "documents": { "totalOneTimeListAmount_t": { "value": 10.0, "currency": "USD" }, "_s_priceScoreSimpleMarginNetPrice_t": 9, "contactState_t": null, "contactCity_t": null, "_s_soldToPartyName_t": null, "_customer_id": null, "_eSignatureAttributeSet_esig_file_attachment": { "fileName": null, "fileType": null, "fileID": null, "isFileSaved": false, "fileLocation": "https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqoTransaction/documents/3023402512/attachmentAttributes/_eSignatureAttributeSet_esig_file_attachment/transactions/3023442802/documentNumbers/1" }, "_invoiceTo_t_state": null, "orderKey_t": null, "_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": 10.0, "currency": "USD" }, "contractTypeName_t": null, "_s_billTo_t_phone": null, "contractStartDate_t": "2024-08-08", "_s_billTo_t_zip": null, "_s_shipToPartySiteID_t": null, "addressType_t": null, "_date_modified": "2024-08-19T19:13:18.000Z", "_invoiceTo_t_email": null, "_customer_t_address": null, "_soldTo_t_state": null, "hasRecurringPricing_t": false, "contactType_t": null, "_tax_isTaxInclusive_t": false, "contactProvince_t": null, "_s_contactNumber_t": null, "accountAddressElementAttribute5_t": null, "totalAnnualCostAmount_t": { "value": 0.0, "currency": "USD" }, "_shipTo_t_last_name": null, "contractEndDate_t": "2025-08-07", "_s_priceScoreSimpleMarginUnitCost_t": 9, "_invoiceTo_t_company_name_2": null, "contactUniqueName_t": null, "_soldTo_t_zip": null, "contractName_t": "Agreement for 08/08 ", "_soldTo_t_fax": null, "_customer_t_country": null, "totalOneTimeNetAmount_t": { "value": 10.0, "currency": "USD" }, "bs_id": "3023442802", "contactAddressLine4_t": null, "_s_soldToCustomerAccountID_t": null, "contactMiddleName_t": null, "currentStepForTesting_tempDisplay_t": "In Progress", "_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-2v1", "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": null, "accountAddressLine1_t": null, "totalRecurRevenue_t": { "value": 0.0, "currency": "USD" }, "_s_customerVisibilityIdentifier_t": null, "priceType_t": null, "_customer_t_city": null, "totalOneTimeMarginAmount_t": { "value": 10.0, "currency": "USD" }, "_eSignatureAttributeSet_esig_date_modified": null, "proposalExists_t": false, "accountAddressElementAttribute3_t": null, "_tax_isTaxPresent_t": false, "oRCL_SFA_Status_t": "ZCA_WIN", "coverLetter_t": null, "contactAddressElementAttribute4_t": null, "transactionName_t": "08/08 ", "_s_skipSellerReview_t": false, "contactLastName_t": null, "_pp_id": 3023426958, "_document_number": "1", "_shipTo_t_phone": null, "owner_t": "Super User", "_soldTo_t_email": null, "contactFirstName_t": null, "_s_optimalPrimaryDriver_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": 10.0, "currency": "USD" }, "_eSignatureAttributeSet_esig_status": { "displayValue": "Not Sent", "value": "Not Sent" }, "_s_optimalWinProbability_t": null, "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": "_pricebook_custom_field1~Unfiltered~_pricebook_custom_field3~Unfiltered~_pricebook_custom_field5~9.49" }, "contactAddressElementAttribute5_t": null, "_price_book_var_name": "_default_price_book", "_locked_by_user": -1, "_s_billToCustomerAccountID_t": null, "_revenueCategory_t": null, "_currency_pref": { "id": 14619668, "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-08-09T14:02:00Z", "accountProvince_t": null, "_s_billTo_t_state": null, "_price_book_desc": "Default Price Book.", "_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-08-08T20:17:00Z", "lastUpdatedBy_t": "Super User", "_price_book_name": "Base Price", "_s_contractTypeID_t": null, "accountAddressElementAttribute1_t": null, "partialShipAllowedFlag_t": false, "_s_optimalTargetValue_t": null, "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-08-08", "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-08-08T20:17:45.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, "_s_discountGuidanceMax_t": null, "_shipTo_t_state": null, "_s_discountGuidanceFloor_t": 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/3023402512/attachmentAttributes/fileAttachment_t/transactions/3023442802/documentNumbers/1" }, "_soldTo_t_address_2": null, "invoiceToPartyID_t": null, "_s_winProbability_t": null, "_process_var_name": "standardProcess", "_locked_by_user_first_name": null, "_invoiceTo_t_zip": null, "_s_billTo_t_country": null, "createdBy_t": "Super User", "contractedPeriods_t": 1, "_soldTo_t_last_name": null, "contactNameSuffix_t": null, "_s_assignedTo_t": { "displayValue": "Seller", "value": "SELLER" }, "_stage": { "displayValue": "Quote", "value": "QUOTE" }, "_s_isLatestProposal_t": false, "_s_shipToPartyID_t": null, "_s_accountPartyNumber_t": null, "accountCity_t": null, "_locked_by_user_last_name": null, "_s_html_main_price_optimization_t": null, "accountAddressLine4_t": null, "_s_billTo_t_last_name": null, "renewalProcessUsed_t": null, "_s_priceScoreSimpleMarginListPrice_t": 9, "_s_quoteForAgreement_t": false, "_eSignatureAttributeSet_esig_envelope_id": null, "transactionID_t": "CPQ-2", "accountAddressElementAttribute2_t": null, "_buyer_company_name": "cpq-techwriter1", "opportunityName_t": null, "renewDraftSubscriptionNumber_t": null, "_s_priceScoreListBased_t": 9, "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-08-19T19:13:18.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, "_s_winProbRevPrediction_t": null, "defaultRequestDate_t": "2024-08-08", "priceScore_t": 9, "transactionMarginPercent_t": 100.0, "purchaseOrderNumber_t": null, "_last_document_number": 2, "_approve_link": "", "_price_book_custom_field_text": { "value": "String (Custom Field 1)~Unfiltered~SSM (Custom Field 3)~Unfiltered~Float (Custom Field 5)~9.49" }, "_s_useTransactionForAnalytics_t": false, "_customer_t_address_2": null, "_s_priceScoreMarginBased_t": 9, "requireApprovalIfChecked_temporary_t": false, "_id": 3023442802, "_invoiceTo_t_address_2": null, "subscriptionProfileId_t": null, "_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": "pending_process", "_s_discountGuidanceCeiling_t": null, "_soldTo_t_company_name_2": null, "oRCL_SFA_OwnerResourcePartyID_t": null, "_s_winProbNoOptimization_t": null, "accountCountry_t": null, "businessUnitName_t": null, "_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": 10.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": 0.0, "currency": "USD" }, "_tax_taxAmount_t": null, "_pp_name": "Admin", "status_t": { "displayValue": "Ordered", "value": "ORDERED" }, "transactionLine": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023442802/transactionLine" } ], "items": [{ "_line_bom_attributes": null, "_availableRatePlans": null, "_s_lineDiscountGuidanceFloor_l": null, "listAmount_l": { "value": 10.0, "currency": "USD" }, "discountAmount_l": { "value": 0.0, "currency": "USD" }, "rollupFlag_l": false, "contractStartDate_l": "2024-08-08", "_model_partner_entity_id": null, "listPriceRollup_l": { "value": 10.0, "currency": "USD" }, "_config_attributes": { "value": null }, "_part_sale_enabled": null, "recurringRevSummable_l": { "value": 0.0, "currency": "USD" }, "fulfillmentLineId_l": null, "_part_display_number": "Part Display 10", "_model_attributes": { "value": null }, "_price_list_price_each": { "value": 10.0, "currency": "USD" }, "_s_priceScoreSimpleMarginNetPrice_l": 9, "_s_lastPricePaid_l": null, "_line_bom_effective_date": null, "includedInBasePrice": null, "_parent_line_item": null, "_date_modified": "2024-08-09T14:02:23.000Z", "rootAssetKey_l": null, "annualMargin_l": { "value": 0.0, "currency": "USD" }, "_model_product_line_attributes": { "value": null }, "_price_configurable_price": { "value": 10.0, "currency": "USD" }, "costAmount_l": { "value": 0.0, "currency": "USD" }, "_is_part_pricing_rule_price": false, "_part_default_uom": null, "discountPercent_l": 0.0, "_part_sales_product_type": null, "contractEndDate_l": "2025-08-07", "_last_modified_date": "2024-08-09 07:02:23", "_s_freezeNegotiationFlag_l": false, "subscriptionId_l": null, "_config_extra_info": null, "suspendDate_l": null, "_s_priceScoreSimpleMarginUnitCost_l": 9, "unitMargin_l": { "value": 10.0, "currency": "USD" }, "resumeDate_l": null, "_part_number": "part10", "_sequence_number": 1, "_line_bom_display_name": null, "unitCost_l": null, "_price_applied_agreement_integrationId": null, "_price_unit_price_each": { "value": 10.0, "currency": "USD" }, "_model_base_price": null, "customDiscountValue_l": 0.0, "_model_product_line_name": null, "_price_item_price_each": { "value": 10.0, "currency": "USD" }, "recurRevRollup_l": { "value": 0.0, "currency": "USD" }, "monthlyUsageRevRollup_l": { "value": 0.0, "currency": "USD" }, "_transaction_currency_pref": { "id": 14619668, "currencyCode": "USD" }, "oRCL_ABO_ComponentAttributes_l": null, "_price_applied_ratePlan_integrationId": null, "priceWithinPolicy_l": true, "_part_serv_req_enabled": null, "_model_supplier_company_id": null, "_model_segment_id": null, "_partner_entity_id": null, "requestDate_l": null, "_part_base_price": { "value": 10.0, "currency": "USD" }, "_favorite_id": null, "contractMargin_l": { "value": 10.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" }, "_part_custom_field5": 0.0, "nonRecurRevRollup_l": { "value": 10.0, "currency": "USD" }, "oRCL_SFA_Status_l": "ZCA_WIN", "_config_attr_info": { "value": null }, "_s_partID_l": null, "contractListValueRollup_l": { "value": 10.0, "currency": "USD" }, "contractValue_l": { "value": 10.0, "currency": "USD" }, "netAmountRollup_l": { "value": 10.0, "currency": "USD" }, "_prior_price": null, "_s_lineDiscountGuidanceMax_l": null, "customDiscountAmount_l": { "value": 0.0, "currency": "USD" }, "_parent_doc_number": null, "requestShipDate_l": "2024-08-08", "_reconfiguration_date": "1970-01-01 00:00:00", "annualCost_l": { "value": 0.0, "currency": "USD" }, "_part_desc": null, "_chargeSetControl": null, "_pp_id": 3023426958, "_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": "[]", "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": 10.0, "currency": "USD" }, "_line_item_spare_rule_var_name": null, "_price_applied_agreement_name": null, "_revenueCategory_l": null, "_s_lastPricePaidCustomerId_l": null, "_part_id": "8523091", "_part_company_associations": null, "_part_default_periods": "N/A", "_s_lineDiscountGuidanceCeiling_l": null, "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": "2024-08-08T20:17:00Z", "_price_quantity": 1, "paymentTerms_l": null, "lastUpdatedBy_l": "Super User", "_part_supplier_company_name": "cpq-techwriter1", "_document_var_name": "transactionLine", "_part_default_price_type": null, "createdDate_l": "2024-08-08T20:17:00Z", "contractCost_l": { "value": 0.0, "currency": "USD" }, "_s_priceScoreWeighting_l": 1.0, "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": null, "_price_applied_agreement_number": null, "_line_bom_model_path": null, "_model_id": null, "_availableRatePlanSetControl": 0, "_date_added": "2024-08-08T20:17:58.000Z", "_model_product_line_id": null, "requestedUnitOfMeasure_l": null, "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": "Super User", "parentdocumentNumber_l": null, "fulfillmentStatus_l": null, "_model_path": null, "_model_variable_name": null, "monthlyRecurRevSummable_l": { "value": 0.0, "currency": "USD" }, "_model_product_line_var_name": null, "_is_recommended_price": false, "_transactionLine_id": "3023442802_2", "annualListValue_l": { "value": 0.0, "currency": "USD" }, "_line_bom_id": null, "_model_supplier_company_name": null, "_s_priceScoreSimpleMarginListPrice_l": 9, "rootLine_l": { "displayValue": "Y", "value": "Y" }, "lineType_l": { "displayValue": "Part", "value": "PART" }, "transactionID_l": "3023442802", "_line_bom_part_number": null, "usageRevRollup_l": { "value": 0.0, "currency": "USD" }, "itemInstanceId_l": null, "_s_coverageOrderNumber": null, "_s_coverageLineNumber": null, "_line_bom_item_quantity": 0, "annualDiscount_l": { "value": 0.0, "currency": "USD" }, "_part_service_duration_type_code": null, "_model_segment_var_name": null, "_s_priceScoreListBased_l": 9, "_line_bom_level": null, "_bs_id": 3023442802, "netAmount_l": { "value": 10.0, "currency": "USD" }, "orderDate_l": null, "_part_units": null, "_part_direct_buy": "1", "salesChannel_l": null, "oRCL_SFA_InventoryItemID_l": null, "oRCL_ABO_ActionCode_l": null, "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": "Part Display 10", "netPrice_l": { "value": 10.0, "currency": "USD" }, "_revenueId_l": null, "renewDate_l": null, "_price_type": null, "listPrice_l": { "value": 10.0, "currency": "USD" }, "_part_extended_desc_2": "Extended description 2 for part10", "documentNumber_l": "2", "_part_extended_desc_1": "Extended description 1 for part10", "nonRecurRevSummable_l": { "value": 10.0, "currency": "USD" }, "priceTypeRollup_l": { "displayValue": "One Time", "value": "One Time" }, "contractedPeriodsRollup_l": null, "_is_line_item_mandatory": false, "_price_period": null, "ownerResourceId_l": null, "_id": 3023442805, "_is_coverage": false, "_part_lead_time": "N/A", "lineNumber_l": null, "_part_css_enabled": null, "_s_priceScoreMarginBased_l": 9, "subscriptionLineId_l": null, "status_l": { "displayValue": "Created", "value": "CREATED" }, "_line_item_comment": null, "contractValueRollup_l": { "value": 10.0, "currency": "USD" }, "_line_bom_sequence_index": null, "aBO_Delta_Action_Code_l": 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": 0.0, "currency": "USD" }, "monthlyUsageRevSummable_l": { "value": 0.0, "currency": "USD" }, "_line_bom_variable_name": null, "marginAmount_l": { "value": 10.0, "currency": "USD" }, "_partner_organization_id": null, "netPriceRollup_l": { "value": 10.0, "currency": "USD" }, "annualValue_l": { "value": 0.0, "currency": "USD" }, "_pp_name": "Admin", "oRCL_SFA_InventoryOrgID_l": null, "_line_bom_condition_index": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023442802/transactionLine/2" }, { "kind": "", "rel": "child", "name": "oRCL_charges", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023442802/transactionLine/2/oRCL_charges" }, { "kind": "", "rel": "child", "name": "_availableRatePlanSet", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023442802/transactionLine/2/_availableRatePlanSet" }, { "kind": "", "rel": "child", "name": "_chargeSet", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023442802/transactionLine/2/_chargeSet" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/3023442802" } ] } ] } }, "warnings": {}, "destinationURL": "" }

URI Endpoint Sample

Request Body Sample

{ "documents": { "_price_quantity": 10, "_price_override_quantity": true, "_price_item_price_each": { "value": 11, "currency": "USD" }, "_pricing_rule_price_each": { "value": 14, "currency": "USD" }, "_price_unit_price_each": { "value": 15, "currency": "USD" }, "_price_override_price": { "value": "Yes", "displayValue": "Yes" }, "_price_discount_percent": 18, "_price_override_discount": { "value": "Percent", "displayValue": "Percent" } } }

Copy Transaction Lines
Description	Use this endpoint to copy specified transaction lines within the current transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/copyLineItems_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	cacheInstanceId	The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first create Transaction or Open Transaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
	criteria	The query definition for the current resource request.
	delta	The boolean parameter to request a delta response for data as well as state in the context of current criteria.
	documents	The transaction object
	numberOfCopies	An array to specify the number of copies for each line listed in selections.
	revisionId	The revision Id
	selectionMode	Indicating how selections content should be interpreted, supported values are: Content of the 'selections' parameter, or 'ResultSetExceptSelected' - all entries in result set except those listed in 'selections' parameter
	selections	An array of selected line items
Response Body Parameters	cacheInstanceId	The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first create Transaction or Open Transaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
	documents	The transaction object
	layoutVariableName	The string parameter that contains selected redwood layout's variable name.
	revsionId	The string parameter that contains the revision information.
	warnings	Array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Body Samples

Create Transaction Line
Description	Use this endpoint to create a transaction line item for the part item, model, or favorite item listed in the request body.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine
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	_favorite_Id	The favorite Id
	_model_path	The model path
	_part_number	The Part Number to be added to this transaction.
	_price_book_var_name	Variable Name of the Price Book used to get the price for this line item.
	_price_quantity	The quantity of parts to be added to this transaction.
Response Body	The transaction line data

URI Endpoint Sample

Request Body Samples

Delete Transaction Lines
Description	Use this endpoint to delete the specified transaction line(s) from a transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_remove_transactionLine
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.
Request Body Parameters	selections	Required, this parameter is used for transaction level actions that support line selection. Selection items are an array of transactionLine/{documentNumber} combinations.
	This operation supports the following optional parameters: cacheInstanceId, criteria, delta, documents, revisionId, selectionMode, skipIntegration, and skipRules. Refer to Request Body Objects for additional information
HTTP Method	POST
Response Body Parameters	cacheInstanceId	The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first create Transaction or Open Transaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
	documents	The transaction object
	layoutVariableName	The string parameter that contains selected redwood layout's variable name.
	revsionId	The string parameter that contains the revision information.
	warnings	Array of messages that have been generated for a specific object.

URI Endpoint Sample

Request Sample

{"selections": ["transactionLine/2", "transactionLine/3"]}

Get Charge
Description	Use this endpoint to retrieve the specified transaction line charge .
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine/{documentNumber}/_chargeSet/{_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.
	documentNumber	The sub-document number
	_row_number	Unique row number to be used as a charge identifier in an charge set.
Query Parameters	This endpoint supports the optional excludeFieldTypes parameter, refer to Manage Collections for additional information.
HTTP Method	GET
Request Body Parameters	None
Success Response	The JSON data for the requested transaction line charge set.

URI Endpoint Sample

Sample Response Body

{ "_chargeSet_chargeType": { "displayValue": "Data Charge", "value": "dataCharge_c" }, "_sequence_number": 2, "_chargeSet_calculationInfo": "[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price Model\",\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"Base Pricing Rule\"}]", "_chargeSet_netAmount": { "value": 0.0, "currency": "USD" }, "_chargeSet_rateCardInHTML": "<figure class=\"table\"><table style=\"border-collapse: collapse;\"><tbody><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\"><b>Usage From</b></td><td style=\"border:solid 1px;\"><b>Usage To</b></td><td style=\"border:solid 1px;\"><b>Rate</b></td></tr><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\">0</td><td style=\"border:solid 1px;\">100</td><td style=\"border:solid 1px;\">USD 0.9</td></tr><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\">100</td><td style=\"border:solid 1px;\">1000</td><td style=\"border:solid 1px;\">USD 0.8</td></tr><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\">1000</td><td style=\"border:solid 1px;\">null</td><td style=\"border:solid 1px;\">USD 0.5</td></tr></tbody></table></figure>", "_chargeSet_chargeDefinitionCode": "dataUsage_c", "_chargeSet_pricePeriod": { "displayValue": "Per Month", "value": "Per Month" }, "_row_number": 2, "_chargeSet_discountValue": null, "_chargeSet_rateCardName": "Supremo Remote Access Volume Rates", "_chargeSet_usageUOM": { "displayValue": "Gb", "value": "gb_c" }, "_chargeSet_rateCardStructure": "{\"type\":\"rateCard\",\"name\":\"Supremo Remote Access Volume Rates\",\"variableName\":\"supremoRemoteAccessVolumeRates\",\"schema\":{\"columns\":[{\"name\":\"Usage From\",\"variableName\":\"from\",\"dataType\":\"Integer\",\"translations\":[]},{\"name\":\"Usage To\",\"variableName\":\"to\",\"dataType\":\"Integer\",\"translations\":[]},{\"name\":\"Rate\",\"variableName\":\"rate\",\"dataType\":\"Currency\",\"translations\":[]}],\"lookupData\":[]},\"data\":[{\"rate\":{\"currency\":\"USD\",\"value\":0.9},\"from\":0,\"to\":100},{\"rate\":{\"currency\":\"USD\",\"value\":0.8},\"from\":100,\"to\":1000},{\"rate\":{\"currency\":\"USD\",\"value\":0.5},\"from\":1000}]}", "_chargeSet_netPrice": { "value": 0.0, "currency": "USD" }, "_chargeSet_dynamicPricingType": "rateCard", "_chargeSet_discountType": null, "_chargeSet_rateCardVariableName": "supremoRemoteAccessVolumeRates", "_transaction_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/currencies/USD" } ] }, "_chargeSet_chargeDefinition": "Data Usage", "_chargeSet_chargeDefIntegrationId": "KI_DATA_CHARGE", "_chargeSet_discountAmount": { "value": 0.0, "currency": "USD" }, "_chargeSet_priceType": { "displayValue": "Usage", "value": "Usage" }, "_chargeSet_unitPrice": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2/_chargeSet/2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2" } ] }

Get Charges
Description	Use this endpoint to retrieve all charges for the specified transaction line.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine/{documentNumber}/_chargeSet
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.
	documentNumber	The sub-document number
Query Parameters	This endpoint supports the following optional parameters: excludeFieldTypes, expand, fields, limit, offset, orderby, q, and totalResults. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Success Response	The response contains a collection of charge sets for the specified transaction line.

URI Endpoint Sample

Sample Response Body

{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2/_chargeSet" } ], "items": [{ "_chargeSet_chargeType": { "displayValue": "Activation Fee", "value": "activationFee_c" }, "_sequence_number": 1, "_chargeSet_calculationInfo": "[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price Model\",\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"Base Pricing Rule\",\"_runningUnitPrice\":250.0}]", "_chargeSet_netAmount": { "value": 250.0, "currency": "USD" }, "_chargeSet_rateCardInHTML": null, "_chargeSet_chargeDefinitionCode": "activationFee_c", "_chargeSet_pricePeriod": { "displayValue": "Per Month", "value": "Per Month" }, "_row_number": 1, "_chargeSet_discountValue": null, "_chargeSet_rateCardName": null, "_chargeSet_usageUOM": null, "_chargeSet_rateCardStructure": null, "_chargeSet_netPrice": { "value": 250.0, "currency": "USD" }, "_chargeSet_dynamicPricingType": "static", "_chargeSet_discountType": null, "_chargeSet_rateCardVariableName": null, "_transaction_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_chargeSet_chargeDefinition": "Activation Fee", "_chargeSet_chargeDefIntegrationId": "KI_ACTIVATION_CHARGE", "_chargeSet_discountAmount": { "value": 0.0, "currency": "USD" }, "_chargeSet_priceType": { "displayValue": "One Time", "value": "One Time" }, "_chargeSet_unitPrice": { "value": 250.0, "currency": "USD" }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2/_chargeSet/1" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2" } ] }, { "_chargeSet_chargeType": { "displayValue": "Data Charge", "value": "dataCharge_c" }, "_sequence_number": 2, "_chargeSet_calculationInfo": "[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price Model\",\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"Base Pricing Rule\"}]", "_chargeSet_netAmount": { "value": 0.0, "currency": "USD" }, "_chargeSet_rateCardInHTML": "<figure class=\"table\"><table style=\"border-collapse: collapse;\"><tbody><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\"><b>Usage From</b></td><td style=\"border:solid 1px;\"><b>Usage To</b></td><td style=\"border:solid 1px;\"><b>Rate</b></td></tr><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\">0</td><td style=\"border:solid 1px;\">100</td><td style=\"border:solid 1px;\">USD 0.9</td></tr><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\">100</td><td style=\"border:solid 1px;\">1000</td><td style=\"border:solid 1px;\">USD 0.8</td></tr><tr style=\"border:solid 1px;\"><td style=\"border:solid 1px;\">1000</td><td style=\"border:solid 1px;\">null</td><td style=\"border:solid 1px;\">USD 0.5</td></tr></tbody></table></figure>", "_chargeSet_chargeDefinitionCode": "dataUsage_c", "_chargeSet_pricePeriod": { "displayValue": "Per Month", "value": "Per Month" }, "_row_number": 2, "_chargeSet_discountValue": null, "_chargeSet_rateCardName": "Supremo Remote Access Volume Rates", "_chargeSet_usageUOM": { "displayValue": "Gb", "value": "gb_c" }, "_chargeSet_rateCardStructure": "{\"type\":\"rateCard\",\"name\":\"Supremo Remote Access Volume Rates\",\"variableName\":\"supremoRemoteAccessVolumeRates\",\"schema\":{\"columns\":[{\"name\":\"Usage From\",\"variableName\":\"from\",\"dataType\":\"Integer\",\"translations\":[]},{\"name\":\"Usage To\",\"variableName\":\"to\",\"dataType\":\"Integer\",\"translations\":[]},{\"name\":\"Rate\",\"variableName\":\"rate\",\"dataType\":\"Currency\",\"translations\":[]}],\"lookupData\":[]},\"data\":[{\"rate\":{\"currency\":\"USD\",\"value\":0.9},\"from\":0,\"to\":100},{\"rate\":{\"currency\":\"USD\",\"value\":0.8},\"from\":100,\"to\":1000},{\"rate\":{\"currency\":\"USD\",\"value\":0.5},\"from\":1000}]}", "_chargeSet_netPrice": { "value": 0.0, "currency": "USD" }, "_chargeSet_dynamicPricingType": "rateCard", "_chargeSet_discountType": null, "_chargeSet_rateCardVariableName": "supremoRemoteAccessVolumeRates", "_transaction_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_chargeSet_chargeDefinition": "Data Usage", "_chargeSet_chargeDefIntegrationId": "KI_DATA_CHARGE", "_chargeSet_discountAmount": { "value": 0.0, "currency": "USD" }, "_chargeSet_priceType": { "displayValue": "Usage", "value": "Usage" }, "_chargeSet_unitPrice": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2/_chargeSet/2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38926297/transactionLine/2" } ] } ] }

Get Transaction Line
Description	Use this endpoint to retrieve the specified transaction line.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine/{documentNumber}
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.
	documentNumber	The sub-document number
Query Parameters	This endpoint supports optional excludeFieldTypes and expand parameters.
HTTP Method	GET
Request Body Parameters	None
Success Response	The JSON data for the requested transaction line.

URI Endpoint Sample

Sample Response Body

{ "_part_custom_field29": "", "_price_book_var_name": "_default_price_book", "_model_attributes": "", "_model_bom": "", "_part_supplier_company_id": "4118171", "_price_item_price_each": "199.99", "annualValue_l": "0", "_price_total_discount": "0", "_config_attributes": "", "_price_list_price_each": "199.99", "statusQuantity_l": null, "_part_custom_field30": "", "requestedUnitOfMeasure_l": "", "_original_document_number": "-1", "status_l": null, "requestedQuantity_l": "1", "costAmount_l": "100", "createdDate_l": "2016-02-25 12:19:00", "pricePeriod_l": "", "_part_id": "36285771", "customDiscountAmount_l": "0", "priceType_l": "One Time", "_price_component_prices": "", "_part_supplier_company_name": "pm", "_document_number": "2", "_is_line_item_mandatory": "false", "_reconfiguration_date": "1970-01-01 00:00:00", "_price_unit_price_each": "199.99", "_config_attr_info": "", "_price_configurable_price": "199.99", "taxExempt_l": "false", "_date_added": "2016-02-25 12:19:07.0", "displayedItemName_l": "Alliance Business Software", "_document_number9": "", "_date_modified": "2016-02-25 13:00:22.0", "_parent_line_item": "", "_model_segment_name": "", "canChangeQuantity_l": "false", "_price_subtotal": "199.99", "_part_desc": "Alliance Business Software", "_is_part_pricing_rule_price": "false", "_model_id": "", "_partner_entity_id": "", "_config_attr_text": "", "_id": "36365446", "_part_units": "", "_model_product_line_id": "", "statusDate_l": null, "statusPartial_l": "false", "createdBy_l": "Super User", "customDiscountValue_l": null, "_last_modified_date": "2016-02-25 13:00:22", "_price_discount_comment": "", "_model_product_line_name": "", "_price_override_discount": "None", "_part_drawing_position": "", "itemInstanceId_l": "", "netPrice_l": "199.99", "_model_segment_id": "", "_model_product_line_var_name": "", "firstRecurringInvoiceDate_l": "", "_model_supplier_company_id": "", "_price_discount_percent": "0.00", "_model_segment_var_name": "", "contractStartDate_l": "2016-02-25 00:00:00", "unitCost_l": "100", "_part_direct_buy": "1", "_pricing_rule_price_each": "0", "_model_variable_name": "", "_part_number": "AS00100", "_document_var_name": "transactionLine", "_model_supplier_company_name": "", "_bs_id": "36365444", "_price_override_quantity": "false", "_price_net_price": "199.99", "netAmount_l": "199.99", "_line_item_spare_rule_var_name": "", "listPrice_l": "199.99", "customDiscountType_l": "%", "_part_custom_field12": "", "_part_custom_field13": "No", "taxExemptReason_l": "", "_part_custom_field10": "", "lastUpdatedBy_l": "Super User", "lineNumber_l": "", "_part_custom_field11": "", "_part_custom_field16": "", "_part_custom_field17": "", "_part_custom_field14": "LAP", "_part_custom_field15": "", "_model_base_price": "", "_line_item_comment": "", "_parent_doc_number": "", "parentLineNumber_l": "", "_part_custom_field2": "", "listAmount_l": "199.99", "_model_product_line_attributes": "", "canChangeConfiguration_l": "false", "_part_custom_field1": "Software", "_part_custom_field4": "", "_part_custom_field3": "19", "priceWithinPolicy_l": "true", "customerItemName_l": "", "_part_custom_field6": "253209", "_model_name": "", "_part_custom_field5": "100.0", "_part_custom_field8": "One Time", "_part_custom_field7": "", "_price_quantity": "1", "contractedPeriods_l": "1", "_part_custom_field21": "", "_part_custom_field22": "", "transactionID_l": "CPQ-63", "_part_custom_field23": "", "_part_custom_field24": "", "_part_custom_field25": "", "_part_custom_field26": "", "_part_custom_field27": "", "_part_custom_field28": "", "_part_custom_field9": "38", "lastUpdatedDate_l": "", "contractValue_l": "199.99", "_part_custom_field20": "", "_part_base_price": "199.99", "_is_recommended_price": "false", "_part_custom_field19": "", "_part_custom_field18": "", "_part_extended_desc_1": "", "_part_lead_time": "N/A", "_price_override_price": "No", "_part_extended_desc_2": "", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/36365444/transactionLine/2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/36365444" } ] }

Get Transaction Lines
Description	Use this endpoint to retrieve all transaction lines for the specified transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine
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 parameters:excludeFieldTypes, expand, fields, limit, offset, orderby, q, and totalResults. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Success Response	The JSON data for the requested transaction lines.

URI Endpoint Sample

Open Transaction Line
Description	Use this endpoint to display the Line Items Details for a specified transaction line.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_open_transactionLine
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, use to specify the transaction line to open. This action only accepts a single line selection.
	selectionNavigation	Use this parameter to navigate between line item detail pages. Supported values are: first, prev, next, and last. When query parameters are provided, the navigation flow is within the filtered and/or sorted line items.
	This operation supports the following optional parameters: cacheInstanceId, criteria, documents, errorCriteria, revisionId, selectionMode, and skipIntegration. Refer to Request Body Objects for additional information.
Response Body Parameters	The JSON data for the parent transaction, or a subset of transaction items, depending on the input request

URI Endpoint Sample

Request Body Sample

Request Body Sample with Selection Navigation

{ "cacheInstanceId": "bDYxrCAnUwiVpYXUGDoT1GilCF0CFMPEGTcuKCPER3QFuxHJf33AYtAU1atZItpt", "selections": ["transactionLine/12"], "selectionNavigation": "next" } }

URI Endpoint Sample

Request Body Sample

Response Body Sample

Reconfigure Transaction Line
Description	Use this endpoint to edit a configuration after its been added to the transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine/{documentNumber}/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.
	documentNumber	The sub-document number
HTTP Method	POST
Request Body Parameters	This operation supports the following optional parameters: cacheInstanceId, criteria, delta, documents, revisionId, selections, selectionMode, and skipIntegration. Refer to Request Body Objects for additional information.
Response Body	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": { "orderOfOpsInputSubDoc": null, "_line_bom_item_quantity": null, "copyLineProductsInitializationMSM": "Value 3~Value 4" } }

Update Transaction Line
Description	This operation modifies transaction line details and updates the existing transaction.
URI Endpoint	/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_update_line_items
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, delta, documents, revisionId, selections, selectionMode, and skipIntegration. Refer to Request Body Objects for additional information.
Response Body	JSON data for the transaction, including the updated transaction line

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/17994570/actions/_update_line_items