9/15/25, 2:27 PM Commerce REST APIs

Web Services > REST APIs > CPQ APIs > Commerce

Commerce REST APIs

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

Notes:

If you are using a custom Commerce Process, your endpoints and action names may vary. Additionally,
you may not see all of the action endpoints listed below.

Refer to Interface Catalog for information about accessing your site-specific REST APIs.

Support to Add Unconfigured Models and Favorites to a Transaction

Endpoints for modify-type actions now support adding unconfigured models and favorites to a transaction.

Add Unconfigured Model Example (24C)

{
"documents": {
"transactionLine": {
"items": [{
"_part_number": "part1",
"_price_quantity": "1",
"_price_book_var_name": "_default_price_book",
"_sequence_number": 1,
}, {
"_model_path": "configvisionVehicles:consumerVehicles:sUV",
"_price_quantity": "1",
"_sequence_number": 2,
}
]
}
}
}

Add Favorite Items Example (24D)

{
"documents": {
"transactionLine": {
"items": [{
"_favorite_id": 3023140143,
"_sequence_number": 3
}
]
}
}
}

[Link] 1/222
9/15/25, 2:27 PM Commerce REST APIs

ADMINISTRATION
Accept Quote

Accept Quote

Use this endpoint to accept the specified transaction.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_s_accept_quote

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters deleteRows, delta, documents, revisionId, selectionMode, selections,
skipIntegration, and skipRules.
Refer to Request Body Objects for additional information

Response Body The JSON data for the approved quote.

Parameters

URI Endpoint Sample

[Link]
ions/_s_accept_quote

Request Sample

[Link] 2/222
9/15/25, 2:27 PM Commerce REST APIs
{
"cacheInstanceId": "UNnWLpELVUzsZUBCqVXkbae4qBV2NRUYyausULaJ739PvjIuUwuWd2G06eb9YHdC",
"documents": {
"_s_transactionComments_t": {
"items": [{
"_row_number": -1,
"_s_commentor": "Adam Jones",
"_s_customerComment": "Accepting the quote.",
"_s_commentDate": "2024-02-29T21:15:00-08:00",
"_s_isInternalComment": false
}
]
}
}
}

Response Sample

This response is truncated to highlight relevant attributes.

[Link] 3/222
9/15/25, 2:27 PM Commerce REST APIs
{
"revisionId": "18,0",
"documents": {
...
"_s_isPublished_t": true,
"priceExpirationDate_t": "2024-11-27T13:44:00Z",
"_s_customerStatus_t": {
"displayValue": "Acceptance",
"value": "acceptance"
},
"_s_customerVisibilityIdentifier_t": {
"displayValue": "HEADER_PRODUCTS_PRICES",
"value": "3"
},
"_s_assignedTo_t": {
"displayValue": "Seller",
"value": "SELLER"
},
"_stage": {
"displayValue": "Quote",
"value": "QUOTE"
},
"status_t": {
"displayValue": "Created",
"value": "CREATED"
},
"transactionLine": {
...
],
"items": [{
...
}
]
}
},
"warnings": {},
"destinationURL": ""
}

Add from Favorites

Add from Favorites

This 'Add From Catalog' type action returns a destination URL to launch the Favorites List in Oracle CPQ
Description
where users can select items to add to the transaction.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/addFromFavorites_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 4/222
9/15/25, 2:27 PM Commerce REST APIs

Add from Favorites

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
Request Body
Parameters documents, revisionId, selectionMode, selections, and skipIntegration.
Refer to Request Body Objects for additional information

Response Body The response contains "destinationURL" to launch the Favorites List.
Parameters

URI Endpoint Sample

[Link]
ions/addFromFavorites_t

Response Sample

{
"destinationURL": "[Link]
action_id=17905905&document_id=4356178&bsId=18016533&versionId=15514396&destination_url=
",
"documents": {
"items": [
{...
}

Add Transaction Lines

Add Transaction Lines

Use this endpoint to add line items to the specified transaction.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/addLineItem_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 5/222
9/15/25, 2:27 PM Commerce REST APIs

Add Transaction Lines

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
Request Body
Parameters documents, revisionId, selectionMode, selections, and skipIntegration.
Refer to Request Body Objects for additional information

Response Body documents The JSON Transaction Line data

Parameters

URI Endpoint Sample

[Link]
ctions/addLineItems_t

Request Sample

{
"cacheInstanceId": "c9eG836AOqcI35aHa0p3yqcE3se8HQu50W0FJWk57SZt8IzWMZzXUpOkSQa8iECV",
"documents": {
"_price_book_var_name": "_default_price_book",
"transactionLine": {
"items": [{
"_part_number": "part1",
"_price_book_var_name": "_default_price_book"
}
]
}
},
"revisionId": "2,0"
}

Response Sample

[Link] 6/222
9/15/25, 2:27 PM Commerce REST APIs

{
"revisionId": "3,0",
"documents": {
"totalOneTimeListAmount_t": {
"value": 0.0,
"currency": "USD"
},
"oRCL_ERP_CPQSourceSystemCode_t": "ORA_BM_CPQ",
"_customer_id": "account112",
"_eSignatureAttributeSet_esig_file_attachment": {
"fileName": null,
"fileType": null,
"fileID": null,
"isFileSaved": false,
"fileLocation":
"[Link]
achmentAttributes/_eSignatureAttributeSet_esig_file_attachment/transactions/3022920645/d
ocumentNumbers/1"
},
"_invoiceTo_t_state": {
"displayValue": "Arkansas",
"value": "Arkansas"
},
"_invoiceTo_t_city": "Little Rock",
"transactionTotalDiscountPercent_t": 0.0,
"_customer_t_state": {
"displayValue": "Arkansas",
"value": "Arkansas"
},
"totalContractValue_t": {
"value": 0.0,
"currency": "USD"
},
"oRCL_SFDC_Probability_t": null,
"_date_modified": "2023-03-02T08:09:58.000Z",
"_invoiceTo_t_email": "[Link]@[Link]",
"_customer_t_address": "401 Main Street",
"oRCL_ERP_OrgID_t": "999",
"_soldTo_t_state": null,
"hasRecurringPricing_t": false,
"oRCL_ERP_IntegrationStatusText_t": null,
"taxExemptReason_t": null,
"totalAnnualCostAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_shipTo_t_last_name": null,
"oRCL_ERP_ERPSystem_t": null,
"_invoiceTo_t_company_name_2": "Co.",
"proposalPreparedByEmail_t": null,
"_soldTo_t_zip": null,
"_soldTo_t_fax": null,
"_customer_t_country": {
"displayValue": "United States",
"value": "United States"

[Link] 7/222
9/15/25, 2:27 PM Commerce REST APIs
},
"totalOneTimeNetAmount_t": {
"value": 0.0,
"currency": "USD"
},
"bs_id": "3022920645",
"currentStepForTesting_tempDisplay_t": "start_step",
"_submitted_by_submit_t": "",
"_customer_t_email": "[Link]@[Link]",
"oRCL_SFDC_Stage_t": null,
"oRCL_SFDC_Product1000IDs_t": null,
"opportunityNumber_t": null,
"oRCL_SFDC_CloseDate_t": null,
"customerPartySiteID_t": null,
"totalContractDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"priceWithinPolicy_t": true,
"_soldTo_t_first_name": null,
"totalOneTimeCostAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_invoiceTo_t_company_name": "Apple",
"statusDate_t": null,
"_reject_link": "",
"customerID_t": "account112",
"_soldTo_t_country": null,
"_shipTo_t_zip": null,
"_shipTo_t_fax": null,
"_customer_t_company_name": "Apple",
"userKey_t": "CPQ-16v1",
"totalContractCostAmount_t": {
"value": 0.0,
"currency": "USD"
},
"priceExpirationDate_t": null,
"_transaction_total": {
"value": 0.0,
"currency": "USD"
},
"annualContractListValue_t": {
"value": 0.0,
"currency": "USD"
},
"approve_reject_icon_submit_t": null,
"oRCL_ERP_OrderID_t": null,
"soldToCustomerAccountID_t": null,
"_customer_t_city": "Little Rock",
"totalOneTimeMarginAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_eSignatureAttributeSet_esig_date_modified": null,
"coverLetter_t": null,

[Link] 8/222
9/15/25, 2:27 PM Commerce REST APIs
"proposalPreparedByName_t": null,
"transactionName_t": null,
"statusPartial_t": false,
"_pp_id": 18355578,
"_document_number": "1",
"proposalPreparedByTitle_t": null,
"oRCL_ERP_SoapRequest_t": null,
"shipToPartySiteID_t": null,
"_shipTo_t_phone": null,
"owner_t": "Super User",
"_soldTo_t_email": null,
"_invoiceTo_t_first_name": "Bill",
"_customer_t_zip": "60081",
"_customer_t_fax": "555-555-5678",
"currency_t": {
"displayValue": "USD",
"value": "USD"
},
"totalMonthlyListAmount_t": {
"value": 0.0,
"currency": "USD"
},
"totalContractListValue_t": {
"value": 0.0,
"currency": "USD"
},
"_eSignatureAttributeSet_esig_status": {
"displayValue": "Not Sent",
"value": "Not Sent"
},
"shipToPartyID_t": null,
"_soldTo_t_company_name": null,
"_shipTo_t_first_name": null,
"_invoiceTo_t_country": {
"displayValue": "United States",
"value": "United States"
},
"version_t": 1,
"_shipTo_t_company_name": null,
"proposalPreparedByPhone_t": null,
"_price_book_var_name": "_default_price_book",
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_shipTo_t_address": null,
"totalOneTimeDiscount_t": {
"value": 0.0,

[Link] 9/222
9/15/25, 2:27 PM Commerce REST APIs
"currency": "USD"
},
"totalMonthlyNetAmount_t": {
"value": 0.0,
"currency": "USD"
},
"winLossStatus_t": {
"displayValue": "In Progress",
"value": "IN PROGRESS"
},
"lastUpdatedDate_t": "2023-03-02T07:07:00Z",
"_document_var_name": "transaction",
"_invoiceTo_t_address": "401 Main Street",
"_customer_t_phone": "555-555-5678",
"lastPricedDate_t": "2023-03-02T07:07:00Z",
"lastUpdatedBy_t": "Super User",
"oRCL_SFDC_UserID_t": null,
"oRCL_ERP_OrderNumber_t": null,
"_soldTo_t_city": null,
"paymentTerms_t": null,
"createdDate_t": "2023-03-01",
"oRCL_SFDC_Product200IDs_t": null,
"approval_status_submit_t": null,
"oRCL_INT_ExchangeRate_t": null,
"transactionDescription_t": null,
"totalMonthlyCostAmount_t": {
"value": 0.0,
"currency": "USD"
},
"oRCL_SFDC_Product800IDs_t": null,
"_date_added": "2023-03-02T07:07:25.000Z",
"oRCL_SFDC_Product600IDs_t": null,
"oRCL_SFDC_Product400IDs_t": null,
"_invoiceTo_t_phone": "555-555-5678",
"oRCL_ERP_PartialShipAllowed_t": false,
"customerPartyID_t": null,
"_shipTo_t_state": null,
"proposalPreparedByCell_t": null,
"_soldTo_t_address_2": null,
"invoiceToPartyID_t": null,
"_process_var_name": "oraclecpqo",
"_invoiceTo_t_zip": "60081",
"createdBy_t": "Super User",
"_soldTo_t_last_name": null,
"oRCL_INT_TargetCurrency_t": {
"displayValue": "USD",
"value": "USD"
},
"invoiceToPartySiteID_t": null,
"oRCL_ERP_ReservationStatus_t": null,
"_eSignatureAttributeSet_esig_envelope_id": null,
"transactionID_t": "CPQ-16",
"taxExempt_t": false,
"_buyer_company_name": "phoenix87575",
"opportunityName_t": null,
"totalMonthlyDiscount_t": {

[Link] 10/222
9/15/25, 2:27 PM Commerce REST APIs
"value": 0.0,
"currency": "USD"
},
"_invoiceTo_t_fax": "555-555-5678",
"_shipTo_t_email": null,
"parent_transaction_id_versionTransaction_t": null,
"opportunityID_t": null,
"fulfillmentStatus_t": null,
"_soldTo_t_phone": null,
"_eSignatureAttributeSet_esig_recipients": null,
"oRCL_ERP_IntegrationStatus_t": "0_revertToDefault",
"approval_history_submit_t": null,
"soldToPartySiteID_t": null,
"_customer_t_last_name": "Jones",
"salesChannel_t": null,
"totalAnnualValue_t": {
"value": 0.0,
"currency": "USD"
},
"transactionTotalDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"transactionListTotal_t": {
"value": 0.0,
"currency": "USD"
},
"_shipTo_t_city": null,
"_shipTo_t_country": null,
"defaultRequestDate_t": null,
"priceScore_t": 9,
"oRCL_ERP_AvailabilityCheckDate_t": null,
"transactionMarginPercent_t": 0.0,
"purchaseOrderNumber_t": null,
"_last_document_number": 15,
"_approve_link": "",
"_customer_t_address_2": "Unit 55",
"requireApprovalIfChecked_temporary_t": false,
"_id": 3022920645,
"_invoiceTo_t_address_2": "Unit 55",
"oRCL_ERP_SoapResponse_t": null,
"_shipTo_t_company_name_2": null,
"soldToPartyID_t": null,
"oRCL_SFDC_TransactionID_t": null,
"totalAnnualMarginAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_shipTo_t_address_2": null,
"_step_var_name": null,
"_soldTo_t_company_name_2": null,
"transactionMarginTotal_t": {
"value": 0.0,
"currency": "USD"
},
"TotalAnnualDiscount_t": {

[Link] 11/222
9/15/25, 2:27 PM Commerce REST APIs
"value": 0.0,
"currency": "USD"
},
"_soldTo_t_address": null,
"_invoiceTo_t_last_name": "Jones",
"totalContractMarginAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_customer_t_company_name_2": "Co.",
"approval_revision_submit_t": 1,
"_supplier_company_name": "phoenix87575",
"version_number_versionTransaction_t": "1",
"_customer_t_first_name": "Bill",
"transactionCostTotal_t": {
"value": 0.0,
"currency": "USD"
},
"totalMonthlyMarginAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_pp_name": "Admin",
"status_t": {
"displayValue": "Created",
"value": "CREATED"
},
"transactionLine": {
"hasMore": false,
"links": [{
"rel": "self",
"href":
"[Link]
ransactionLine"
}
],
"items": [{
"_line_bom_attributes": null,
"listAmount_l": {
"value": 5.0,
"currency": "USD"
},
"discountAmount_l": {
"value": 0.0,
"currency": "USD"
},
"contractStartDate_l": null,
"requestedQuantity_l": 5,
"_model_partner_entity_id": null,
"_config_attributes": {
"value": null
},
"oRCL_ERP_ReservationDate_l": null,
"oRCL_ERP_FifthOverridePeriod_l": null,
"oRCL_ERP_ThirdOverrideAmount_l": null,
"_part_display_number": "Part Display 1",

[Link] 12/222
9/15/25, 2:27 PM Commerce REST APIs
"_model_attributes": {
"value": null
},
"_price_list_price_each": {
"value": 1.0,
"currency": "USD"
},
"_line_bom_effective_date": null,
"includedInBasePrice": null,
"_parent_line_item": null,
"_date_modified": "2023-03-02T08:09:58.000Z",
"oRCL_ERP_SecondRecurringInvoiceDate_l": null,
"rootAssetKey_l": null,
"annualMargin_l": {
"value": 0.0,
"currency": "USD"
},
"_model_product_line_attributes": {
"value": null
},
"_price_configurable_price": {
"value": 1.0,
"currency": "USD"
},
"oRCL_ERP_FirstOverrideAmount_l": null,
"costAmount_l": {
"value": 0.0,
"currency": "USD"
},
"_is_part_pricing_rule_price": false,
"contractEndDate_l": null,
"_last_modified_date": "2023-03-02 00:09:58",
"parentLineID_l": null,
"_config_extra_info": null,
"oRCL_ERP_ThirdOverridePeriod_l": null,
"unitMargin_l": {
"value": 1.0,
"currency": "USD"
},
"canChangeQuantity_l": false,
"oRCL_ERP_FifthOverrideAmount_l": null,
"_part_number": "part1",
"_sequence_number": 1,
"_line_bom_display_name": null,
"taxExemptReason_l": null,
"unitCost_l": {
"value": 0.0,
"currency": "USD"
},
"_price_unit_price_each": {
"value": 1.0,
"currency": "USD"
},
"actualAmount_l": {
"value": 0.0,
"currency": "USD"

[Link] 13/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_model_base_price": null,
"customDiscountValue_l": null,
"_model_product_line_name": null,
"_price_item_price_each": {
"value": 1.0,
"currency": "USD"
},
"_transaction_currency_pref": {
"id": 14619668,
"currencyCode": "USD"
},
"oRCL_ABO_ComponentAttributes_l": null,
"_price_override_discount": {
"displayValue": "None",
"value": "None"
},
"priceWithinPolicy_l": true,
"_model_supplier_company_id": null,
"_model_segment_id": null,
"displayedItemName_l": null,
"oRCL_ERP_FourthOverridePeriod_l": null,
"_partner_entity_id": null,
"statusPartial_l": false,
"_part_custom_field14": "Custom Field 14, part1",
"_part_custom_field15": "Custom Field 15, part1",
"requestDate_l": null,
"_part_custom_field16": null,
"_part_base_price": {
"value": 1.0,
"currency": "USD"
},
"_part_custom_field17": null,
"_part_custom_field10": "Custom Field 10, part1",
"_part_custom_field11": "Required value",
"oRCL_SFDC_ExternalID_l": "2-3022920645",
"contractMargin_l": {
"value": 5.0,
"currency": "USD"
},
"_part_custom_field12": null,
"pricePeriod_l": null,
"_part_custom_field13": "Custom Field 13, part1",
"_model_partner_organization_id": null,
"_part_custom_field9": "100K Parts",
"_model_segment_name": null,
"statusDate_l": null,
"firstRecurringInvoiceDate_l": null,
"_part_custom_field3": null,
"_part_custom_field4": null,
"_part_custom_field1": "String",
"priceType_l": {
"displayValue": "One Time",
"value": "One Time"
},
"_part_custom_field2": "Value 1",

[Link] 14/222
9/15/25, 2:27 PM Commerce REST APIs
"_part_custom_field20": "Custom Field 20, part1",
"_part_custom_field7": 0.0,
"_part_custom_field8": null,
"_part_custom_field5": 0.0,
"_part_custom_field6": 0.0,
"_config_attr_info": {
"value": null
},
"_part_custom_field25": "Custom Field 25, part1",
"_part_custom_field26": "Custom Field 26, part1",
"_part_custom_field27": "Custom Field 27, part1",
"_part_custom_field28": null,
"_part_custom_field21": "Custom Field 21, part1",
"contractValue_l": {
"value": 5.0,
"currency": "USD"
},
"_part_custom_field22": "Custom Field 22, part1",
"_part_custom_field23": "Custom Field 23, part1",
"oRCL_ERP_CancellationEffectiveDate_l": null,
"_part_custom_field24": "Custom Field 24, part1",
"_price_net_price": {
"value": 5.0,
"currency": "USD"
},
"_prior_price": null,
"customDiscountAmount_l": {
"value": 0.0,
"currency": "USD"
},
"_parent_doc_number": null,
"_part_custom_field18": "Custom Field 18, part1",
"_part_custom_field19": "Custom Field 19, part1",
"_reconfiguration_date": "1970-01-01 00:00:00",
"annualCost_l": {
"value": 0.0,
"currency": "USD"
},
"_part_desc": null,
"_pp_id": 18355578,
"_document_number": 2,
"_price_discount_percent": 0.0,
"oRCL_ERP_InventoryAvailability_l": {
"displayValue": "Not Checked",
"value": "Not Checked"
},
"oRCL_ERP_ReservationQuantity_l": null,
"_rollup_delta_price": null,
"_is_bom_price": false,
"winLossStatus_l": {
"displayValue": "In Progress",
"value": "IN PROGRESS"
},
"_price_calculation_info": "[]",
"oRCL_ERP_RequestShipDate_l": "2023-03-02",
"_price_component_prices": {

[Link] 15/222
9/15/25, 2:27 PM Commerce REST APIs
"value": null
},
"_part_supplier_company_id": "4118171",
"_original_document_number": "-1",
"contractListValue_l": {
"value": 5.0,
"currency": "USD"
},
"_line_item_spare_rule_var_name": null,
"_part_id": "8523072",
"_part_company_associations": null,
"oRCL_ERP_BillingInstr_l": null,
"lineID_l": "2",
"marginPercent_l": 100.0,
"_price_book_var_name": "_default_price_book",
"_price_subtotal": {
"value": 5.0,
"currency": "USD"
},
"customDiscountType_l": null,
"_group_sequence_number": "1.0",
"lastUpdatedDate_l": null,
"_price_quantity": 5,
"lastUpdatedBy_l": "Super User",
"_part_supplier_company_name": "phoenix87575",
"_document_var_name": "transactionLine",
"oRCL_SFDC_SynchronizationID_l": null,
"createdDate_l": "2023-03-02T08:09:00Z",
"contractCost_l": {
"value": 0.0,
"currency": "USD"
},
"actualQuantity_l": null,
"oRCL_ERP_PackingInstr_l": null,
"contractDiscount_l": {
"value": 0.0,
"currency": "USD"
},
"_line_bom_name": null,
"_model_is_valid": false,
"canChangeConfiguration_l": false,
"_config_attr_text": {
"value": null
},
"itemInstanceName_l": null,
"_line_bom_model_path": null,
"_model_id": null,
"_date_added": "2023-03-02T08:09:58.000Z",
"_model_product_line_id": null,
"parentLineNumber_l": null,
"requestedUnitOfMeasure_l": null,
"_configuration_id": null,
"_part_custom_field30": "Custom Field 30, part1",
"_model_bom": null,
"contractedPeriods_l": 1,
"createdBy_l": "Super User",

[Link] 16/222
9/15/25, 2:27 PM Commerce REST APIs
"fulfillmentStatus_l": null,
"_model_variable_name": null,
"_part_custom_field29": null,
"_model_product_line_var_name": null,
"_is_recommended_price": false,
"oRCL_ERP_FourthOverrideAmount_l": null,
"annualListValue_l": {
"value": 0.0,
"currency": "USD"
},
"_line_bom_id": null,
"_model_supplier_company_name": null,
"oRCL_ERP_ReservationStatus_l": null,
"oRCL_ERP_SecondOverrideAmount_l": null,
"taxExempt_l": false,
"transactionID_l": "3022920645",
"_line_bom_part_number": "part1",
"itemInstanceId_l": null,
"oRCL_ERP_ShippingInstr_l": null,
"_line_bom_item_quantity": 1,
"oRCL_ERP_ShipSet_l": null,
"annualDiscount_l": {
"value": 0.0,
"currency": "USD"
},
"_model_segment_var_name": null,
"_line_bom_level": null,
"_bs_id": 3022920645,
"customerItemName_l": null,
"_price_total_discount": {
"value": 0.0,
"currency": "USD"
},
"netAmount_l": {
"value": 5.0,
"currency": "USD"
},
"oRCL_ERP_SecondOverridePeriod_l": null,
"_part_units": null,
"_part_direct_buy": "1",
"oRCL_ABO_ActionCode_l": null,
"oRCL_ERP_FirstOverridePeriod_l": null,
"_line_bom_parent_id": null,
"priceScore_l": 9,
"_line_item_type": "Standard Item",
"_delta_price": null,
"_line_display_name": "Part Display 1",
"netPrice_l": {
"value": 1.0,
"currency": "USD"
},
"oRCL_ERP_SecondBillingPeriodStartDate_l": null,
"oRCL_ERP_LineID_l": null,
"listPrice_l": {
"value": 1.0,
"currency": "USD"

[Link] 17/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_part_extended_desc_2": "Extended description 2 for part1",
"_part_extended_desc_1": "Extended description 1 for part1",
"statusQuantity_l": null,
"_is_line_item_mandatory": false,
"_id": 3022920673,
"oRCL_ERP_AvailableQuantity_l": null,
"_part_lead_time": "N/A",
"lineNumber_l": null,
"status_l": {
"displayValue": "Created",
"value": "CREATED"
},
"_line_item_comment": null,
"_price_discount_comment": null,
"_line_bom_sequence_index": null,
"_step_var_name": null,
"_price_override_price": {
"displayValue": "No",
"value": "No"
},
"_model_name": null,
"_config_attr_values": null,
"_part_drawing_position": null,
"_pricing_rule_price_each": {
"value": 0.0,
"currency": "USD"
},
"_price_override_quantity": false,
"oRCL_ERP_ShippingCharges_l": null,
"_line_bom_variable_name": "configIntegrationRoot",
"marginAmount_l": {
"value": 5.0,
"currency": "USD"
},
"oRCL_ERP_ReservationID_l": null,
"annualValue_l": {
"value": 0.0,
"currency": "USD"
},
"_pp_name": "Admin",
"_line_bom_condition_index": null,
"links": [{
"rel": "self",
"href":
"[Link]
ransactionLine/2"
}, {
"rel": "parent",
"href":
"[Link]
}
]
}, {
"_line_bom_attributes": null,
"listAmount_l": {

[Link] 18/222
9/15/25, 2:27 PM Commerce REST APIs
"value": 20.0,
"currency": "USD"
},
"discountAmount_l": {
"value": 0.0,
"currency": "USD"
},
"contractStartDate_l": null,
"requestedQuantity_l": 10,
"_model_partner_entity_id": null,
"_config_attributes": {
"value": null
},
"oRCL_ERP_ReservationDate_l": null,
"oRCL_ERP_FifthOverridePeriod_l": null,
"oRCL_ERP_ThirdOverrideAmount_l": null,
"_part_display_number": "Part Display 2",
"_model_attributes": {
"value": null
},
"_price_list_price_each": {
"value": 2.0,
"currency": "USD"
},
"_line_bom_effective_date": null,
"includedInBasePrice": null,
"_parent_line_item": "part1",
"_date_modified": "2023-03-02T08:09:58.000Z",
"oRCL_ERP_SecondRecurringInvoiceDate_l": null,
"rootAssetKey_l": null,
"annualMargin_l": {
"value": 0.0,
"currency": "USD"
},
"_model_product_line_attributes": {
"value": null
},
"_price_configurable_price": {
"value": 2.0,
"currency": "USD"
},
"oRCL_ERP_FirstOverrideAmount_l": null,
"costAmount_l": {
"value": 0.0,
"currency": "USD"
},
"_is_part_pricing_rule_price": false,
"contractEndDate_l": null,
"_last_modified_date": "2023-03-02 00:09:58",
"parentLineID_l": "2",
"_config_extra_info": null,
"oRCL_ERP_ThirdOverridePeriod_l": null,
"unitMargin_l": {
"value": 2.0,
"currency": "USD"
},

[Link] 19/222
9/15/25, 2:27 PM Commerce REST APIs
"canChangeQuantity_l": false,
"oRCL_ERP_FifthOverrideAmount_l": null,
"_part_number": "part2",
"_sequence_number": 2,
"_line_bom_display_name": null,
"taxExemptReason_l": null,
"unitCost_l": {
"value": 0.0,
"currency": "USD"
},
"_price_unit_price_each": {
"value": 2.0,
"currency": "USD"
},
"actualAmount_l": {
"value": 0.0,
"currency": "USD"
},
"_model_base_price": null,
"customDiscountValue_l": null,
"_model_product_line_name": null,
"_price_item_price_each": {
"value": 2.0,
"currency": "USD"
},
"_transaction_currency_pref": {
"id": 14619668,
"currencyCode": "USD"
},
"oRCL_ABO_ComponentAttributes_l": null,
"_price_override_discount": {
"displayValue": "None",
"value": "None"
},
"priceWithinPolicy_l": true,
"_model_supplier_company_id": null,
"_model_segment_id": null,
"displayedItemName_l": null,
"oRCL_ERP_FourthOverridePeriod_l": null,
"_partner_entity_id": null,
"statusPartial_l": false,
"_part_custom_field14": "Custom Field 14, part2",
"_part_custom_field15": "Custom Field 15, part2",
"requestDate_l": null,
"_part_custom_field16": null,
"_part_base_price": {
"value": 2.0,
"currency": "USD"
},
"_part_custom_field17": null,
"_part_custom_field10": "Custom Field 10, part2",
"_part_custom_field11": "Required value",
"oRCL_SFDC_ExternalID_l": "3-3022920645",
"contractMargin_l": {
"value": 20.0,
"currency": "USD"

[Link] 20/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_part_custom_field12": null,
"pricePeriod_l": null,
"_part_custom_field13": "Custom Field 13, part2",
"_model_partner_organization_id": null,
"_part_custom_field9": "100K Parts",
"_model_segment_name": null,
"statusDate_l": null,
"firstRecurringInvoiceDate_l": null,
"_part_custom_field3": null,
"_part_custom_field4": null,
"_part_custom_field1": "String",
"priceType_l": {
"displayValue": "One Time",
"value": "One Time"
},
"_part_custom_field2": "Value 1",
"_part_custom_field20": "Custom Field 20, part2",
"_part_custom_field7": 0.0,
"_part_custom_field8": null,
"_part_custom_field5": 0.0,
"_part_custom_field6": 0.0,
"_config_attr_info": {
"value": null
},
"_part_custom_field25": "Custom Field 25, part2",
"_part_custom_field26": "Custom Field 26, part2",
"_part_custom_field27": "Custom Field 27, part2",
"_part_custom_field28": null,
"_part_custom_field21": "Custom Field 21, part2",
"contractValue_l": {
"value": 20.0,
"currency": "USD"
},
"_part_custom_field22": "Custom Field 22, part2",
"_part_custom_field23": "Custom Field 23, part2",
"oRCL_ERP_CancellationEffectiveDate_l": null,
"_part_custom_field24": "Custom Field 24, part2",
"_price_net_price": {
"value": 20.0,
"currency": "USD"
},
"_prior_price": null,
"customDiscountAmount_l": {
"value": 0.0,
"currency": "USD"
},
"_parent_doc_number": "2",
"_part_custom_field18": "Custom Field 18, part2",
"_part_custom_field19": "Custom Field 19, part2",
"_reconfiguration_date": "1970-01-01 00:00:00",
"annualCost_l": {
"value": 0.0,
"currency": "USD"
},
"_part_desc": null,

[Link] 21/222
9/15/25, 2:27 PM Commerce REST APIs
"_pp_id": 18355578,
"_document_number": 3,
"_price_discount_percent": 0.0,
"oRCL_ERP_InventoryAvailability_l": {
"displayValue": "Not Checked",
"value": "Not Checked"
},
"oRCL_ERP_ReservationQuantity_l": null,
"_rollup_delta_price": null,
"_is_bom_price": false,
"winLossStatus_l": {
"displayValue": "In Progress",
"value": "IN PROGRESS"
},
"_price_calculation_info": "[]",
"oRCL_ERP_RequestShipDate_l": "2023-03-02",
"_price_component_prices": {
"value": null
},
"_part_supplier_company_id": "4118171",
"_original_document_number": "-1",
"contractListValue_l": {
"value": 20.0,
"currency": "USD"
},
"_line_item_spare_rule_var_name": null,
"_part_id": "8523074",
"_part_company_associations": null,
"oRCL_ERP_BillingInstr_l": null,
"lineID_l": "3",
"marginPercent_l": 100.0,
"_price_book_var_name": "_default_price_book",
"_price_subtotal": {
"value": 20.0,
"currency": "USD"
},
"customDiscountType_l": null,
"_group_sequence_number": "1.1",
"lastUpdatedDate_l": null,
"_price_quantity": 10,
"lastUpdatedBy_l": "Super User",
"_part_supplier_company_name": "phoenix87575",
"_document_var_name": "transactionLine",
"oRCL_SFDC_SynchronizationID_l": null,
"createdDate_l": "2023-03-02T08:09:00Z",
"contractCost_l": {
"value": 0.0,
"currency": "USD"
},
"actualQuantity_l": null,
"oRCL_ERP_PackingInstr_l": null,
"contractDiscount_l": {
"value": 0.0,
"currency": "USD"
},
"_line_bom_name": null,

[Link] 22/222
9/15/25, 2:27 PM Commerce REST APIs
"_model_is_valid": false,
"canChangeConfiguration_l": false,
"_config_attr_text": {
"value": null
},
"itemInstanceName_l": null,
"_line_bom_model_path": null,
"_model_id": null,
"_date_added": "2023-03-02T08:09:58.000Z",
"_model_product_line_id": null,
"parentLineNumber_l": null,
"requestedUnitOfMeasure_l": null,
"_configuration_id": null,
"_part_custom_field30": "Custom Field 30, part2",
"_model_bom": null,
"contractedPeriods_l": 1,
"createdBy_l": "Super User",
"fulfillmentStatus_l": null,
"_model_variable_name": null,
"_part_custom_field29": null,
"_model_product_line_var_name": null,
"_is_recommended_price": false,
"oRCL_ERP_FourthOverrideAmount_l": null,
"annualListValue_l": {
"value": 0.0,
"currency": "USD"
},
"_line_bom_id": null,
"_model_supplier_company_name": null,
"oRCL_ERP_ReservationStatus_l": null,
"oRCL_ERP_SecondOverrideAmount_l": null,
"taxExempt_l": false,
"transactionID_l": "3022920645",
"_line_bom_part_number": "part2",
"itemInstanceId_l": null,
"oRCL_ERP_ShippingInstr_l": null,
"_line_bom_item_quantity": 2,
"oRCL_ERP_ShipSet_l": null,
"annualDiscount_l": {
"value": 0.0,
"currency": "USD"
},
"_model_segment_var_name": null,
"_line_bom_level": null,
"_bs_id": 3022920645,
"customerItemName_l": null,
"_price_total_discount": {
"value": 0.0,
"currency": "USD"
},
"netAmount_l": {
"value": 20.0,
"currency": "USD"
},
"oRCL_ERP_SecondOverridePeriod_l": null,
"_part_units": null,

[Link] 23/222
9/15/25, 2:27 PM Commerce REST APIs
"_part_direct_buy": "1",
"oRCL_ABO_ActionCode_l": null,
"oRCL_ERP_FirstOverridePeriod_l": null,
"_line_bom_parent_id": null,
"priceScore_l": 9,
"_line_item_type": "Standard Item",
"_delta_price": null,
"_line_display_name": "Part Display 2",
"netPrice_l": {
"value": 2.0,
"currency": "USD"
},
"oRCL_ERP_SecondBillingPeriodStartDate_l": null,
"oRCL_ERP_LineID_l": null,
"listPrice_l": {
"value": 2.0,
"currency": "USD"
},
"_part_extended_desc_2": "Extended description 2 for part2",
"_part_extended_desc_1": "Extended description 1 for part2",
"statusQuantity_l": null,
"_is_line_item_mandatory": true,
"_id": 3022920672,
"oRCL_ERP_AvailableQuantity_l": null,
"_part_lead_time": "N/A",
"lineNumber_l": null,
"status_l": {
"displayValue": "Created",
"value": "CREATED"
},
"_line_item_comment": null,
"_price_discount_comment": null,
"_line_bom_sequence_index": null,
"_step_var_name": null,
"_price_override_price": {
"displayValue": "No",
"value": "No"
},
"_model_name": null,
"_config_attr_values": null,
"_part_drawing_position": null,
"_pricing_rule_price_each": {
"value": 0.0,
"currency": "USD"
},
"_price_override_quantity": false,
"oRCL_ERP_ShippingCharges_l": null,
"_line_bom_variable_name": "configIntegrationParentText",
"marginAmount_l": {
"value": 20.0,
"currency": "USD"
},
"oRCL_ERP_ReservationID_l": null,
"annualValue_l": {
"value": 0.0,
"currency": "USD"

[Link] 24/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_pp_name": "Admin",
"_line_bom_condition_index": null,
"links": [{
"rel": "self",
"href":
"[Link]
ransactionLine/3"
}, {
"rel": "parent",
"href":
"[Link]
}
]
},
"links": [{
"rel": "self",
"href":
"[Link]
}
]
},
"warnings": {},
"cacheInstanceId": "DIDZTgMLAWzyX6fUwJejEfn1xj9fnhiN2UmfR4cLpWPzKbLdeqm35ndhWBcqTX8z",
"destinationURL": "[Link]
action_id=18353692&document_id=18351533&id=3022920645&version_id=18358579&destination_ur
l="
}

Alternate Address - Retrieve

Alternate Address - Retrieve

Use this endpoint to return alternative addresses that are associated with the current customer and
Description
transaction.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_retrieve_alternate_address

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a

transaction within an Oracle CPQ site.

POST
HTTP Method

[Link] 25/222
9/15/25, 2:27 PM Commerce REST APIs

Alternate Address - Retrieve

Request Body accountAddressCriteria Captures the query definition for the current resource request.
Parameters

This endpoint supports the cacheInstanceId parameter. Refer to Request Body Objects for additional
information

Response Body accountAddressCriteria Captures the query definition for the current resource request.

Parameters
accountAddressList Alternative 'bill_to/ship_to' addresses associated with the current
customer and Transaction.

URI Endpoint Sample

[Link]
ions/_retrieve_alternate_address

Response Body Sample

[Link] 26/222
9/15/25, 2:27 PM Commerce REST APIs
{
"accountAddressList": {
"hasMore": false,
"items": [{
"dateModified": "2011-01-18",
"billing_phone": "555-555-5678",
"shipping_state": "Arkansas",
"billing_last_name": "Jones",
"dateAdded": "2008-05-07",
"billing_state": "Arkansas",
"shipping_company_2": "Co.",
"billing_email": "[Link]@[Link]",
"shipping_address_2": "Unit 55",
"id": 4162301,
"shipping_address": "401 Main Street",
"billing_country": "United States",
"shipping_zip": "60081",
"shipping_fax": "555-555-5678",
"shipping_phone": "555-555-5678",
"shipping_last_name": "Jones",
"billing_fax": "555-555-5678",
"shipping_country": "United States",
"shipping_first_name": "Bill",
"shipping_city": "Little Rock",
"shipping_company": "Apple",
"shipping_email": "[Link]@[Link]",
"billing_company": "Apple",
"billing_zip": "60081",
"billing_first_name": "Bill",
"billing_city": "Little Rock",
"billing_company_2": "Co.",
"billing_address_2": "Unit 55",
"billing_address": "401 Main Street"
}, {
"dateModified": "2011-01-18",
"billing_phone": "555-555-5679",
"shipping_state": "California",
"billing_last_name": "Brown",
"dateAdded": "2008-05-15",
"billing_state": "California",
"shipping_company_2": "Inc.",
"billing_email": "[Link]@[Link]",
"shipping_address_2": "Suite 128",
"id": 5676963,
"shipping_address": "501 Pine Circle",
"billing_country": "United States",
"shipping_zip": "60082",
"shipping_fax": "555-555-5679",
"shipping_phone": "555-555-5679",
"shipping_last_name": "Brown",
"billing_fax": "555-555-5679",
"shipping_country": "United States",
"shipping_first_name": "Steve",
"shipping_city": "Sacramento",
"shipping_company": "Oracle",
"shipping_email": "[Link]@[Link]",

[Link] 27/222
9/15/25, 2:27 PM Commerce REST APIs
"billing_company": "Oracle",
"billing_zip": "60082",
"billing_first_name": "Steve",
"billing_city": "Sacramento",
"billing_company_2": "Inc.",
"billing_address_2": "Suite 128",
"billing_address": "501 Pine Circle"
}, {
"dateModified": "2011-01-18",
"billing_phone": "555-555-5680",
"shipping_state": "Colorado",
"billing_last_name": "Davis",
"dateAdded": "2008-05-15",
"billing_state": "Colorado",
"shipping_company_2": "Corp.",
"billing_email": "[Link]@[Link]",
"shipping_address_2": "PO Box 458",
"id": 5676964,
"shipping_address": "601 Maple Court",
"billing_country": "United States",
"shipping_zip": "60083",
"shipping_fax": "555-555-5680",
"shipping_phone": "555-555-5680",
"shipping_last_name": "Davis",
"billing_fax": "555-555-5680",
"shipping_country": "United States",
"shipping_first_name": "Mark",
"shipping_city": "Denver",
"shipping_company": "HP",
"shipping_email": "[Link]@[Link]",
"billing_company": "HP",
"billing_zip": "60083",
"billing_first_name": "Mark",
"billing_city": "Denver",
"billing_company_2": "Corp.",
"billing_address_2": "PO Box 458",
"billing_address": "601 Maple Court"
}
]
}
}

Alternate Address - Select

Alternate Address - Select

Use this endpoint to associate an alternate account address with a transaction. This action is only
Description
available when the Customer ID field associated with a transaction has multiple addresses.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_select_alternate_address_action

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

[Link] 28/222
9/15/25, 2:27 PM Commerce REST APIs

Alternate Address - Select

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body accountAddressId The ID for the alternate address.

Parameters

alternateAddress Alternative bill to and ship to addresses.

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
documents, revisionId, selectionMode, selections, and skipIntegration.
Refer to Request Body Objects for additional information

Response Body documents JSON data containing a link to the transaction with updated bill to and ship to
Parameters addresses.

URI Endpoint Sample

[Link]
ions/_select_alternate_address_action

Request Body Sample

{
"criteria": {
"state": false,
"actions": [],
"groups": [],
"fields": ["_id", "_bill_to_country", "_bill_to_state"]
},
"documents": {},
"accountAddressId": 4162301
}

Response Body Sample

[Link] 29/222
9/15/25, 2:27 PM Commerce REST APIs
{
"documents": {
"_bill_to_country": {
"value": "United States",
"displayValue": "United States"
},
"_id": 19642736,
"_bill_to_state": {
"value": "Arkansas",
"displayValue": "Arkansas"
},
"links": [{
"rel": "self",
"href":
"[Link]
}, {
"name": "lineItem",
"rel": "child",
"href":
"[Link]
eItem",
"kind": ""
}
]
},
"warnings": {}
}

Archive Transactions

Archive Transactions

Use this endpoint to archive the specified transactions.

Description

Note: This action is only available for Application Administrators.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/actions/_archive_transactions

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

selectionCriteria Captures the query definition for resource requests, specifically for collection-
Request Body
based process actions.
Parameters

[Link] 30/222
9/15/25, 2:27 PM Commerce REST APIs

Archive Transactions

This operation supports the following optional parameters: fields, orderby, and q.
Refer to Request Body Objects for additional information

POST
HTTP Method

204 No Content
Success
Response

URI Endpoint Sample

[Link]
hive_transactions

Request Sample

{
"selectionCriteria": {
"q": "{'bsid':{$eq:'3022127625'}}",
"orderby": ["field1:ASC", "field2:DESC"]
}
}

Auto-fill Account Information

Auto-fill Account Information

Use this endpoint to automatically fill related customer data using the specified Customer ID field.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_auto_fill_action

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body billToAddressNumber The number for the bill to address information.
Parameters

shipToAddressNumber The number for the ship to address information.

[Link] 31/222
9/15/25, 2:27 PM Commerce REST APIs

Auto-fill Account Information

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
documents, revisionId, selectionMode, selections, and skipIntegration.
Refer to Request Body Objects for additional information

JSON data containing a link to the transaction with updated bill to and shop to addresses.
Response Body
Parameters

URI Endpoint Sample

[Link]
ions/_auto_fill_action

Request Body Sample

{
"billToAddressNumber": 2,
"shipToAddressNumber": 3,
"documents": {
"quoteDescription": "updated quote description 5",
"_customer_id": "account95",
"_bill_to_address": "30777 Park Avenue",
"lineItem": {
"items": [{
"_price_quantity": 304,
"_document_number": 3
}
]
}
}
}

Response Body Sample

{
"documents": {
"quoteDescription": "updated quote description 5",
"_customer_id": "account95",
"_bill_to_address": "307 Park Avenue",
"_ship_to_address": "207 Second Street",
"lineItem": {
"items": [{
"_price_quantity": 304,
"_document_number": 3
}
]
}
}
}

Back to Quotes List / Transaction Manager

[Link] 32/222
9/15/25, 2:27 PM Commerce REST APIs

Back to Quotes List / Transaction Manager

Use this endpoint to navigate back to the specified Quotes List/Transaction Manager page.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/back_to_transactionmanager_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body This endpoint supports the optional cacheInstanceId and revisionId parameters.
Parameters
Refer to Request Body Objects for additional information

The response contains the Destination URL

Response Body
Parameters

URI Endpoint Sample

[Link]
ions/back_to_transactionmanager_t

Sample Response

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

Back to Transaction

Back to Transaction

Use this endpoint to return the user to the transaction page from the line items details page.
Description

[Link] 33/222
9/15/25, 2:27 PM Commerce REST APIs

Back to Transaction

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_back

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters errorCriteria, and revisionId.

Refer to Request Body Objects for additional information

JSON data for the parent transaction.

Success
Response

URI Endpoint Sample

[Link]
nsactionLine/2/actions/back_l

Response Sample

[Link] 34/222
9/15/25, 2:27 PM Commerce REST APIs
{
"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":
"[Link]
3023402512/attachmentAttributes/_eSignatureAttributeSet_esig_file_attachment/transaction
s/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,

[Link] 35/222
9/15/25, 2:27 PM Commerce REST APIs
"_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": {

[Link] 36/222
9/15/25, 2:27 PM Commerce REST APIs
"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,

[Link] 37/222
9/15/25, 2:27 PM Commerce REST APIs
"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_cust
om_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": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_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,

[Link] 38/222
9/15/25, 2:27 PM Commerce REST APIs
"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":

[Link] 39/222
9/15/25, 2:27 PM Commerce REST APIs
"[Link]
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,

[Link] 40/222
9/15/25, 2:27 PM Commerce REST APIs
"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,

[Link] 41/222
9/15/25, 2:27 PM Commerce REST APIs
"_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":
"[Link]
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

[Link] 42/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_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,

[Link] 43/222
9/15/25, 2:27 PM Commerce REST APIs
"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"
},

[Link] 44/222
9/15/25, 2:27 PM Commerce REST APIs
"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,

[Link] 45/222
9/15/25, 2:27 PM Commerce REST APIs
"_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,

[Link] 46/222
9/15/25, 2:27 PM Commerce REST APIs
"_model_bom": null,
"contractedPeriods_l": 1,
"createdBy_l": "Super User",
"parentDocNumber_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,

[Link] 47/222
9/15/25, 2:27 PM Commerce REST APIs
"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,

[Link] 48/222
9/15/25, 2:27 PM Commerce REST APIs
"_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":
"[Link]
transactionLine/2"
}, {
"kind": "",
"rel": "child",
"name": "oRCL_charges",
"href":
"[Link]
transactionLine/2/oRCL_charges"
}, {
"kind": "",
"rel": "child",
"name": "_availableRatePlanSet",
"href":
"[Link]
transactionLine/2/_availableRatePlanSet"
}, {
"kind": "",
"rel": "child",
"name": "_chargeSet",
"href":
"[Link]
transactionLine/2/_chargeSet"
}, {
"rel": "parent",
"href":

[Link] 49/222
9/15/25, 2:27 PM Commerce REST APIs
"[Link]
}
]
}
]
}
},
"warnings": {},
"destinationURL": ""
}

Calculate Transaction Line Item Price

Calculate Transaction Line Item Price

Use this endpoint to apply pricing changes for updates to transaction line price attributes.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_calculate_price_action

Endpoint Stage The stage variable identifies where a transaction is within the Commerce process
Parameters flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction within
an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
Request
Body documents, and revisionId.

Parameters Refer to Request Body Objects for additional information

The JSON Transaction Line data

Response
Body
Parameters

URI Endpoint Sample

[Link]
transactionLine/3/actions/_calculate_price_action

[Link] 50/222
9/15/25, 2:27 PM Commerce REST APIs

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

Notes:

The following attributes are not allowed: _price_list_price_each, _price_subtotal,

_price_net_price, and _price_discount_comment

The "Override Price" attribute should be set to "Yes" to allow overrides when invoking the REST to perform
recalculation.

If "Override Price" is set to "No" and there are new price values, the values will be reset to the original
values and returned via the REST API. There will be no warning or error message when new values are
provided for recalculation.

The recalculated values returned via the REST API are not saved in the database until a modify type
action is invoked.

Change Transaction Currency

Change Transaction Currency

Use this endpoint to change the currency of an existing transaction. This feature is not currently
Description
supported in the Base Reference Application but can be enabled via customization.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_change_currency

[Link] 51/222
9/15/25, 2:27 PM Commerce REST APIs

Change Transaction Currency

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

currencyCode The requested currency code, this item is required

Request Body
Parameters
This endpoint supports the following optional parameters: cacheInstanceId, criteria, documents,
revisionId, selectionMode, selections, and skipIntegration.
Refer to Request Body Objects for additional information

JSON data containing the transaction with the updated currency

Success
Response

The currency can only be changed for transactions without any transaction lines.

URI Endpoint Sample

[Link]
ions/_change_currency

Request Body Sample

{"currencyCode": "USD"}

Copy Sequence

Copy Sequence

Use this endpoint to retrieve copy sequences for the Commerce process.
Description

/rest/v19/ommerceDocuments{ProcessVarName}
URI Endpoint
{MainDocVarName}/actions/_copy_sequence

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 52/222
9/15/25, 2:27 PM Commerce REST APIs

Copy Sequence

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

POST
HTTP Method

None
Request
Parameters

Response Parameters sequences An array of sequence definitions

URI Endpoint Sample

[Link]
y_sequence

Response Sample

{
"sequences": [{
"name": "sequece 1",
"id": 38736650,
"order": 1,
"description": "",
"modifiedDate": "Mon May 06 21:55:11 UTC 2024"
}
]

Copy to Favorites

Copy to Favorites

Use this endpoint to copy the specified line items from the transaction to the Favorites List.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/{copyToFavoritesActionVarName}

Endpoint Stage The stage variable identifies where a transaction is within the
Parameters Commerce process flow. (Documents, Quotes, Agreements, or
Orders)

ProcessVarName The variable name of the commerce process, note the first letter
must be capitalized.

MainDocVarName The variable name of the main document, note the first letter must
be capitalized.

id The commerce transaction Id. This is the unique identifier for a

transaction within an Oracle CPQ site.

[Link] 53/222
9/15/25, 2:27 PM Commerce REST APIs

Copy to Favorites

copyToFavoritesActionVarName The variable name of the Copy to Favorites type action.

POST
HTTP Method

selections Required, use to specify the transaction lines.

Request
Parameters
favoriteData Folder where the favorites will reside. An empty or -1 value
indicates default folder.

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
documents, revisionId, and skipIntegration.

Refer to Request Body Objects for additional information

Response createdFavoriteIds List of created favorite root Ids.

Parameters

URI Endpoint Sample

[Link]
/actions/copyToFavorites

Request Sample

{
"selections": [lineItem/2, lineItem/4],
"documents": {
...
}
}

Copy Transaction

Copy Transaction

Use this endpoint to copy the specified transaction.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_copy_transaction

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

[Link] 54/222
9/15/25, 2:27 PM Commerce REST APIs

Copy Transaction

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, copy_sequence_id,

Request Body
Parameters criteria, delta, revisionId, and skipIntegration.

Refer to Request Body Objects for additional information

The JSON data for the duplicated transaction, or a subset of transaction items, depending on the input
Success
request
Response

URI Endpoint Sample

[Link]
ions/_copy_transaction

Response Sample

[Link] 55/222
9/15/25, 2:27 PM Commerce REST APIs
{
"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":
"[Link]
tachmentAttributes/_eSignatureAttributeSet_esig_file_attachment/transactions/38892718/do
cumentNumbers/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,

[Link] 56/222
9/15/25, 2:27 PM Commerce REST APIs
"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,

[Link] 57/222
9/15/25, 2:27 PM Commerce REST APIs
"_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,

[Link] 58/222
9/15/25, 2:27 PM Commerce REST APIs
"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": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_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",

[Link] 59/222
9/15/25, 2:27 PM Commerce REST APIs
"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":
"[Link]
tachmentAttributes/fileAttachment_t/transactions/38892718/documentNumbers/1"
},
"_soldTo_t_address_2": null,

[Link] 60/222
9/15/25, 2:27 PM Commerce REST APIs
"invoiceToPartyID_t": null,
"_esigTest_c_esig_file_attachment": {
"fileName": null,
"fileType": null,
"fileID": null,
"isFileSaved": false,
"fileLocation":
"[Link]
tachmentAttributes/_esigTest_c_esig_file_attachment/transactions/38892718/documentNumber
s/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,

[Link] 61/222
9/15/25, 2:27 PM Commerce REST APIs
"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,

[Link] 62/222
9/15/25, 2:27 PM Commerce REST APIs
"_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":
"[Link]
ansactionLine"
}
],
"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",

[Link] 63/222
9/15/25, 2:27 PM Commerce REST APIs
"_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,

[Link] 64/222
9/15/25, 2:27 PM Commerce REST APIs
"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"
},

[Link] 65/222
9/15/25, 2:27 PM Commerce REST APIs
"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\",\"_pric
ingEngineRuleName\":\"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,

[Link] 66/222
9/15/25, 2:27 PM Commerce REST APIs
"_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",
"parentDocNumber_l": null,
"fulfillmentStatus_l": {
"displayValue": "Fulfilled",
"value": "FULFILLED"

[Link] 67/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_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,

[Link] 68/222
9/15/25, 2:27 PM Commerce REST APIs
"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"

[Link] 69/222
9/15/25, 2:27 PM Commerce REST APIs
},
"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":
"[Link]
ansactionLine/2"
}, {
"kind": "",
"rel": "child",
"name": "_chargeSet",
"href":
"[Link]
ansactionLine/2/_chargeSet"
}, {
"kind": "",
"rel": "child",
"name": "_availableRatePlanSet",
"href":
"[Link]
ansactionLine/2/_availableRatePlanSet"
}, {
"kind": "",
"rel": "child",
"name": "oRCL_charges",
"href":
"[Link]
ansactionLine/2/oRCL_charges"
}, {
"rel": "parent",
"href":
"[Link]
}
]
}
]

[Link] 70/222
9/15/25, 2:27 PM Commerce REST APIs
}
},
"warnings": {},
"destinationURL": "[Link]?bm_cm_process_id=36892642&error_redirect="
}

Copy Transaction Lines

Copy Transaction Lines

Use this endpoint to copy specified transaction lines within the current transaction.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/copyLineItems_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

numberOfCopies The "numberOfCopies" parameter is an array to specify the number of

Request Body
Parameters copies for each line listed in the "selections" parameter.

The number of copies for each line is specified in an array in the same
sequence as the "selections" array.

The default value is '1', if the number of copies value is not provided.

The "numberOfCopies" array size cannot be greater than the

"selections" array size.

selections Required, use to specify the transaction line(s)

This service can be used for transaction and line level actions that support line
selection. Selection items are an array of
{subDocVarName}/{docNumber} combinations.

Line Selection Sample

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

[Link] 71/222
9/15/25, 2:27 PM Commerce REST APIs

Copy Transaction Lines

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
documents, selectionMode, and revisionId.

Refer to Request Body Objects for additional information

The JSON data for the parent transaction including the copied transaction lines, or a subset of transaction
Success
items, depending on the input request transaction
Response

URI Endpoint Sample

[Link]
ions/copyLineItems_t

Request Body Samples

1. Copy transaction lines 5 and 3, copy each item once

{
"numberOfCopies": [1,1],
"selections": ["transactionLine/5", "transactionLine/3"]
}

2. Modify, and then copy transaction lines 5 and 7, copy each item once

{
"documents": {"transactionDescription": "Mar31",
"transactionLine": {
"items":
[
{"_document_number": "5", "_price_quantity": "45"},
{"_document_number": "7", "_price_quantity": "45"}
]
}
},
"numberOfCopies": [1,1],
"selections": ["transactionLine/5", "transactionLine/7"]
}

Create Sales Agreement

Create Sales Agreement

Use this endpoint to create a sales agreement from the specified transaction.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_s_createAgreement

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 72/222
9/15/25, 2:27 PM Commerce REST APIs

Create Sales Agreement

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
Request Body
Parameters documents, revisionId, selectMode, selections, and skipIntegration.

Refer to Request Body Objects for additional information

The JSON data for the sales agreement.

Success
Response

URI Endpoint Sample

[Link]
ctions/_s_create_sales_agreement

Request Sample

[Link] 73/222
9/15/25, 2:27 PM Commerce REST APIs
{
"cacheInstanceId": "aEB9KWLAWCM9oxT3I1hzMD5HZnlStyortgql6CFvC6pOpgZJERtGQNtopEvuIcwf",
"criteria": {
"state": true,
"fields": ["transactionName_t", "transactionID_t", "version_t", "status_t",
"winLossStatus_t", "priceScore_t", "owner_t", "_customer_t_company_name",
"_customer_t_first_name", "_customer_t_last_name", "fileAttachment_t", "createdDate_t",
"lastUpdatedDate_t", "orderPlacedBy_t", "orderDate_t", "lastUpdatedBy_t",
"cancelReason_t", "cancelExplanation_t", "rejectReason_t", "rejectExplanation_t",
"_s_quoteForAgreement_t", "_s_contractID_t", "contractName_t", "contractTypeName_t",
"contractStartDate_t", "contractEndDate_t", "_customer_t_address",
"_customer_t_address_2", "_customer_t_company_name_2", "_customer_t_city",
"_customer_t_state", "_customer_t_zip", "_customer_t_country", "_customer_t_email",
"_customer_t_fax", "_customer_t_phone", "_customer_id", "_soldTo_t_first_name",
"_soldTo_t_last_name", "_soldTo_t_company_name", "_soldTo_t_address", "_soldTo_t_city",
"_soldTo_t_state", "_soldTo_t_zip", "_soldTo_t_country", "_soldTo_t_email",
"_s_billTo_t_company_name", "_s_billTo_t_address", "_s_billTo_t_city",
"_s_billTo_t_state", "_s_billTo_t_zip", "_s_billTo_t_country", "_shipTo_t_first_name",
"_shipTo_t_last_name", "_shipTo_t_company_name", "_shipTo_t_address", "_shipTo_t_city",
"_shipTo_t_state", "_shipTo_t_zip", "_shipTo_t_country", "_shipTo_t_email",
"paymentTerms_t", "priceExpirationDate_t", "priceWithinPolicy_t", "lastPricedDate_t",
"currency_t", "requireApprovalIfChecked_temporary_t", "approval_status_submit_t",
"approval_revision_submit_t", "approval_history_submit_t",
"approve_reject_icon_submit_t", "bs_id", "version_number_versionTransaction_t",
"userKey_t", "currentStepForTesting_tempDisplay_t", "defaultRequestDate_t",
"_s_accountIntegrationResponse_t", "businessUnitId_t", "_s_soldToPartyID_t",
"_s_soldToPartySiteID_t", "_s_soldToCustomerAccountID_t",
"_s_billToCustomerAccountID_t", "billToSiteUseId_t", "_s_shipToPartySiteID_t",
"_s_shipToPartyID_t", "opportunityID_t", "opportunityNumber_t", "opportunityName_t",
"oRCL_SFA_TransactionID_t", "oRCL_SFA_Status_t", "oRCL_SFA_SyncTime_t",
"_s_totalRevenue_t", "_s_useTransactionForAnalytics_t", "_s_customerSegment_t",
"_s_discountGuidanceCeiling_t", "_s_discountGuidanceFloor_t",
"_s_discountGuidanceMax_t", "_s_discountGuidanceMeterGauge_t",
"_s_priceScoreListBased_t", "_s_priceScoreMarginBased_t",
"_s_priceScoreSimpleMarginBasedListPriceBasis_t",
"_s_priceScoreSimpleMarginBasedNetPriceBasis_t",
"_s_priceScoreSimpleMarginBasedUnitCostBasis_t",
"_s_winProbabilityNetRevenueValuePrediction_t", "_s_optimalPrimaryDriver_t",
"_s_optimalWinProbability_t", "_s_optimalTargetValue_t", "_s_winProbability_t",
"totalOneTimeListAmount_t", "totalOneTimeDiscount_t", "totalOneTimeNetAmount_t",
"totalOneTimeCostAmount_t", "totalOneTimeMarginAmount_t", "totalMonthlyListAmount_t",
"totalMonthlyDiscount_t", "totalMonthlyNetAmount_t",
"transactionTotalDiscountPercent_t", "totalMonthlyCostAmount_t",
"totalMonthlyMarginAmount_t", "annualContractListValue_t", "TotalAnnualDiscount_t",
"totalAnnualValue_t", "totalAnnualCostAmount_t", "totalAnnualMarginAmount_t",
"totalContractListValue_t", "totalContractDiscount_t", "totalContractValue_t",
"totalContractCostAmount_t", "totalContractMarginAmount_t",
"transactionMarginPercent_t", "_id", "_step_var_name", "_pp_id", "_pp_name",
"_currency_pref", "_price_book_var_name"],
"childDefs": [{
"name": "transactionLine",
"queryDef": {
"state": true,
"totalResults": true,
"enableHierarchy": true,
"expandNodes": false,

[Link] 74/222
9/15/25, 2:27 PM Commerce REST APIs
"nodesExceptionList": [],
"childDefs": [{
"name": "_chargeSet",
"queryDef": {
"state": true,
"totalResults": true,
"offset": 0,
"fields": ["_chargeSet_chargeDefinition",
"_chargeSet_chargeDefinitionCode", "_chargeSet_chargeDefIntegrationId",
"_chargeSet_priceType", "_chargeSet_chargeType", "_chargeSet_pricePeriod",
"_chargeSet_usageUOM", "_chargeSet_dynamicPricingType", "_chargeSet_rateCardName",
"_chargeSet_rateCardVariableName", "_chargeSet_rateCardStructure",
"_chargeSet_rateCardInHTML", "_chargeSet_unitPrice", "_chargeSet_calculationInfo",
"_chargeSet_discountValue", "_chargeSet_discountType", "_chargeSet_discountAmount",
"_chargeSet_netPrice", "_chargeSet_netAmount", "_row_number"]
}
}
],
"offset": 0,
"limit": 10,
"fields": ["documentNumber_l", "_group_sequence_number", "_model_name",
"_part_number", "partNumberCustom_c", "_part_display_number", "_price_applied_ratePlan",
"_price_applied_agreement_name", "listPrice_l", "_price_quantity",
"contractStartDate_l", "contractEndDate_l", "pricePeriod_l", "contractedPeriods_l",
"pricePeriodCustom_c", "customDiscountValue_l", "customDiscountType_l",
"customDiscountAmount_l", "netPrice_l", "priceScore_l", "netAmount_l",
"contractListValue_l", "contractDiscount_l", "contractValue_l", "fulfillmentStatus_l",
"oRCL_ABO_ActionCode_l", "_document_number", "_model_id", "_model_is_valid",
"_chargeSetControl", "_is_coverage", "requestedUnitOfMeasure_l", "_parent_doc_number",
"_is_line_item_mandatory", "_parent_doc_number", "_is_line_item_mandatory",
"_parent_doc_number", "_is_line_item_mandatory"],
"expandedDomains": ["pricePeriod_l", "customDiscountType_l",
"fulfillmentStatus_l", "oRCL_ABO_ActionCode_l"]
}
}
],
"expandedDomains": []
},
"delta": true,
"documents": {},
"revisionId": "7,0"
}

Response Body

[Link] 75/222
9/15/25, 2:27 PM Commerce REST APIs
{
"revisionId": "8,0",
"documents": {
"_pp_id": 3023226565,
"approve_reject_icon_submit_t": null,
"fileAttachment_t": {
"fileName": null,
"fileType": null,
"fileID": null,
"isFileSaved": false,
"fileLocation":
"[Link]
ttachmentAttributes/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
},

[Link] 76/222
9/15/25, 2:27 PM Commerce REST APIs
"_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

[Link] 77/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_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":
"[Link]
ransactionLine"
}
],
"items": [{
"_document_number": 2,
"_chargeSet": {
"totalResults": 0,
"offset": 0,
"_state": {
"insertable": false,
"queryable": false,
"sortable": false,
"attributes": {
"_chargeSet_rateCardName": {
"visible": true
},

[Link] 78/222
9/15/25, 2:27 PM Commerce REST APIs
"_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
}
}
},

[Link] 79/222
9/15/25, 2:27 PM Commerce REST APIs
"limit": 1000,
"count": 0,
"hasMore": false,
"links": [{
"rel": "self",
"href":
"[Link]
ransactionLine/2/_chargeSet"
}
],
"items": []
},
"links": [{
"rel": "self",
"href":
"[Link]
ransactionLine/2"
}, {
"kind": "",
"rel": "child",
"name": "oRCL_charges",
"href":
"[Link]
ransactionLine/2/oRCL_charges"
}, {
"kind": "",
"rel": "child",
"name": "_availableRatePlanSet",
"href":
"[Link]
ransactionLine/2/_availableRatePlanSet"
}, {
"rel": "parent",
"href":
"[Link]
}
],
"_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
}
},

[Link] 80/222
9/15/25, 2:27 PM Commerce REST APIs
"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

[Link] 81/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_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

[Link] 82/222
9/15/25, 2:27 PM Commerce REST APIs
},
"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": {

[Link] 83/222
9/15/25, 2:27 PM Commerce REST APIs
"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
},

[Link] 84/222
9/15/25, 2:27 PM Commerce REST APIs
"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

[Link] 85/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_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 Lines

Create Transaction Lines

Use this endpoint to create transaction line items for the part items or models that are listed in the request
Description
body.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

POST
HTTP Method

Request Body _part_number The Part Number to be added to this transaction.

Parameters

[Link] 86/222
9/15/25, 2:27 PM Commerce REST APIs

Create Transaction Lines

Variable Name of the Price Book used to get the price for this line item.
_price_book_var_name

The quantity of parts to be added to this transaction.

_price_quantity

The JSON Transaction data

Response Body

Create Transaction Version

Create Transaction Version

Use this endpoint to create a new version of the specified transaction.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/versionTransaction_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria, documents,
Request Body
Parameters and revisionId.

Refer to Request Body Objects for additional information

The JSON data of the new transaction version

Success
Response

URI Endpoint Sample

[Link]
ions/versionTransaction_t

Response Body

[Link] 87/222
9/15/25, 2:27 PM Commerce REST APIs
{
"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":
"[Link]
tachmentAttributes/_eSignatureAttributeSet_esig_file_attachment/transactions/38892783/do
cumentNumbers/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,

[Link] 88/222
9/15/25, 2:27 PM Commerce REST APIs
"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,

[Link] 89/222
9/15/25, 2:27 PM Commerce REST APIs
"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",

[Link] 90/222
9/15/25, 2:27 PM Commerce REST APIs
"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": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_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,

[Link] 91/222
9/15/25, 2:27 PM Commerce REST APIs
"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":
"[Link]
tachmentAttributes/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,

[Link] 92/222
9/15/25, 2:27 PM Commerce REST APIs
"fileLocation":
"[Link]
tachmentAttributes/_esigTest_c_esig_file_attachment/transactions/38892783/documentNumber
s/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,

[Link] 93/222
9/15/25, 2:27 PM Commerce REST APIs
"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,

[Link] 94/222
9/15/25, 2:27 PM Commerce REST APIs
"totalMonthlyMarginAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_pp_name": "Default",
"status_t": {
"displayValue": "Created",
"value": "CREATED"
},
"transactionLine": {
"hasMore": false,
"links": [{
"rel": "self",
"href":
"[Link]
ansactionLine"
}
],
"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,

[Link] 95/222
9/15/25, 2:27 PM Commerce REST APIs
"_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"
},

[Link] 96/222
9/15/25, 2:27 PM Commerce REST APIs
"_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,

[Link] 97/222
9/15/25, 2:27 PM Commerce REST APIs
"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\",\"_pric
ingEngineRuleName\":\"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",

[Link] 98/222
9/15/25, 2:27 PM Commerce REST APIs
"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",
"parentDocNumber_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,

[Link] 99/222
9/15/25, 2:27 PM Commerce REST APIs
"_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"

[Link] 100/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_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,

[Link] 101/222
9/15/25, 2:27 PM Commerce REST APIs
"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":
"[Link]
ansactionLine/2"
}, {
"kind": "",
"rel": "child",
"name": "_chargeSet",
"href":
"[Link]
ansactionLine/2/_chargeSet"
}, {
"kind": "",
"rel": "child",
"name": "_availableRatePlanSet",
"href":
"[Link]
ansactionLine/2/_availableRatePlanSet"
}, {
"kind": "",
"rel": "child",
"name": "oRCL_charges",
"href":
"[Link]
ansactionLine/2/oRCL_charges"
}, {
"rel": "parent",
"href":
"[Link]
}
]
}
]
}
},
"warnings": {}
}

Create Transaction with Line Items

[Link] 102/222
9/15/25, 2:27 PM Commerce REST APIs

Create Transaction with Line Items

Use this endpoint to create a new transaction with parts and/or models as specified in the request
Description
payload.

/rest/v19/commerce{Stage}{ProcessVarName}{MainDocVarName}
URI Endpoint

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

POST
HTTP Method(s)

Request Body _currency_pref Currency preference

items The transaction lines to be included in the new transaction.

The JSON transaction data of the new transaction

Response Body

Notes
Notes:

When creating a transaction through a REST call, only a line item’s part number, quantity,
and Price Book can be given values. The line items’ Price Book only needs to be
declared when declaring the first line item in the payload. Other updateable sub-
document attributes can be given values through a subsequent POST call by invoking a
Commerce action.

Similar to behavior in the Oracle CPQ user interface, transactions created through REST
calls will exist in a temporary state until they are updated. In order to view a REST-call-
created transaction in the Transaction manager, a subsequent UPDATE call must be
made to update the transaction.

URI Endpoint Sample

[Link]

Request Sample

[Link] 103/222
9/15/25, 2:27 PM Commerce REST APIs
{
"_last_document_number" : "3",
"paymentTerms_t" : "",
"bs_id" : "36365444",
"_price_book_var_name" : "_default_price_book",
"totalOneTimeNetAmount_t" : "0",
"currentStepForTesting_tempDisplay_t" : "start_step",
"totalMonthlyDiscount_t" : "0",
"_customer_t_address" : "",
"_step_var_name" : null,
"_curr_reason_variable_name" : "",
"transactionName_t" : null,
"parent_transaction_id_versionTransaction_t" : "",
"_supplier_company_name" : "cpq",
"status_t" : "CREATED",
"approve_reject_icon_submit_t" : "",
"_document_link" : "",
"createdDate_t" : "2016-02-25 00:00:00",
"_customer_t_state" : "",
"_curr_reason_desc" : "",
"_document_number" : "1",
"requireApprovalIfChecked_temporary_t" : "false",
"opportunityName_t" : "",
"totalMonthlyNetAmount_t" : "0",
"_date_added" : "2016-02-25 12:19:07.0",
"_process_var_name" : "oraclecpqo",
"userKey_t" : "CPQ-63v12",
"_date_modified" : "2016-02-25 12:19:07.0",
"_customer_t_address_2" : "",
"taxExempt_t" : "false",
"totalAnnualValue_t" : "0",
"salesChannel_t" : "",
"approval_revision_submit_t" : "1",
"_id" : "36365444",
"_invoiceTo_t_last_name" : "",
"_invoiceTo_t_phone" : "",
"statusPartial_t" : "false",
"_invoiceTo_t_company_name" : "",
"_customer_t_city" : "",
"_customer_t_email" : "",
"createdBy_t" : "Super User",
"_customer_t_last_name" : "",
"priceExpirationDate_t" : "",
"lastPricedDate_t" : "2016-02-25 12:19:00",
"_curr_reason_name" : "",
"_invoiceTo_t_state" : "",
"_customer_t_first_name" : "",
"statusDate_t" : "",
"totalContractValue_t" : "0",
"_invoiceTo_t_address_2" : "",
"purchaseOrderNumber_t" : "",
"version_t" : "1",
"_invoiceTo_t_email" : "",
"approval_status_submit_t" : "",
"_customer_t_company_name_2" : "",
"opportunityID_t" : "",

[Link] 104/222
9/15/25, 2:27 PM Commerce REST APIs
"totalOneTimeDiscount_t" : "0",
"currency_t" : "USD",
"_document_var_name" : "transaction",
"hasRecurringPricing_t" : "false",
"_customer_t_zip" : "",
"_customer_t_company_name" : null,
"_invoiceTo_t_zip" : "",
"_invoiceTo_t_company_name_2" : "",
"totalMonthlyListAmount_t" : "0",
"taxExemptReason_t" : "",
"_buyer_company_name" : "cpq",
"_next_approver" : "",
"totalOneTimeListAmount_t" : "0",
"_submitted_by_submit_t" : "",
"_invoiceTo_t_address" : "",
"approval_history_submit_t" : "",
"_customer_t_fax" : "",
"_customer_t_phone" : "",
"_transaction_total" : "0",
"_invoiceTo_t_first_name" : "",
"lastUpdatedBy_t" : "Super User",
"priceWithinPolicy_t" : "true",
"owner_t" : "Super User",
"lastUpdatedDate_t" : "2016-02-25 12:19:00",
"_approve_reject_comment" : "",
"transactionID_t" : "CPQ-63",
"_currency_pref" : "USD",
"_submit_comment" : "",
"_invoiceTo_t_fax" : "",
"_curr_approver" : "",
"version_number_versionTransaction_t" : null,
"_customer_t_country" : "",
"_invoiceTo_t_city" : "",
"_invoiceTo_t_country" : "",
"transactionLine" : {
"items" : [ {
"_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" : "",
"_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",

[Link] 105/222
9/15/25, 2:27 PM Commerce REST APIs
"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 12:19:07.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 12:19:07",
"_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",

[Link] 106/222
9/15/25, 2:27 PM Commerce REST APIs
"_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" : "",
"_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" : [ {

[Link] 107/222
9/15/25, 2:27 PM Commerce REST APIs
"rel" : "self",
"href" :
"[Link]
ansactionLine/2"
}, {
"rel" : "parent",
"href" :
"[Link]
} ]
}, {
"_part_custom_field29" : "",
"_price_book_var_name" : "_default_price_book",
"_model_attributes" : "",
"_model_bom" : "",
"_part_supplier_company_id" : "4118171",
"_price_item_price_each" : "300",
"annualValue_l" : "",
"_price_total_discount" : "0",
"_config_attributes" : "",
"_price_list_price_each" : "300",
"statusQuantity_l" : null,
"_part_custom_field30" : "",
"requestedUnitOfMeasure_l" : "",
"_original_document_number" : "-1",
"status_l" : null,
"requestedQuantity_l" : "1",
"costAmount_l" : "167",
"createdDate_l" : "2016-02-25 12:19:00",
"pricePeriod_l" : "",
"_part_id" : "36285591",
"customDiscountAmount_l" : "0",
"priceType_l" : "One Time",
"_price_component_prices" : "",
"_part_supplier_company_name" : "pm",
"_document_number" : "3",
"_is_line_item_mandatory" : "false",
"_reconfiguration_date" : "1970-01-01 00:00:00",
"_price_unit_price_each" : "300",
"_config_attr_info" : "",
"_price_configurable_price" : "300",
"taxExempt_l" : "false",
"_date_added" : "2016-02-25 12:19:07.0",
"displayedItemName_l" : "Blue Hat Enterprise Linux 6 Server Self-Support",
"_document_number9" : "",
"_date_modified" : "2016-02-25 12:19:07.0",
"_parent_line_item" : "",
"_model_segment_name" : "",
"canChangeQuantity_l" : "false",
"_price_subtotal" : "300",
"_part_desc" : "Blue Hat Enterprise Linux 6 Server Self-Support",
"_is_part_pricing_rule_price" : "false",
"_model_id" : "",
"_partner_entity_id" : "",
"_config_attr_text" : "",
"_id" : "36365447",
"_part_units" : "",

[Link] 108/222
9/15/25, 2:27 PM Commerce REST APIs
"_model_product_line_id" : "",
"statusDate_l" : null,
"statusPartial_l" : "false",
"createdBy_l" : "Super User",
"customDiscountValue_l" : null,
"_last_modified_date" : "2016-02-25 12:19:07",
"_price_discount_comment" : "",
"_model_product_line_name" : "",
"_price_override_discount" : "None",
"_part_drawing_position" : "",
"itemInstanceId_l" : "",
"netPrice_l" : "300",
"_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" : "167",
"_part_direct_buy" : "1",
"_pricing_rule_price_each" : "0",
"_model_variable_name" : "",
"_part_number" : "AS00105",
"_document_var_name" : "transactionLine",
"_model_supplier_company_name" : "",
"_bs_id" : "36365444",
"_price_override_quantity" : "false",
"_price_net_price" : "300",
"netAmount_l" : "300",
"_line_item_spare_rule_var_name" : "",
"listPrice_l" : "300",
"customDiscountType_l" : "%",
"_part_custom_field12" : "",
"_part_custom_field13" : "Yes",
"taxExemptReason_l" : "",
"_part_custom_field10" : "",
"lastUpdatedBy_l" : "Super User",
"lineNumber_l" : "",
"_part_custom_field11" : "",
"_part_custom_field16" : "",
"_part_custom_field17" : "",
"_part_custom_field14" : "SVR",
"_part_custom_field15" : "",
"_model_base_price" : "",
"_line_item_comment" : "",
"_parent_doc_number" : "",
"parentLineNumber_l" : "",
"_part_custom_field2" : "",
"listAmount_l" : "300",
"_model_product_line_attributes" : "",
"canChangeConfiguration_l" : "false",
"_part_custom_field1" : "Software",
"_part_custom_field4" : "",
"_part_custom_field3" : "16",
"priceWithinPolicy_l" : "true",

[Link] 109/222
9/15/25, 2:27 PM Commerce REST APIs
"customerItemName_l" : "",
"_part_custom_field6" : "253214",
"_model_name" : "",
"_part_custom_field5" : "167.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" : "50",
"lastUpdatedDate_l" : "",
"contractValue_l" : "",
"_part_custom_field20" : "",
"_part_base_price" : "300",
"_is_recommended_price" : "false",
"_part_custom_field19" : "",
"_part_custom_field18" : "[Link]
build/image/Vision/bh_self.jpg",
"_part_extended_desc_1" : "",
"_part_lead_time" : "N/A",
"_price_override_price" : "No",
"_part_extended_desc_2" : "",
"links" : [ {
"rel" : "self",
"href" :
"[Link]
ansactionLine/3"
}, {
"rel" : "parent",
"href" :
"[Link]
} ]
} ],
"links" : [ {
"rel" : "self",
"href" :
"[Link]
ansactionLine"
} ]
},
"links" : [ {
"rel" : "self",
"href" :
"[Link]
} ]
}

Create Transaction without Line Items

[Link] 110/222
9/15/25, 2:27 PM Commerce REST APIs

Create Transaction without Line Items

Use this endpoint to create a new transaction without any line items.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/actions/_new_transaction

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

POST
HTTP Method(s)

Request Body This endpoint supports the following optional parameters: cacheInstanceId, criteria, documents,
partnerInfo, and revisionId.

Refer to Request Body Objects for additional information

The JSON transaction data of the new transaction

Response Body

URI Endpoint Sample

[Link]
_transaction

Response Sample

[Link] 111/222
9/15/25, 2:27 PM Commerce REST APIs
{
"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":
"[Link]
tachmentAttributes/_eSignatureAttributeSet_esig_file_attachment/transactions/38892736/do
cumentNumbers/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,

[Link] 112/222
9/15/25, 2:27 PM Commerce REST APIs
"_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,

[Link] 113/222
9/15/25, 2:27 PM Commerce REST APIs
"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"

[Link] 114/222
9/15/25, 2:27 PM Commerce REST APIs
},
"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": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_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"
},

[Link] 115/222
9/15/25, 2:27 PM Commerce REST APIs
"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":
"[Link]
tachmentAttributes/fileAttachment_t/transactions/38892736/documentNumbers/1"

[Link] 116/222
9/15/25, 2:27 PM Commerce REST APIs
},
"_soldTo_t_address_2": null,
"invoiceToPartyID_t": null,
"_esigTest_c_esig_file_attachment": {
"fileName": null,
"fileType": null,
"fileID": null,
"isFileSaved": false,
"fileLocation":
"[Link]
tachmentAttributes/_esigTest_c_esig_file_attachment/transactions/38892736/documentNumber
s/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,

[Link] 117/222
9/15/25, 2:27 PM Commerce REST APIs
"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"
},

[Link] 118/222
9/15/25, 2:27 PM Commerce REST APIs
"_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":
"[Link]
ansactionLine"
}
],
"items": []
}
},
"warnings": {}
}

Delete Archived Transactions

Delete Archived Transactions

Use this endpoint to delete the specified archived transactions.

Description

Note: This action is only available for Application Administrators.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/actions/_delete_archived_transactions

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 119/222
9/15/25, 2:27 PM Commerce REST APIs

Delete Archived Transactions

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

selectionCriteria An array of archived transaction id items to be deleted.

Request Body
Parameters

POST
HTTP Method

204 No Content
Success
Response

URI Endpoint Sample

[Link]
ete_archived_transactions

Request Sample

{
"selectionCriteria": {
"ids": [19403637, 19403536, 19401289, 19397409, 19397331, 19397252, 19397175,
19396957, 19396878, 19396429, 19395774, 19395679, 19395605, 19385048, 19384977]
}
}

Delete Transaction Line

Delete Transaction Line

Use this endpoint to delete the specified transaction line.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

[Link] 120/222
9/15/25, 2:27 PM Commerce REST APIs

Delete Transaction Line

docNumber The sub-document number

DELETE
HTTP Method

None
Request Body
Parameters

204 No Content
Success
Response

Delete Transaction Lines

Delete Transaction Lines

Use this endpoint to delete the specified transaction line(s) from a transaction.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_remove_transactionLine

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

selections Required, this parameter is used for transaction level actions that support line
Request Body
selection. Selection items are an array of transactionLine/{docNumber}
Parameters
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

POST
HTTP Method

The JSON Transaction data

Response Body
Parameters

[Link] 121/222
9/15/25, 2:27 PM Commerce REST APIs

URI Endpoint Sample

[Link]
/_remove_transactionLine

Request Sample

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

Drop Cache (Commerce)

Drop Cache (Commerce)

Use this endpoint to eliminate the cache created through REST web services. Drop Cache can improve
Description
site performance by removing cached objects that would otherwise remain in memory for the duration of
the timeout specified in administration.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_dropCache

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

cacheInstanceId The cache instance ID

Request Body
Parameters

The requested cache instance is cleared.

Response Body
Parameters

URI Endpoint Sample

[Link]
ions/_dropCache

Request Sample

{"cacheInstanceId": "E9JuyC9QCgTDS9edghTNxRGOVUm34EMR7RJt9alFbkGTN0X5byTjHGRu1CxrSl1p"}

Email - Generate Transaction Email

[Link] 122/222
9/15/25, 2:27 PM Commerce REST APIs

Email - Generate Transaction Email

Use this endpoint to retrieve the objects required to send a transaction email.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_action_process_email_print

Endpoint Stage The stage variable identifies where a transaction is within

Parameters the Commerce process flow. (Documents, Quotes,
Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the

first letter must be capitalized.

MainDocVarName The variable name of the main document, note the first
letter must be capitalized.

id The commerce transaction Id. This is the unique identifier

for a transaction within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
Request Body
Parameters documents, revisionId. Refer to Request Body Objects for additional information

Specify one of the following parameters to filter the returned XSL views by the specified language:

languageAttributeValue - Language attribute value for the print document (from Get Sales
Company User REST API)

languageNumber - Language attribute value for the print document (from Get Sales Company User
REST API)

languagePreference – Language attribute value for the print document

Note: XSL views associated for Multi language templates are always returned irrespective of the
language filter specified in the request payload.

attachments Attachments to send with the email

Response
Body
Parameters availableAttachmentsForMerge The list of attachments which can be merged with the
proposal document

bccEmail bcc email address(es)

cacheInstanceId The cache instance ID, if requested

ccEmail cc email address(es)

comments Comments to be sent in the email body

[Link] 123/222
9/15/25, 2:27 PM Commerce REST APIs

Email - Generate Transaction Email

fromEmail The sender's email address

fromName The sender's name

generatedProposalAttachmentForMerge The proposal attachment selected by default. The default

ID value for the transaction is -2.

revisionId The revision Id of the transaction

subject The email subject line

toEmail The recipient's email address(es)

toName The recipient's name

warnings Warning messages

xslViews The list of all XSL Views selected for the Process level
email action in Admin UI.

id - the Id for the attachment

isAvaialbleForMerge - This value will be true

for XSL views that support merging of file
attachments

name - the name for the attachment

URI Endpoint Sample

[Link]
ions/_action_process_email_print

Response Body Sample

[Link] 124/222
9/15/25, 2:27 PM Commerce REST APIs
{
"comments": "",
"attachments": null,
"ccEmail": "",
"availableAttachmentsForMerge": [{
"id": 3023140360,
"name": "Attachment [Link] (Transaction - attachment 1)"
}
],
"subject": "",
"warnings": {},
"fromEmail": "myemail@[Link]",
"xslViews": [{
"id": 3023140083,
"name": "english tempalte pdf output(Printer Friendly/History)",
"isMergeAttachmentSupported": true
}, {
"id": 3023140134,
"name": "English Document DOCX Ouput(Printer Friendly/History)",
"isMergeAttachmentSupported": false
}
],
"revisionId": "46,0",
"bccEmail": "",
"generatedProposalAttachmentForMerge": [{
"id": -2,
"name": "GENERATED PROPOSAL"
}
],
"toName": null,
"fromName": null,
"toEmail": ""
}

Email - Send Transaction Email

Email - Send Transaction Email

Use this endpoint to collect email form data, generates the attachment, pushes the email to SMTP
Description
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.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_send_email

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 125/222
9/15/25, 2:27 PM Commerce REST APIs

Email - Send Transaction Email

id The commerce transaction Id. This is the unique identifier for a

transaction within an Oracle CPQ site.

POST
HTTP Method

actionVariableName The email action variable name used to generate the email
Request Body
Parameters
attachments An array if attachment ID items

attachmentIdsForMerge The attachment IDs to merge

bccEmail bcc email address(es)

cacheInstanceId The cache instance ID

ccEmail cc email address(es)

comments Comments to be sent in the email body

fromName The sender's name

languageCode The language preference for sending email

subject The email subject line, this parameter is required to send email

toEmail The recipient's email address(es), this parameter is required to send

email

toName The recipient's name

xslView Printer friendly proposals or history outputs generated from predefined

XSL templates

JSON with summary message for sending email

Response Body
Parameters

URI Endpoint Sample

[Link]
ions/_send_email

Request Body Sample

[Link] 126/222
9/15/25, 2:27 PM Commerce REST APIs
{
"actionVariableName": "_action_process_email_print",
"comments": "test comments",
"ccEmail": "",
"toName": "Test To Name",
"subject": "Test subject",
"fromName": "Test From Name",
"toEmail": "test@[Link]",
"languageCode": "en",
"xslView": "3023146476",
"attachmentIdsForMerge": ["-2", "3023146599", "3023146600"]
}

Response Body Sample

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

eSignature - Cancel Request

eSignature - Cancel Request

Use this endpoint to cancel a pending eSignature request.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_action_esig_cancel

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body esigAttrSetVarName Variable name of the eSignature attribute set

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.

[Link] 127/222
9/15/25, 2:27 PM Commerce REST APIs

eSignature - Cancel Request

The JSON data for the requested transaction, or a subset of transaction items, depending on the input
Response Body
request.
Parameters

URI Endpoint Sample

[Link]
ions/_action_esig_cancel

Sample Request Body

{
"esigAttrSetVarName": "eSignatureAttributeSet1_esig_set",
"documents": {
"_eSignatureAttributeSet1_esig_recipients": "John Doe<[Link]@[Link]>;",
"quoteDescription": "abcquote",
"_eSignatureAttributeSet1_esig_file_attachment": {
"fileID": "20600546",
"fileType": "application/[Link]-
[Link]",
"isFileSaved": false,
"fileName": "[Link]"
},
"criteria": {
"state": true,
"childDefs": [{
"name": "lineItem",
"queryDef": {
"state": true
}
}
]
}
}
}

Sample Response Body

[Link] 128/222
9/15/25, 2:27 PM Commerce REST APIs
{
"documents": {
"_eSignatureAttributeSet1_esig_recipients": "John Doe<[Link]@[Link]>;",
"_eSignatureAttributeSet1_esig_file_attachment": {
"fileID": "20600546",
"fileType": "application/[Link]-
[Link]",
"isFileSaved": false,
"fileName": "[Link]"
},
"_eSignatureAttributeSet1_esig_envelope_id": null,
"_eSignatureAttributeSet1_esig_date_modified": "2018-03-11T20:28:44Z",
"_eSignatureAttributeSet1_esig_status": {
"value": "Cancelled",
"displayValue": "Cancelled"
},
"sub": {},
"links": [{
"rel": "self",
"href": "../rest/v19/commerceDocumentsTestMain/20905405"
}
],
"_state": {}
},
"warnings": {}
}

eSignature - Request Details

eSignature - Request Details

Use this endpoint to connect and view the eSignature related details from an integrated site, such as
Description
DocuSign.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_action_esig_details

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

[Link] 129/222
9/15/25, 2:27 PM Commerce REST APIs

eSignature - Request Details

Request Body esigAttrSetVarName Variable name of the eSignature attribute set

Parameters
This operation supports the following optional parameters: cacheInstanceId, criteria, delta,
documents, and revisionId, selections, selectionMode, and skipIntegration.

The JSON data for the requested transaction, or a subset of transaction items, depending on the input
Response Body
request.
Parameters

URI Endpoint Sample

[Link]
ions/_action_esig_details

Sample Request Body

{
"esigAttrSetVarName": "eSignatureAttributeSet1_esig_set",
"documents": {
"_eSignatureAttributeSet1_esig_recipients": "John Doe<[Link]@[Link]>;",
"quoteDescription": "abcquote",
"_eSignatureAttributeSet1_esig_file_attachment": {
"fileID": "20600546",
"fileType": "application/[Link]-
[Link]",
"isFileSaved": false,
"fileName": "[Link]"
},
"criteria": {
"state": true,
"childDefs": [{
"name": "lineItem",
"queryDef": {
"state": true
}
}
]
}
}
}

Sample Response Body

{
...
"destinationNewWindowURL": "[Link]
StartConsole=1&t=4afcbf24-2808-4e61-8107-496f7bd9410b&DocuEnvelope=95f8dd4d-af4c-47b4-
87ec-d0c523989385"
...
}

eSignature - Send Request

[Link] 130/222
9/15/25, 2:27 PM Commerce REST APIs

eSignature - Send Request

Use this endpoint to send eSignature documents to recipients.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_action_esig_send

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body esigAttrSetVarName Variable name of the eSignature attribute set

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.

The JSON data for the requested transaction, or a subset of transaction items, depending on the input
Response Body
request.
Parameters

URI Endpoint Sample

[Link]
ions/_action_esig_send

Sample Request Body

[Link] 131/222
9/15/25, 2:27 PM Commerce REST APIs
{
"esigAttrSetVarName": "eSignatureAttributeSet1_esig_set",
"documents": {
"_eSignatureAttributeSet1_esig_recipients": "John Doe<[Link]@[Link]>;",
"quoteDescription": "abcquote",
"_eSignatureAttributeSet1_esig_file_attachment": {
"fileID": "20600546",
"fileType": "application/[Link]-
[Link]",
"isFileSaved": false,
"fileName": "[Link]"
},
"criteria": {
"state": true,
"childDefs": [{
"name": "lineItem",
"queryDef": {
"state": true
}
}
]
}
}
}

Sample Response Body

{
"documents": {
"_eSignatureAttributeSet1_esig_recipients": "John Doe<[Link]@[Link]>;",
"_eSignatureAttributeSet1_esig_file_attachment": {
"fileID": "20600546",
"fileType": "application/[Link]-
[Link]",
"isFileSaved": false,
"fileName": "[Link]"
},
"_eSignatureAttributeSet1_esig_envelope_id": "5d28d6ca-0f7d-41d4-a1f1-
fa12184a7b07",
"_eSignatureAttributeSet1_esig_date_modified": "2018-03-11T20:16:44Z",
"_eSignatureAttributeSet1_esig_status": {
"value": "Pending",
"displayValue": "Pending"
},
"quoteDescription": "abcquote",
"sub": {},
"links": [{
"rel": "self",
"href": "../rest/v19/commerceDocumentsOraclecpqoTransaction/20563735"
}
],
"_state": {}
},
"warnings": {}
}

[Link] 132/222
9/15/25, 2:27 PM Commerce REST APIs

Export Transaction Attachment

Export Transaction Attachment

Use this endpoint to export an Oracle CPQ generated document.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/exportAttachment

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This operation supports the following optional parameters: cacheInstanceId, criteria, delta,
Request Body
Parameters documents, revisionId, selections, selectionMode, and skipIntegration.
Refer to Request Body Objects for additional information.

The JSON Transaction Data

Response Body
Parameters

URI Endpoint Sample

[Link]
ions/exportAttachment

Request Body Sample

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

Export Transaction
[Link] 133/222
9/15/25, 2:27 PM Commerce REST APIs

Export Transactions

Use this endpoint to export an Oracle CPQ generated document.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/export_transactions

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

POST
HTTP Method

selectionCriteria Captures the query definition for resource requests, specifically for collection-
Request Body
based process actions.
Parameters

The JSON Transaction Data

Response Body
Parameters

URI Endpoint Sample

[Link]
rt_transactions

Request Body Sample

{
"selectionCriteria": {
"search": "_my_approval_search",
"orderby": ["_id:desc", "searchViewName:asc"],
"fields": ["_id", "_lock_status", "bs_id", "processManagerFloat"]
}
}

Response Body Sample

{
"warnings": {},
"fileUrl": "[Link]
}

Forward Transactions

[Link] 134/222
9/15/25, 2:27 PM Commerce REST APIs

Forward Transactions

Use this endpoint to forward selected transactions to the specified users and/or groups.
Description

/rest/v19/commerce{Stage}{ProcessVarName}{MainDocVarName}/actions/_forward
URI Endpoint

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

company The company name

Request Body
Parameters
ids The list of transactions that are forwarded to user / groups

salesGroups List of sales groups to forward the transaction to

salesUsers List of sales use logins to forward the transaction to

POST
HTTP Method

Quick registration - buy type users cannot be targeted using this endpoint,

URI Endpoint Sample

[Link]
ward

Request Sample

{
"ids": [18007731, 18007790, 18005157],
"company": "company123,
"salesGroups": [group1, group2, group3],
"salesUsers": []
}

Generate Proposal

Generate Proposal

Use this endpoint to generate a file of the proposal document by merging the associated printer-friendly XSL
Description
document with the current transaction details.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/generateProposal

[Link] 135/222
9/15/25, 2:27 PM Commerce REST APIs

Generate Proposal

Endpoint Stage The stage variable identifies where a transaction is within

Parameters the Commerce process flow. (Documents, Quotes,
Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the

first letter must be capitalized.

MainDocVarName The variable name of the main document, note the first
letter must be capitalized.

id The commerce transaction Id. This is the unique

identifier for a transaction within an Oracle CPQ site.

POST
HTTP Method

Request Body This operation supports the following optional parameters: cacheInstanceId, criteria, delta,
Parameters documents, revisionId, selections, selectionMode, and skipIntegration.
Refer to Request Body Objects for additional information.

documents JSON data for the transaction

Response Body
Parameters
xslView Printer friendly proposals or history outputs generated
from predefined XSL templates

fileAttachmentAttribute The file attachment attribute used of confirmation

generatedProposalAttachmentForMerge The default selected attachment for an email or print

action

cacheInstanceId The unique identifier for the entry of transaction data

stored in the cache. This typically is obtained from first
createTransaction or OpenTransaction action and
passed along in subsequent Modify/Interact action to
avoid reload transaction data from db.

availableAttachmentsfoMerge A list of attachments available to merge for an email or

print action

URI Endpoint Sample

[Link]
ctions/generateProposal

Request Sample

{
"documents": {}
}

Response Sample

[Link] 136/222
9/15/25, 2:27 PM Commerce REST APIs
{
"revisionId": "11,0",
"generatedProposalAttachmentForMerge": [{
"id": -2,
"name": "GENERATED PROPOSAL"
}
],
"documents": {
"_pp_id": 3023259033,
"approve_reject_icon_submit_t": null,
"fileAttachment_t": {
"fileName": null,
"fileType": null,
"fileID": null,
"isFileSaved": false,
"fileLocation":
"[Link]
ttachmentAttributes/fileAttachment_t/transactions/3023286655/documentNumbers/1"
},
"approval_history_submit_t": null,
"approval_status_submit_t": null,
"_s_signedProposalDocument_t": {
"fileName": "Document (4).pdf",
"fileType": "application/pdf",
"fileID": "3023286673",
"isFileSaved": true,
"fileLocation":
"[Link]
ttachmentAttributes/_s_signedProposalDocument_t/transactions/3023286655/documentNumbers/
1"
},
"_step_var_name": "pending_process",
"_id": 3023286655,
"_pp_name": "Admin",
"transactionLine": {
"totalResults": 0,
"offset": 0,
"limit": 10,
"count": 0,
"hasMore": false,
"links": [{
"rel": "self",
"href":
"[Link]
ransactionLine"
}
],
"items": []
}
},
"xslView": "Document(Printer Friendly/History)",
"availableAttachmentsForMerge": [{
"id": 3023286673,
"name": "Document (4).pdf (Transaction - Signed Proposal Document)"
}
],

[Link] 137/222
9/15/25, 2:27 PM Commerce REST APIs
"warnings": {},
"langAttributeValue": -1,
"cacheInstanceId": "hZ6d7XDIYs0q9zUuI98949xMHBJTehNxIeKirMrb9CLedxKTnU1e1MLNnJWJfnlF",
"fileAttachmentAttribute": "File Attachment"
}

Get Archived Transactions

Get Archived Transactions

Use this endpoint to retrieve a list of archived transactions.

Description

Note: This action is only available for CPQ administrators with Application Administrator
permission.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/actions/_get_archived_transactions

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

criteria The criteria object supports the following parameters to retrieve specific
Request Body
content and limit the size of the response.
Parameters
actions, childDefs, enableHierarchy, excludeFieldTypes,
expand, fields, groups, limit, offset, orderby, q, state, and
totalResults.

Refer to Criteria Object for additional information.

POST
HTTP Method

The JSON data for the requested archived transactions.

Response Body
Parameters

URI Endpoint Sample

[Link]
_archived_transactions

Request Sample

[Link] 138/222
9/15/25, 2:27 PM Commerce REST APIs
{
"criteria": {
"orderby": ["_id:DESC"],
"totalResults": true,
"limit": 2,
"offset": 0
}
}

Response Sample

[Link] 139/222
9/15/25, 2:27 PM Commerce REST APIs
{
"documents": {
"offset": 0,
"limit": 2,
"count": 2,
"hasMore": true,
"items": [{ {
"documents": {
"totalResults": 3,
"offset": 0,
"limit": 2,
"count": 2,
"hasMore": true,
"items": [{
"totalOneTimeListAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_locked_by_user_login": null,
"lastUpdatedDate_t": "2024-05-22T21:15:00Z",
"_document_var_name": "transaction",
"lastPricedDate_t": "2024-05-22T21:11:00Z",
"_customer_id": "300100122967029",
"_customer_t_company_name": "Vision Development US)",
"totalAnnualValue_t": {
"value": 0.0,
"currency": "USD"
},
"totalContractValue_t": {
"value": 0.0,
"currency": "USD"
},
"_locked_time": null,
"createdDate_t": "2024-05-22",
"_date_modified": "2024-06-09T15:11:09.000Z",
"_last_document_number": 6,
"_date_added": "2024-06-09T15:11:09.000Z",
"transactionName_t": "05/22 Vision Development US)",
"_id": 38780366,
"_pp_id": null,
"owner_t": "Albert M",
"_process_var_name": "oraclecpqo",
"_locked_by_user_first_name": null,
"_step_var_name": "pending_process",
"totalOneTimeNetAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_lock_status": null,
"totalMonthlyListAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_locked_by_user_last_name": null,
"version_t": 1,
"transactionID_t": "CPQ-90124B",

[Link] 140/222
9/15/25, 2:27 PM Commerce REST APIs
"_buyer_company_name": "cpq-techwriter1",
"totalMonthlyDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"_date_tx_modified": "2024-05-22T21:15:57.000Z",
"_supplier_company_name": "cpq-techwriter1",
"_locked_by_user": null,
"version_number_versionTransaction_t": "1",
"_currency_pref": {
"id": 5190368,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_pp_name": null,
"priceWithinPolicy_t": true,
"totalOneTimeDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"status_t": {
"value": "CREATED",
"displayValue": "Created"
},
"totalMonthlyNetAmount_t": {
"value": 0.0,
"currency": "USD"
}
}, {
"totalOneTimeListAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_locked_by_user_login": null,
"lastUpdatedDate_t": "2024-05-22T21:05:00Z",
"_document_var_name": "transaction",
"lastPricedDate_t": "2024-05-06T21:32:00Z",
"_customer_id": "300100122967029",
"_customer_t_company_name": "Vision Development US)",
"totalAnnualValue_t": {
"value": 0.0,
"currency": "USD"
},
"totalContractValue_t": {
"value": 0.0,
"currency": "USD"
},
"_locked_time": null,
"createdDate_t": "2024-05-06",

[Link] 141/222
9/15/25, 2:27 PM Commerce REST APIs
"_date_modified": "2024-06-09T15:11:19.000Z",
"_last_document_number": 3,
"_date_added": "2024-06-09T15:11:19.000Z",
"transactionName_t": "05/06 Vision Development US)",
"_id": 38736262,
"_pp_id": null,
"owner_t": "Albert M",
"_process_var_name": "oraclecpqo",
"_locked_by_user_first_name": null,
"_step_var_name": "pending_process",
"totalOneTimeNetAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_lock_status": null,
"totalMonthlyListAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_locked_by_user_last_name": null,
"version_t": 1,
"transactionID_t": "CPQ-90024B",
"_buyer_company_name": "cpq-techwriter1",
"totalMonthlyDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"_date_tx_modified": "2024-05-22T21:06:23.000Z",
"_supplier_company_name": "cpq-techwriter1",
"_locked_by_user": null,
"version_number_versionTransaction_t": "1",
"_currency_pref": {
"id": 5190368,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_pp_name": null,
"priceWithinPolicy_t": true,
"totalOneTimeDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"status_t": {
"value": "CREATED",
"displayValue": "Created"
},
"totalMonthlyNetAmount_t": {
"value": 0.0,
"currency": "USD"

[Link] 142/222
9/15/25, 2:27 PM Commerce REST APIs
}
}
]
}
}
"totalOneTimeListAmount_t": {
"value": 5899.0,
"currency": "USD"
},
"_locked_by_user_login": null,
"lastUpdatedDate_t": "2024-02-02T17:47:00Z",
"_document_var_name": "transaction",
"lastPricedDate_t": "2024-02-02T13:28:00Z",
"_customer_id": "300100122967029",
"_customer_t_company_name": "Vision Development US)",
"totalAnnualValue_t": {
"value": 612.0,
"currency": "USD"
},
"totalContractValue_t": {
"value": 6511.0,
"currency": "USD"
},
"_locked_time": null,
"createdDate_t": "2024-02-02",
"_date_modified": "2024-06-09T15:11:26.000Z",
"_last_document_number": 6,
"_date_added": "2024-06-09T15:11:26.000Z",
"transactionName_t": "02/02 Vision Development US)",
"_id": 38642415,
"_pp_id": null,
"owner_t": "Albert M",
"_process_var_name": "oraclecpqo",
"_locked_by_user_first_name": null,
"_step_var_name": "pending_process",
"totalOneTimeNetAmount_t": {
"value": 5899.0,
"currency": "USD"
},
"_lock_status": null,
"totalMonthlyListAmount_t": {
"value": 306.0,
"currency": "USD"
},
"_locked_by_user_last_name": null,
"version_t": 1,
"transactionID_t": "CPQ-89924B",
"_buyer_company_name": "cpq-techwriter1",
"totalMonthlyDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"_date_tx_modified": "2024-05-17T20:49:31.000Z",
"_supplier_company_name": "cpq-techwriter1",
"_locked_by_user": null,
"version_number_versionTransaction_t": "1",

[Link] 143/222
9/15/25, 2:27 PM Commerce REST APIs
"_currency_pref": {
"id": 5190368,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_pp_name": null,
"priceWithinPolicy_t": true,
"totalOneTimeDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"status_t": {
"value": "CREATED",
"displayValue": "Created"
},
"totalMonthlyNetAmount_t": {
"value": 306.0,
"currency": "USD"
}
}, {
"totalOneTimeListAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_locked_by_user_login": null,
"lastUpdatedDate_t": "2024-05-22T21:05:00Z",
"_document_var_name": "transaction",
"lastPricedDate_t": "2024-05-06T21:32:00Z",
"_customer_id": "300100122967029",
"_customer_t_company_name": "Vision Development US)",
"totalAnnualValue_t": {
"value": 0.0,
"currency": "USD"
},
"totalContractValue_t": {
"value": 0.0,
"currency": "USD"
},
"_locked_time": null,
"createdDate_t": "2024-05-06",
"_date_modified": "2024-06-09T15:11:19.000Z",
"_last_document_number": 3,
"_date_added": "2024-06-09T15:11:19.000Z",
"transactionName_t": "05/06 Vision Development US)",
"_id": 38736262,
"_pp_id": null,
"owner_t": "Albert M",
"_process_var_name": "oraclecpqo",
"_locked_by_user_first_name": null,

[Link] 144/222
9/15/25, 2:27 PM Commerce REST APIs
"_step_var_name": "pending_process",
"totalOneTimeNetAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_lock_status": null,
"totalMonthlyListAmount_t": {
"value": 0.0,
"currency": "USD"
},
"_locked_by_user_last_name": null,
"version_t": 1,
"transactionID_t": "CPQ-90024B",
"_buyer_company_name": "cpq-techwriter1",
"totalMonthlyDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"_date_tx_modified": "2024-05-22T21:06:23.000Z",
"_supplier_company_name": "cpq-techwriter1",
"_locked_by_user": null,
"version_number_versionTransaction_t": "1",
"_currency_pref": {
"id": 5190368,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_pp_name": null,
"priceWithinPolicy_t": true,
"totalOneTimeDiscount_t": {
"value": 0.0,
"currency": "USD"
},
"status_t": {
"value": "CREATED",
"displayValue": "Created"
},
"totalMonthlyNetAmount_t": {
"value": 0.0,
"currency": "USD"
}
}
]
}
}

Get History

[Link] 145/222
9/15/25, 2:27 PM Commerce REST APIs

Get History

Use this endpoint to retrieve historical changes for a transaction using criteria defined in the request body.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/{displayHistoryActionVarName}

Endpoint Stage The stage variable identifies where a transaction is within the
Parameters Commerce process flow. (Documents, Quotes, Agreements, or
Orders)

ProcessVarName The variable name of the commerce process, note the first letter
must be capitalized.

MainDocVarName The variable name of the main document, note the first letter
must be capitalized.

id The commerce transaction Id. This is the unique identifier for a

transaction within an Oracle CPQ site.

displayHistoryActionVarName The variable name of the Display History type action.

POST
HTTP Method

criteria Used to specify query parameters for the history response

Request Body
Parameters Refer to Request Body Criteria, Resources, and Sample for
more information.

This operation supports the following optional parameters: cacheInstanceId and revisionId.
Refer to Request Body Objects for additional information.

JSON data containing the transaction history

Response Body
Parameters

URI Endpoint Sample

[Link]
ions/getHistory

Request Body Resources, Examples, and Sample

Resources

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, docNumber, oldValue, newValue

[Link] 146/222
9/15/25, 2:27 PM Commerce REST APIs

Examples

history

"q": "{\"userLogin\":{\"$eq\" : \"superuser\"}}"

"q": "{ $or: [ { \"userLogin\": { $eq: \"superuser\" }}, { \"actionVarName\": { $eq:

\"_update_line_items\" }} ] }"

"q": "{\"actionVarName\":{\"$exists\" : true}}"

"q":"{\"changeDate\":{\"$lt\":\"2020-06-30\"}}"

historyItem

"q": "{\"attrVarName\":{\"$eq\" : \"autoUpdateHidingConditionSubDoc\"}}"

"q": "{\"attrName\":{\"$eq\" : \"Price Book Custom Field Text\"}}"

Request Body Sample

{
"cacheInstanceId": "-1",
"criteria": {
"childDefs": [{
"name": "historyHeader",
"queryDef": {
"fields": [
"dateFormat", "_history_header_key"
],
"childDefs": [{
"name": "history",
"queryDef": {
"limit": 1000,
"offset": 0,
"fields": [
"_history_key", "actionName", "actionVarName", "changeDate",
"userLogin", "userFirstName", "userLastName", "userCompany", "stepVarName", "saved",
"resetReason", "performComment", "reasonVarName"],
"childDefs": [{
"name": "historyItem",
"queryDef":
{
"limit": 1000,
"offset": 0,
"fields": ["attrName", "attrVarName", "docNumber", "oldValue",
"newValue", "_history_item_key"]
}
}
]
}
}
]
}
}
]
}
}

Response Body Sample

[Link] 147/222
9/15/25, 2:27 PM Commerce REST APIs
{
"revisionId": "6,1",
"documents": {
"_id": 3023033799,
"historyHeader": {
"hasMore": false,
"items": [{
"dateFormat": "MM/dd/yyyy h:mm a",
"_history_header_key": 1,
"history": {
"offset": 0,
"limit": 1000,
"count": 1,
"hasMore": false,
"items": [{
"_history_key": 3023040162,
"actionName": "Save",
"actionVarName": "saveWithAdvancedValidation",
"changeDate": "06/13/2023 6:30 p",
"userLogin": "superuser",
"userFirstName": "Super",
"userLastName": "User",
"userCompany": "cpqqa212",
"stepVarName": "start_step",
"saved": null,
"resetReason": null,
"performComment": "-N/A-",
"reasonVarName": null,
"historyItem": {
"offset": 0,
"limit": 2,
"count": 2,
"hasMore": true,
"items": [{
"attrVarName": "_price_net_price",
"newValue": "3",
"_history_item_key": "_price_net_price2",
"docNumber": 2,
"oldValue": "1",
"attrName": "Net Price"
}, {
"attrVarName": "_transaction_total",
"newValue": "2269",
"_history_item_key": "_transaction_total1",
"docNumber": 1,
"oldValue": "2267",
"attrName": "Transaction Total (Net)"
}
]
}
}
]
}
}
]
}

[Link] 148/222
9/15/25, 2:27 PM Commerce REST APIs
}
}

Get Transaction

Get Transaction

Use this endpoint to retrieve the specified transaction.

Description

/rest/v19/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}
URI Endpoint

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

Query Parameters This endpoint supports optional excludeFieldTypes and expand parameters.

GET
HTTP Method

Request Body None

Parameters

The JSON data for the requested transaction.

Success
Response
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

[Link]

Sample Response Body

[Link] 149/222
9/15/25, 2:27 PM Commerce REST APIs
{
"_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@[Link]",
"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@[Link]",
"approval_status_submit_t" : "",
"_customer_t_company_name_2" : "",
"opportunityID_t" : "",

[Link] 150/222
9/15/25, 2:27 PM Commerce REST APIs
"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" :
"[Link]
}, {
"name" : "transactionLine",
"rel" : "child",
"href" :
"[Link]
ansactionLine",
"kind" : ""
} ]
}

Get Transaction Comment

Get Transaction Comment

Use this endpoint to retrieve the specified transaction comment.

Description

[Link] 151/222
9/15/25, 2:27 PM Commerce REST APIs

Get Transaction Comment

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/_s_transactionComments_t/{_row_number}

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

_row_number Unique row number to be used as row identifier for the comment.

Query Parameters This endpoint supports optional excludeFieldTypes parameter.

GET
HTTP Method

Request Body None

Parameters

Response Body bs_id The commerce transaction Id.

Parameters

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

[Link] 152/222
9/15/25, 2:27 PM Commerce REST APIs
[Link]
transactionComments_t/2

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": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_bs_id": 40155914,
"_row_number": 2,
"_s_customerComment": "Accepting the Quote",
"_s_isInternalComment": true,
"links": [{
"rel": "self",
"href":
"[Link]
_transactionComments_t/2"
}, {
"rel": "parent",
"href":
"[Link]
}
]
}

Get Transaction Comments

Get Transaction Comments

Use this endpoint to retrieve comments for the specified transaction.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/_s_transactionComments_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 153/222
9/15/25, 2:27 PM Commerce REST APIs

Get Transaction Comments

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

Query Parameters This endpoint supports the following optional parameters: excludeFieldTypes, fields, limit,
offset, orderby, q, and totalResults.
Refer to Manage Collections for additional information

GET
HTTP Method

Request Body None

Parameters

The JSON data for the requested transaction comments.

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

[Link]
entsOraclecpqoTransaction/40155914/_s_transactionComments_t

Sample Response Body

[Link] 154/222
9/15/25, 2:27 PM Commerce REST APIs
{
"hasMore": false,
"links": [{
"rel": "self",
"href":
"[Link]
_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": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_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":
"[Link]
_transactionComments_t/1"
}, {
"rel": "parent",
"href":
"[Link]
}
]
}, {
"_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": "[Link]
}, {
"rel": "canonical",
"href": "[Link]

[Link] 155/222
9/15/25, 2:27 PM Commerce REST APIs
}
]
},
"_bs_id": 40155914,
"_row_number": 2,
"_s_customerComment": "Accepting the Quote",
"_s_isInternalComment": true,
"links": [{
"rel": "self",
"href":
"[Link]
_transactionComments_t/2"
}, {
"rel": "parent",
"href":
"[Link]
}
]
}
]
}

Get Transaction Line

Get Transaction Line

Use this endpoint to retrieve the specified transaction line.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

Query Parameters This endpoint supports optional excludeFieldTypes and expand parameters.

GET
HTTP Method

[Link] 156/222
9/15/25, 2:27 PM Commerce REST APIs

Get Transaction Line

Request Body None

Parameters

The JSON data for the requested transaction line.

Success
Response

URI Endpoint Sample

[Link]
nsactionLine/2

Sample Response Body

[Link] 157/222
9/15/25, 2:27 PM Commerce REST APIs

{
"_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": "",

[Link] 158/222
9/15/25, 2:27 PM Commerce REST APIs
"_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",

[Link] 159/222
9/15/25, 2:27 PM Commerce REST APIs
"_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":
"[Link]
ansactionLine/2"
}, {
"rel": "parent",
"href":
"[Link]
}
]
}

Get Transaction Line Available Rate Plans

Get Transaction Line Available Rate Plans

Use this endpoint to retrieve a list of Available Rate Plans for the specified transaction line.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_availableRatePlanSet

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 160/222
9/15/25, 2:27 PM Commerce REST APIs

Get Transaction Line Available Rate Plans

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

Query Parameters This endpoint supports the following optional parameters: excludeFieldTypes, fields, limit,
offset, orderby, q, and totalResults.
Refer to Manage Collections for additional information.

GET
HTTP Method

Request Body None

Parameters

The response contains a collection of the available rate plans for the specified transaction line.
Success
Response

Get Transaction Line Available Rate Plan

Get Transaction Line Available Rate Plan

Use this endpoint to retrieve the specified transaction line available rate plan.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_availableRatePlanSet/{_row_number}
Endpoint

Endpoint Stage The stage variable identifies where a transaction is within the Commerce process flow.
Parameters (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be capitalized.

MainDocVarName The variable name of the main document, note the first letter must be capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction within an
Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

_row_number Unique row number to be used to specify the rate plan.

Query This endpoint supports the optional excludeFieldTypes parameter, refer to Manage Collections for additional
Parameters
information.

[Link] 161/222
9/15/25, 2:27 PM Commerce REST APIs

Get Transaction Line Available Rate Plan

GET
HTTP
Method

Request None
Body
Parameters

The response contains the available rate plan integration Id, available rate plan name, available rate plan number,
Success
and transaction currency preference.
Response

Get Transaction Line Charge

Get Transaction Line Charge

Use this endpoint to retrieve the specified transaction line charge .

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_chargeSet/{_row_number}

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

_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.

GET
HTTP Method

Request Body None

Parameters

[Link] 162/222
9/15/25, 2:27 PM Commerce REST APIs

Get Transaction Line Charge

The JSON data for the requested transaction line charge set.
Success
Response

URI Endpoint Sample

[Link]
nsactionLine/2/_chargeSet/2

Sample Response Body

[Link] 163/222
9/15/25, 2:27 PM Commerce REST APIs
{
"_chargeSet_chargeType": {
"displayValue": "Data Charge",
"value": "dataCharge_c"
},
"_sequence_number": 2,
"_chargeSet_calculationInfo": "
[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price
Model\",\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"B
ase 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,

[Link] 164/222
9/15/25, 2:27 PM Commerce REST APIs
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_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":
"[Link]
ansactionLine/2/_chargeSet/2"
}, {
"rel": "parent",
"href":
"[Link]
nsactionLine/2"
}
]
}

Get Transaction Line Charges

Get Transaction Line Charges

Use this endpoint to retrieve all charges for the specified transaction line.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_chargeSet

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 165/222
9/15/25, 2:27 PM Commerce REST APIs

Get Transaction Line Charges

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

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

GET
HTTP Method

Request Body None

Parameters

The response contains a collection of charge sets for the specified transaction line.
Success
Response

URI Endpoint Sample

[Link]
nsactionLine/2/_chargeSet

Sample Response Body

[Link] 166/222
9/15/25, 2:27 PM Commerce REST APIs
{
"hasMore": false,
"links": [{
"rel": "self",
"href":
"[Link]
ansactionLine/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\":\"B
ase 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": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_chargeSet_chargeDefinition": "Activation Fee",
"_chargeSet_chargeDefIntegrationId": "KI_ACTIVATION_CHARGE",
"_chargeSet_discountAmount": {

[Link] 167/222
9/15/25, 2:27 PM Commerce REST APIs
"value": 0.0,
"currency": "USD"
},
"_chargeSet_priceType": {
"displayValue": "One Time",
"value": "One Time"
},
"_chargeSet_unitPrice": {
"value": 250.0,
"currency": "USD"
},
"links": [{
"rel": "self",
"href":
"[Link]
ansactionLine/2/_chargeSet/1"
}, {
"rel": "parent",
"href":
"[Link]
ansactionLine/2"
}
]
}, {
"_chargeSet_chargeType": {
"displayValue": "Data Charge",
"value": "dataCharge_c"
},
"_sequence_number": 2,
"_chargeSet_calculationInfo": "
[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price
Model\",\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"B
ase 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": {

[Link] 168/222
9/15/25, 2:27 PM Commerce REST APIs
"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": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_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":
"[Link]
ansactionLine/2/_chargeSet/2"
}, {
"rel": "parent",
"href":
"[Link]
ansactionLine/2"
}
]

[Link] 169/222
9/15/25, 2:27 PM Commerce REST APIs
}
]
}

Get Transaction Lines

Get Transaction Lines

Use this endpoint to retrieve all transaction lines for the specified transaction.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

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

GET
HTTP Method

Request Body None

Parameters

The JSON data for the requested transaction lines.

Success
Response

URI Endpoint Sample

[Link]
nsactionLine

Get Transactions

Get Transactions

This operation retrieves all transactions.

Description

[Link] 170/222
9/15/25, 2:27 PM Commerce REST APIs

Get Transactions

/rest/v19/commerce{Stage}{ProcessVarName}{MainDocVarName}
URI Endpoint

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

Query Parameters This endpoint supports the following optional parameters: excludeFieldTypes, expand, fields,
limit, offset, orderby, q, and totalResults.

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

GET
HTTP Method

Request Body None

Parameters

The JSON data for the requested transaction.

Success
Response

URI Endpoint Sample

[Link]

Group (Aggregate) Transactions

Group (Aggregate) Transactions

Use this endpoint to return a list of transactions grouped by the column specified in the request body.
Description

/rest/v19/commerce{Stage}{ProcessVarName}{MainDocVarName}/actions/_aggregate
URI Endpoint

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 171/222
9/15/25, 2:27 PM Commerce REST APIs

Group (Aggregate) Transactions

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

POST
HTTP Method

aggregate Captures information to aggregate transactions.

Request Body
Parameters
criteria Captures the query definition for the current resource request.

JSON data containing the grouped transactions

Response Body
Parameters

URI Endpoint Sample

[Link]
gate

Sample Request Body

{
"aggregate": {
"attr": "processManagerSSM",
"limit": 20
},
"criteria": {
"fields": ["_customer_id", "_id", "_date_modified"],
"limit": 100,
"totalResults": true,
"q": "{'_customer_id':{$ne:'account112'}}",
"orderby": ["_date_modified"]
}
}

Sample Response Body

[Link] 172/222
9/15/25, 2:27 PM Commerce REST APIs
{
"groups": [{
"groupName": "",
"totalCount": 808,
"nextlink": {
"rel": "next",
"href":
"[Link]
offset=100&limit=100&q={\"_customer_id\":{\"$ne\":\"account112\"},\"processManagerSSM\":
{\"$exists\":false}}&fields=_customer_id,_id&totalResults=true"
}
}, {
"groupName": "value1",
"totalCount": 3,
"nextlink": {
"rel": "self",
"href":
"[Link]
offset=0&limit=100&q={\"_customer_id\":
{\"$ne\":\"account112\"},\"processManagerSSM\":\"value1\"}&fields=_customer_id,_id&total
Results=true"
}
}, {
"groupName": "value2",
"totalCount": 2,
"nextlink": {
"rel": "self",
"href":
"[Link]
offset=0&limit=100&q={\"_customer_id\":
{\"$ne\":\"account112\"},\"processManagerSSM\":\"value2\"}&fields=_customer_id,_id&total
Results=true"
}
}
],
"primaryResults": {
"totalResults": 808,
"offset": 0,
"limit": 100,
"count": 100,
"hasMore": true,
"links": [{
"rel": "self",
"href":
"[Link]
}
],
"items": [{
"_customer_id": "SpecialAccount6",
"_id": 15555314,
"links": [{
...
],
}, {
"_customer_id": "SpecialAccount6",
"_id": 15556582,

[Link] 173/222
9/15/25, 2:27 PM Commerce REST APIs
"links": [{
...
]
},
...
]
}
}

Interact - Transaction

Interact - Transaction

Use this endpoint to modify transaction attribute values, and optionally triggers auto-update rules without
Description
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.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_interact

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

deleteRows Used to select specific items for deletion.

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 param is empty
string, the user will be considered to be focused on no attribute

refreshCache Allows users to invoke the interact service without prior initiation of a cache
instance on the server. Additionally, administrators can pass a new
parameter, "refreshCache" = true, to reload the current cache and discard the
changes.

triggerAttrVarName The attribute which trigger the interact action. When the trigger attribute is in
current document, it is the variable name of the attribute.

This operation supports the following optional parameters: cacheInstanceId, criteria, delta,
documents, and revisionId.
Refer to Request Body Objects for additional information.

[Link] 174/222
9/15/25, 2:27 PM Commerce REST APIs

Interact - Transaction

The requested cached transaction is returned

Response Body
Parameters

Modify Item in Cache

URI Endpoint Sample

Interact with an item within transaction 18330547

[Link]
ions/_interact

Request Sample

Retrieve a cache instance, modify the "_price_quantity" for transaction line 2, and save the updates to cache using
"transactionLine/2/_price_quantity" as the triggering attribute

{
"cacheInstanceId":
"E9JuyC9QCgTDS9edghTNxRGOVUm34EMR7RJt9alFbkGTN0X5byTjHGRu1CxrSl1p",
"triggerAttrVarName": "transactionLine/2/_price_quantity",
"documents": {
"transactionLine": {
"items": [{"_price_quantity": "100", "_document_number": "2"}]
}
}
}

Re-Sequence Line Items via Interact

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

URI Endpoint Sample

[Link]
ions/_interact

Request Body Sample

[Link] 175/222
9/15/25, 2:27 PM Commerce REST APIs
{
"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": []
}
}

Interact - Transaction Line

Interact - Transaction Line

Use this endpoint to modify transaction line attribute values, and optionally trigger auto-update rules
Description
without committing or retrieving the latest data from the database. Since this action does not save the
transaction line to the CPQ database, it does not affect how other users see the transaction line.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_interact

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 176/222
9/15/25, 2:27 PM Commerce REST APIs

Interact - Transaction Line

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

POST
HTTP Method

deleteRows Used to select specific items for deletion.

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 param is empty
string, the user will be considered to be focused on no attribute

refreshCache Allows users to invoke the interact service without prior initiation of a cache
instance on the server. Additionally, administrators can pass a new
parameter, "refreshCache" = true, to reload the current cache and discard
the changes.

triggerAttrVarName The attribute which trigger the interact action. When the trigger attribute is in
current document, it is the variable name of the attribute.

This operation supports the following optional parameters: cacheInstanceId, criteria, delta,
documents, and revisionId.
Refer to Request Body Objects for additional information.

The requested cached transaction is returned

Response Body
Parameters

Lock Transaction

Lock Transaction

Use this endpoint to lock a single transaction to prevent other users from editing it.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/lockTransaction

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 177/222
9/15/25, 2:27 PM Commerce REST APIs

Lock Transaction

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body This operation supports the following optional parameters: cacheInstanceId, criteria, delta, and
Parameters revisionId.
Refer to Request Body Objects for additional information.

The JSON data for the requested transaction

Success
Response

URI Endpoint Sample

[Link]
ions/lockTransaction

My Approval Search

My Approval Search

Use this endpoint to retrieve a user's pending approvals waiting in a queue when there are quotes they
Description
need to approve.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/actions/_search/_my_approval_search

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

criteria Captures the query definition for resource requests.

Request Body
Parameters Refer to Criteria Object for additional information.

POST
HTTP Method

A list containing the requested fields and items matching the search criteria
Response Body
Parameters

URI Endpoint Sample

[Link] 178/222
9/15/25, 2:27 PM Commerce REST APIs
[Link]
rch/_my_approval_search

Request Sample

{
"criteria": {
"fields": [
"projectName",
"_id",
"_lock_status",
"_currency_pref",
"mainMathInput_Float1"
],
"orderby": [
"_currency_pref:DESC",
"projectName:ASC"
],
"limit": 10,
"offset": 20
}
}

Response Sample

[Link] 179/222
9/15/25, 2:27 PM Commerce REST APIs
{
"hasMore": false,
"links": [{
"rel": "self",
"href": "[Link]
}
],
"items": [{
"_lock_status": null,
"mainMathInput_Float1": null,
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_id": 3023106049,
"projectName": "Super User's project 11/07/2023 08:13:39"
}, {
"_lock_status": null,
"mainMathInput_Float1": null,
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_id": 3023123297,
"projectName": "Super User's project 11/08/2023 22:06:16"
}, {
"_lock_status": null,
"mainMathInput_Float1": null,
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},

[Link] 180/222
9/15/25, 2:27 PM Commerce REST APIs
"_id": 3023123306,
"projectName": "Super User's project 11/08/2023 22:06:16"
}, {
"_lock_status": null,
"mainMathInput_Float1": null,
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_id": 3023120057,
"projectName": "Super User's project 11/08/2023 07:43:34"
}, {
"_lock_status": null,
"mainMathInput_Float1": null,
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_id": 3023120066,
"projectName": "Super User's project 11/08/2023 07:43:54"
}, {
"_lock_status": null,
"mainMathInput_Float1": null,
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_id": 3023123276,
"projectName": "Super User's project 11/08/2023 21:53:31"
}, {
"_lock_status": null,
"mainMathInput_Float1": null,

[Link] 181/222
9/15/25, 2:27 PM Commerce REST APIs
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_id": 3023123288,
"projectName": "Super User's project 11/08/2023 22:05:37"
}, {
"_lock_status": null,
"mainMathInput_Float1": null,
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_id": 3023123315,
"projectName": "Super User's project 11/08/2023 22:06:16"
}, {
"_lock_status": null,
"mainMathInput_Float1": 4.35,
"_currency_pref": {
"id": 14619668,
"currencyCode": "USD",
"links": [{
"rel": "domain",
"href": "[Link]
}, {
"rel": "canonical",
"href": "[Link]
}
]
},
"_id": 15555481,
"projectName": "Test"
}
]
}

Open Transaction

[Link] 182/222
9/15/25, 2:27 PM Commerce REST APIs

Open Transaction

Use this endpoint to open a previously saved transaction.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_open_transaction

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body This operation supports the following optional parameters: cacheInstanceId, criteria,
Parameters errorCriteria, revisionId, and skipIntegration.
Refer to Request Body Objects for additional information.

The JSON data for the requested transaction, or a subset of transaction items, depending on the input
Success
request
Response

URI Endpoint Sample

[Link]
ions/_open_transaction

Open Transaction Line

Open Transaction Line

Use this endpoint to display the Line Items Details for a specified transaction line.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_open_transactionLine

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 183/222
9/15/25, 2:27 PM Commerce REST APIs

Open Transaction Line

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

selections Required, use to specify the transaction line to open. This action only
Request Body
accepts a single line selection.
Parameters

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.

The JSON data for the parent transaction, or a subset of transaction items, depending on the input
Response Body
request
Parameters

URI Endpoint Sample

[Link]
ions/_open_transactionLine

Request Body Sample

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

Request Body Sample with Selection Navigation

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

Orders - Cancel Sales Order

Orders - Cancel Sales Order

Use this endpoint to cancel a sales order or order lines in an external order management system.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/order_cancel

[Link] 184/222
9/15/25, 2:27 PM Commerce REST APIs

Orders - Cancel Sales Order

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This operation supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters deleteRows, delta, documents, revisionId, selections, selectionMode,
skipIntegration, and skipRules.
Refer to Request Body Objects for additional information.

The JSON Transaction data

Response Body

URI Endpoint Sample

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

Orders - Reject Sales Order

Orders - Reject Sales Order

Use this endpoint to reject an external order management system sales order.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/order_reject

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

[Link] 185/222
9/15/25, 2:27 PM Commerce REST APIs

Orders - Reject Sales Order

This operation supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters deleteRows, delta, documents, revisionId, selections, selectionMode,
skipIntegration, and skipRules.
Refer to Request Body Objects for additional information.

The JSON Transaction data

Response Body

URI Endpoint Sample

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

Orders - Start Sales Order

Orders - Start Sales Order

Use this endpoint to create a sales order for submission to an external order management system.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/order_start

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This operation supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters deleteRows, delta, documents, revisionId, selections, selectionMode,
skipIntegration, and skipRules.
Refer to Request Body Objects for additional information.

The JSON Transaction data

Response Body

URI Endpoint Sample

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

Orders - Update Sales Order

[Link] 186/222
9/15/25, 2:27 PM Commerce REST APIs

Orders - Update Sales Order

Use this endpoint to update an external order management system sales order.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/order_update

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This operation supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters deleteRows, delta, documents, revisionId, selections, selectionMode,
skipIntegration, and skipRules.
Refer to Request Body Objects for additional information.

The JSON Transaction data

Response Body

URI Endpoint Sample

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

Pipeline Viewer - Transaction

Pipeline Viewer - Transaction

Use this endpoint to display the rules that are in effect for the current Commerce process. This operation
Description
returns both transaction and transaction line items.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_pipelineViewer

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 187/222
9/15/25, 2:27 PM Commerce REST APIs

Pipeline Viewer - Transaction

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

cacheInstanceId Optional, only valid cache instance ids are supported The "-1" value is not
Request Body
supported
Parameters

Pipeline Viewer rules and impacted main document and sub-document attributes and actions.
Response Body
Parameters

URI Endpoint Sample

[Link]
ions/_pipelineViewer

Request Body Sample

{
"cacheInstanceId": "bDYxrCAnUwiVpYXUGDoT1GilCF0CFMPEGTcuKCPER3QFuxHJf33AYtAU1atZItpt"
}

Response Body Sample

[Link] 188/222
9/15/25, 2:27 PM Commerce REST APIs
{
"pipelineViewerRules": [{
"name": "Hide Level 2 Reason Approver",
"type": "Hiding Rule",
"components": {
"mainDoc": {
"attributes": [{
"name": "Hiding Attribute 1",
"variableName": "hidingAttribute1"
}, {
...
}
],
"actions": [{
"name": "Hiding Action 1",
"variableName": "hidingAction1"
}, {
...
}
]
},
"subDoc": {
"attributes": [{
"name": "Hiding Attribute 10",
"variableName": "hidingAttribute10"
}, {
...
}
],
"actions": [{
"name": "Hiding Action 10",
"variableName": "hidingAction10"
}, {
...
}
]
}
}
}, {
"name": "Hide Level 3 Reason Approver",
"type": "Hiding Rule",
"components": {
"mainDoc": {
...
},
"subDoc": {
...
}
}
}
]
}

Pipeline Viewer - Transaction Line

[Link] 189/222
9/15/25, 2:27 PM Commerce REST APIs

Pipeline Viewer - Transaction Line

Use this endpoint to display rules that are in effect for the current Commerce process. This action returns
Description
only transaction line items.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_pipelineViewer

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

POST
HTTP Method

cacheInstanceId Optional, only valid cache instance ids are supported. The "-1" value is not
Request Body
supported.
Parameters

Pipeline Viewer rules and impacted sub-document attributes and actions

Response Body
Parameters

URI Endpoint Sample

[Link]
nsactionLine/2/actions/_pipelineViewer

Request Body Sample

{
"cacheInstanceId": "bDYxrCAnUwiVpYXUGDoT1GilCF0CFMPEGTcuKCPER3QFuxHJf33AYtAU1atZItpt"
}

Response Body Sample

[Link] 190/222
9/15/25, 2:27 PM Commerce REST APIs
{
"pipelineViewerRules": [{
"name": "Hiding: Unhide Rules- Hiding Panel Subdoc",
"type": "Hiding Rule",
"components": {
"mainDoc": {
"attributes": [],
"actions": []
},
"subDoc": {
"attributes": [
"Hiding Tab 3 Attribute 1 Subdoc [hidingTab3Attribute1Subdoc]",
"Hiding Tab 1 Attribute 2 Subdoc [hidingTab1Attribute2Subdoc]",
"Hiding Tab 2 Attribute 2 Subdoc [hidingTab2Attribute2Subdoc]",
"Hiding Tab 1 Attribute 1 Subdoc [hidingTab1Attribute1Subdoc]"
],
"actions": []
}
}
}, {
"name": "Composite Sub Hiding",
"type": "Hiding Rule",
"components": {
"mainDoc": {
...
},
"subDoc": {
...
}
}
}, {
"name": "Constrain Commerce BOM Attribute Mapping Rules - Float to Float",
"type": "Constraint Rule",
"components": {
"mainDoc": {
...
},
"subDoc": {
...
}
}
}
]
}

Print - Generate Transaction Document for Print

Print - Generate Transaction Document

Use this endpoint to retrieve the objects required to print a transaction document.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_action_process_print

[Link] 191/222
9/15/25, 2:27 PM Commerce REST APIs

Print - Generate Transaction Document

Endpoint Stage The stage variable identifies where a transaction is within

Parameters the Commerce process flow. (Documents, Quotes,
Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the

first letter must be capitalized.

MainDocVarName The variable name of the main document, note the first
letter must be capitalized.

id The commerce transaction Id. This is the unique identifier

for a transaction within an Oracle CPQ site.

POST
HTTP Method

Request Body fileAttacmentAttribute The file attachment attribute used for confirmation
Parameters

langPreference Language attribute value for the print document

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
documents, revisionId.

Refer to Request Body Objects for additional information

Returns the transaction, email fields, XSL views, attachments, available attachments for merge, generated
Success
proposal attachment for merge, and the cache instance ID (if requested)
Response

availablAttachmentsForMerge The list of attachments which can be merged with the

Response Body
proposal document
Parameters

cacheInstanceId The cache instance ID, if requested

documents The transaction document

generatedProposalAttachmentForMerge The proposal attachment selected by default. The default

ID value for the transaction is -2.

revisionId The string parameter that contains the revision

information.

warnings Warning messages

xslViews An array of printer friendly documents (generated from

predefined XSL templates) that are available for print.

URI Endpoint Sample

[Link]
ions/_action_process_print

[Link] 192/222
9/15/25, 2:27 PM Commerce REST APIs

Request Body Sample

{
"cacheInstanceId": "K6TWnFB0UYyYqSNVnEwJtjs8eLRHl1uNeIZU8hM55EMa8FTeOSAmFO8De40hzJZl",
"criteria": {
"state": true,
"fields": [],
"childDefs": [ {
"name": "lineItem",
"queryDef": {}
}
],
"expandedDomains": []
},
"delta": true,
"documents": {}
}

Response Body Sample

[Link] 193/222
9/15/25, 2:27 PM Commerce REST APIs

{
"revisionId": "125,0",
"generatedProposalAttachmentForMerge": [{
"id": -2,
"name": "GENERATED PROPOSAL"
}
],
"availableAttachmentsForMerge": [{
"id": 3023197953,
"name": "[Link] (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",

[Link] 194/222
9/15/25, 2:27 PM Commerce REST APIs
"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

Print Transaction Document

Use this endpoint to print the generated transaction document.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_print_document

Endpoint Stage The stage variable identifies where a transaction is within the
Parameters Commerce process flow. (Documents, Quotes, Agreements, or
Orders)

ProcessVarName The variable name of the commerce process, note the first letter
must be capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a

transaction within an Oracle CPQ site.

POST
HTTP Method

actionVariableName The print preparation action variable name

Request Body
Parameters
attachmentsIdsForMerge The attachment IDs to merge

[Link] 195/222
9/15/25, 2:27 PM Commerce REST APIs

Print Transaction Document

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

Application/PDF format summary message for printing transaction

Success
Response
The response is in application/PDF format by default. To receive the response in JSON format,
the "Accept: application/json" header is required.

fileContent The Base64 encoded binary document value

Response Body
Parameters
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

[Link]
ions/_print_document

Request Body Sample

{
"actionVariableName": "_action_process_print",
"languagePreference": "en",
"xslView": 3023147879,
"attachmentIdsForMerge": ["3023197953", "-2"]
}

Publish Quote

[Link] 196/222
9/15/25, 2:27 PM Commerce REST APIs

Publish Quote

Use this endpoint to notify the self service channel that the quote is ready for review for customer/buyer.
Description

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.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_s_publish_quote

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters deleteRows, delta, documents, revisionId, selectionMode, selections,
skipIntegration, and skipRules.
Refer to Request Body Objects for additional information

Response Body The JSON data for the approved quote.

Parameters

URI Endpoint Sample

[Link]
ions/_s_publish_quote

Request Sample

[Link] 197/222
9/15/25, 2:27 PM Commerce REST APIs
{
"cacheInstanceId": "UNnWLpELVUzsZUBCqVXkbae4qBV2NRUYyausULaJ739PvjIuUwuWd2G06eb9YHdC",
"documents": {
"_s_transactionComments_t": {
"items": [{
"_row_number": -1,
"_s_commentor": "James Horton (Sales Rep)",
"_s_customerComment": "Please review the published quote and take an
appropriate action.",
"_s_commentDate": "2024-02-29T21:15:00-08:00",
"_s_isInternalComment": false
}
]
}
}
}

Response Sample

This response is truncated to highlight relevant attributes.

{
"revisionId": "18,0",
"documents": {
...
"_s_isPublished_t": true,
"priceExpirationDate_t": "2024-11-27T13:44:00Z",
"_s_customerStatus_t": {
"displayValue": "Acceptance",
"value": "acceptance"
},
"_s_customerVisibilityIdentifier_t": {
"displayValue": "HEADER_PRODUCTS_PRICES",
"value": "3"
},
"_s_assignedTo_t": {
"displayValue": "Buyer",
"value": "BUYER"
},
"_stage": {
"displayValue": "Quote",
"value": "QUOTE"
},
"_step_var_name": "awaitingCustomerAcceptance",
"transactionLine": {
...
"items": [{
...
}
]
}
},
"warnings": {},
"destinationURL": ""
}

[Link] 198/222
9/15/25, 2:27 PM Commerce REST APIs

Reconfigure Transaction

Reconfigure Transaction

Use this endpoint to edit a configuration after its been added to the transaction.
Description

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.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_reconfigure_action

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

selections Required, used to specify the transaction line to reconfigure

Request Body
Parameters 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.

The response contains the Destination URL, which can be used to launch the product catalog page to
Response Body
select and configure a product.

URI Endpoint Sample

[Link]
ions/_reconfigure_action

Request Body Sample

{
"documents": {"displayHistoryLanguage": "en"},
"selections": ["transactionLine/2"]
}

Response Body Sample

[Link] 199/222
9/15/25, 2:27 PM Commerce REST APIs
{
"destinationURL": "[Link]
action_id=4356762&amp;doc_number=1&amp;document_id=4356178&amp;id=18016533&amp;destinati
on_url=&amp;_line_item_list=2",
"documents": {
"conditionsOperatorsHelp": null,
"formulaContains": null,
"reconfigureFormulasInbound": "0"
}
}

Reconfigure Transaction - Inbound

Reconfigure Transaction - Inbound

Use this endpoint when saving the reconfiguration of a transaction.

Description

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.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_reconfigure_inbound_action

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body This operation supports the following optional parameters: cacheInstanceId, selectionMode,
Parameters selections, and skipIntegration.
Refer to Request Body Objects for additional information.

The response contains the cache instance Id, revision Id, and warnings.
Response Body

Reconfigure Transaction Line

[Link] 200/222
9/15/25, 2:27 PM Commerce REST APIs

Reconfigure Transaction Line

Use this endpoint to edit a configuration after its been added to the transaction.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocNumber}/{docNumber}/actions/_reconfigure_action

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

POST
HTTP Method

This operation supports the following optional parameters: cacheInstanceId, criteria, delta,
Request Body
Parameters documents, revisionId, selections, selectionMode, and skipIntegration.
Refer to Request Body Objects for additional information.

The response contains the "Destination URL", which can be used to launch the product catalog page to
Response Body
select and configure a product.

URI Endpoint Sample

[Link]
nsactionLine/2/actions/_reconfigure_action

Request Body Sample

{
"documents": {"_price_quantity": "20"}
}

Response Body Sample

[Link] 201/222
9/15/25, 2:27 PM Commerce REST APIs
{

"destinationURL": "[Link]
action_id=4356762&doc_number=1&document_id=4356178&id=18016533&destination_url=&_line_it
em_list=2",
"documents": {
"orderOfOpsInputSubDoc": null,
"_line_bom_item_quantity": null,
"copyLineProductsInitializationMSM": "Value 3~Value 4"
}
}

Reconfigure Transaction Line - Inbound

Reconfigure Transaction Line - Inbound

Use this endpoint when saving the reconfiguration of a transaction line.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI
{MainDocVarName}/{id}/{subDocNumber}/{docNumber}/actions/_reconfigure_inbound_action
Endpoint

Endpoint Stage The stage variable identifies where a transaction is within the Commerce process
Parameters flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be capitalized.

MainDocVarName The variable name of the main document, note the first letter must be capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction within an
Oracle CPQ site.

subDocVarName The variable name of the sub-document.

POST
HTTP
Method

This operation supports the following optional parameters: cacheInstanceId, , revisionId, selections,
Request
Body selectionMode, and skipIntegration.

Parameters Refer to Request Body Objects for additional information.

The response contains the cache instance Id, revision Id, and warnings.
Response
Body

Refresh Transaction

[Link] 202/222
9/15/25, 2:27 PM Commerce REST APIs

Refresh Transaction

Use this endpoint to refresh the current transaction with last saved data; the refresh action removes the
Description
existing values and replaces with the last saved data.

/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/refresh
URI Endpoint

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body This operation supports the following optional parameters: cacheInstanceId, criteria, and
Parameters revisionId.
Refer to Request Body Objects for additional information.

The JSON data for the requested transaction, or a subset of transaction items, depending on the input
Response Body
request.

URI Endpoint Sample

[Link]
/refresh

Sample Request Body

{
"cacheInstanceId":"-1"
}

Request Quote Revision

Request Quote Revision

Use this endpoint to request a quote revision for the specified transaction.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_s_publish_quote

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

[Link] 203/222
9/15/25, 2:27 PM Commerce REST APIs

Request Quote Revision

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters deleteRows, delta, documents, revisionId, selectionMode, selections,
skipIntegration, and skipRules.
Refer to Request Body Objects for additional information

Response Body The JSON data for the quote to be revised.

Parameters

URI Endpoint Sample

[Link]
ions/_s_request_quote_revision

Request Sample

{
"cacheInstanceId": "UNnWLpELVUzsZUBCqVXkbae4qBV2NRUYyausULaJ739PvjIuUwuWd2G06eb9YHdC",
"documents": {
"_s_transactionComments_t": {
"items": [{
"_row_number": -1,
"_s_commentor": "Adam Jones",
"_s_customerComment": "Please increase the discount percentage.",
"_s_commentDate": "2024-02-29T21:15:00-08:00",
"_s_isInternalComment": false
}
]
}
}
}

Response Sample

This response is truncated to highlight relevant attributes.

[Link] 204/222
9/15/25, 2:27 PM Commerce REST APIs
{
"revisionId": "18,0",
"documents": {
...
"_s_isPublished_t": true,
"priceExpirationDate_t": "2024-11-27T13:44:00Z",
"_s_customerStatus_t": {
"displayValue": "Acceptance",
"value": "acceptance"
},
"_s_customerVisibilityIdentifier_t": {
"displayValue": "HEADER_PRODUCTS_PRICES",
"value": "3"
},
"_s_assignedTo_t": {
"displayValue": "Buyer",
"value": "BUYER"
},
"_stage": {
"displayValue": "Quote",
"value": "QUOTE"
},
"_step_var_name": "awaitingCustomerAcceptance",
"transactionLine": {
...
"items": [{
...
}
]
}
},
"warnings": {},
"destinationURL": ""
}

Restore Archived Transactions

Restore Archived Transactions

Use this endpoint to restore the specified archived transactions.

Description

Note: This action is only available for Application Administrators.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/actions/_restore_archived_transactions

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 205/222
9/15/25, 2:27 PM Commerce REST APIs

Restore Archived Transactions

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

selectionCriteria An array of archived transaction id items to be restored.

Request Body
Parameters

POST
HTTP Method

204 No Content
Response Body
Parameters

URI Endpoint Sample

[Link]
tore_archived_transactions

Request Sample

{
"selectionCriteria":{
"ids":[18007731,18007790,18005157]
}
}

Save Transaction

Save Transaction

Use this endpoint to save the current state of the transaction (which may have been edited in the UI) to
Description
the CPQ database.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/cleanSave_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

[Link] 206/222
9/15/25, 2:27 PM Commerce REST APIs

Save Transaction

Request Body This endpoint supports the following optional parameters: cacheInstanceId, criteria,
Parameters deleteRows, delta, documents, revisionId, selections, selectionMode,
skipIntegration, and skipRules.

Refer to Request Body Objects for additional information

The JSON data for the saved transaction.

Response Body

URI Endpoint Sample

/rest/v19/commerceDocumentsOraclecpqoTransaction/36365444/actions/cleanSave_t

Save Transaction Line

Save Transaction Line

Use this endpoint to save the current state of the line item to the database.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/{subDocNumber}/{docNumber}/actions/save_l

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

subDocVarName The variable name of the sub-document.

docNumber The sub-document number

POST
HTTP Method

Request Body This endpoint supports the following optional parameters: cacheInstanceId, criteria,
Parameters deleteRows, delta, documents, revisionId, selections, selectionMode,
skipIntegration, and skipRules.

Refer to Request Body Objects for additional information

The JSON data for the saved transaction.

Response Body

Save Transaction Version

[Link] 207/222
9/15/25, 2:27 PM Commerce REST APIs

Save Transaction Version

Use this endpoint to invoke a special Save action used to save a transaction version.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/versionSave_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

Request Body This endpoint supports the following optional parameters: cacheInstanceId, criteria,
Parameters deleteRows, delta, documents, revisionId, selections, selectionMode,
skipIntegration, and skipRules.

Refer to Request Body Objects for additional information

The JSON data for the saved transaction version.

Response Body

Self-Service Checkout

Self-Service Checkout

Use this endpoint to update the quote to a closed phase when an order corresponding to this quote is
Description
placed using an external system. By default, this action will put the Quote in Canceled step and External
Order status.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_s_selfServiceCheckout

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 208/222
9/15/25, 2:27 PM Commerce REST APIs

Self-Service Checkout

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters deleteRows, delta, documents, revisionId, selectionMode, selections,
skipIntegration, and skipRules.
Refer to Request Body Objects for additional information

Response Body The JSON data for the quote using self-service checkout.
Parameters

URI Endpoint Sample

[Link]
ions/_s_selfServiceCheckout

Request Sample

{
"documents": {
...
}
}

Response Sample

This response is truncated to highlight relevant attributes

[Link] 209/222
9/15/25, 2:27 PM Commerce REST APIs
{
"revisionId": "18,0",
"documents": {
...
"_s_isPublished_t": true,
"priceExpirationDate_t": "2024-11-27T13:44:00Z",
"_s_customerStatus_t": {
"displayValue": "External Order",
"value": "externalOrder"
},
"_s_customerVisibilityIdentifier_t": {
"displayValue": "HEADER_PRODUCTS",
"value": "2"
},
"_s_assignedTo_t": {
"displayValue": "Buyer",
"value": "BUYER"
},
"_stage": {
"displayValue": "Quote",
"value": "QUOTE"
},
"_step_var_name": "canceled",
"_pp_name": "Sales User",
"transactionLine": {
...
"items": [{
...
}
]
}
},
"warnings": {},
"destinationURL": ""
}

Submit Transaction for Approval

Submit Transaction for Approval

Use this endpoint to submit the specified transaction for approval. If no approvals are needed for this
Description
transaction, it is automatically approved.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/submit_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 210/222
9/15/25, 2:27 PM Commerce REST APIs

Submit Transaction for Approval

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria,

Request Body
Parameters deleteRows, delta, documents, revisionId, selections, selectionMode, and
skipIntegration.

Refer to Request Body Objects for additional information.

The pending approval object.

Response Body

URI Endpoint Sample

[Link]
ons/submit_t

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

Submit - Approve Transaction

Use this endpoint to approve the transaction submitted for approval.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/approve_submit_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 211/222
9/15/25, 2:27 PM Commerce REST APIs

Submit - Approve Transaction

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

performer_comment Comment provided for approval.

Request Body
Parameters
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.

The JSON Transaction data

Response Body

URI Endpoint Sample

[Link]
e_submit_t

Sample Response Body

[Link] 212/222
9/15/25, 2:27 PM Commerce REST APIs
{
"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": "",

[Link] 213/222
9/15/25, 2:27 PM Commerce REST APIs
"approval_revision_submit_t": 2,
...
}
}

Submit - Reject Transaction

Submit - Reject Transaction

Use this endpoint to reject the transaction submitted for approval.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/reject_submit_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

performer_comment Comment provided for rejecting request.

Request Body
Parameters
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.

The JSON Transaction data

Response Body

URI Endpoint Sample

[Link]
ons/reject_submit_t

Sample Response Body

[Link] 214/222
9/15/25, 2:27 PM Commerce REST APIs
{
"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": "",

[Link] 215/222
9/15/25, 2:27 PM Commerce REST APIs
"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

Submit - Request Transaction Approval

Use this endpoint to request approval for a transaction.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/request_approval_submit_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

[Link] 216/222
9/15/25, 2:27 PM Commerce REST APIs

Submit - Request Transaction Approval

POST
HTTP Method

performer_comment Comment provided when requesting approval.

Request Body
Parameters
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.

The JSON Transaction data

Response Body

URI Endpoint Sample

[Link]
t_approval_submit_t

Sample Response Body

[Link] 217/222
9/15/25, 2:27 PM Commerce REST APIs
{
"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/[Link]",
"rejectIcon": "/img/bmx/icons/[Link]",
"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

Submit - Revise Transaction

Use this endpoint to revise the transaction submitted for approval.

Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/revise_submit_t

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

[Link] 218/222
9/15/25, 2:27 PM Commerce REST APIs

Submit - Revise Transaction

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

performer_comment Comment provided for revision.

Request Body
Parameters
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

[Link]
_submit_t

Sample Response Body

[Link] 219/222
9/15/25, 2:27 PM Commerce REST APIs

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

Unlock Transactions

Unlock Transactions

Use this endpoint to unlock the specified Transactions in a Commerce process that are locked for editing.
Description

This endpoint is not available / supported for Partner organization users.

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/actions/_process_unlock

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

[Link] 220/222
9/15/25, 2:27 PM Commerce REST APIs

Unlock Transactions

selections An array of transaction Ids to archive.

Request Body
Parameters

POST
HTTP Method

200
Success
Response

URI Endpoint Sample

[Link]
cess_unlock

Request Sample

{
"selections": [3022127625, 3022127628, 3022127629]
}

Update Transaction Lines

Update Transaction Line

This operation modifies transaction line details and updates the existing transaction.
Description

/rest/v19/commerce{Stage}{ProcessVarName}
URI Endpoint
{MainDocVarName}/{id}/actions/_update_line_items

Endpoint Stage The stage variable identifies where a transaction is within the Commerce
Parameters process flow. (Documents, Quotes, Agreements, or Orders)

ProcessVarName The variable name of the commerce process, note the first letter must be
capitalized.

MainDocVarName The variable name of the main document, note the first letter must be
capitalized.

id The commerce transaction Id. This is the unique identifier for a transaction
within an Oracle CPQ site.

POST
HTTP Method

This endpoint supports the following optional parameters: cacheInstanceId, criteria, delta,
Request Body
Parameters documents, revisionId, selections, selectionMode, and skipIntegration.

Refer to Request Body Objects for additional information.

[Link] 221/222
9/15/25, 2:27 PM Commerce REST APIs

Update Transaction Line

JSON data for the transaction, including the updated transaction line
Response Body

URI Endpoint Sample

[Link]
ions/_update_line_items

RELATED TOPICS
See Also

MongoDB Query Documents

25C What's New | Customer Support | Contact Us

Copyright © 2014, 2025, Oracle and/or its affiliates. All rights reserved.

[Link] 222/222