All REST Endpoints
Accounts
The Account REST API services support integration and querying external system accounts.
- Get Account
- Method: getPath:
/rest/v16/accounts/{customerId}
- Get Accounts
- Method: getPath:
/rest/v16/accounts
Assets
CPQ exposes asset data through REST APIs. Asset REST APIs support operations to retrieve and maintain assets.
- Get All Assets
- Method: getPath:
/rest/v16/assets
- Get an Asset
- Method: getPath:
/rest/v16/assets/{id}
- Get Child Assets
- Method: getPath:
/rest/v16/assets/{id}/childAssets
- Get Descendant Assets
- Method: getPath:
/rest/v16/assets/{id}/descendantAssets
Assets/Actions
These operations provide the ability to maintain CPQ assets through RESTful services. These endpoints provide access to actions to create, delete, modify, renew, resume, suspend, synchronize, modify, terminate, and update assets. They also provide support to update the configuration for an asset.
- Create Asset
- Method: postPath:
/rest/v16/assets
- Delete Asset
- Method: deletePath:
/rest/v16/assets/{id}
- Modify Asset
- Method: postPath:
/rest/v16/assets/{id}/actions/modify
- Modify Assets
- Method: postPath:
/rest/v16/assets/actions/modify
- Renew Asset
- Method: postPath:
/rest/v16/assets/{id}/actions/renew
- Renew Assets
- Method: postPath:
/rest/v16/assets/actions/renew
- Resume Asset
- Method: postPath:
/rest/v16/assets/{id}/actions/resume
- Resume Assets
- Method: postPath:
/rest/v16/assets/actions/resume
- Suspend Asset
- Method: postPath:
/rest/v16/assets/{id}/actions/suspend
- Suspend Assets
- Method: postPath:
/rest/v16/assets/actions/suspend
- Sychronize Asset
- Method: postPath:
/rest/v16/assets/{id}/actions/synchronizeAsset
- Sychronize Assets
- Method: postPath:
/rest/v16/assets/actions/synchronizeAsset
- Terminate Asset
- Method: postPath:
/rest/v16/assets/{id}/actions/terminate
- Terminate Assets
- Method: postPath:
/rest/v16/assets/actions/terminate
- Update Asset
- Method: postPath:
/rest/v16/assets/{id}
- Update Configuration
- Method: postPath:
/rest/v16/assets/actions/updateConfiguration
Assets/Configuration BOM Instance
These operations provide the ability to retrieve a configuration instance for external integrations, create a follow-on order, and reconfigure assets.
- Follow-On Order
- Method: postPath:
/rest/v16/configBomInstance/{configId}/actions/followOnOrder
- Get Configuration BOM Instance
- Method: postPath:
/rest/v16/configBomInstance/{configId}/actions/getConfigBom
- Reconfigure From Assets
- Method: postPath:
/rest/v16/configBomInstance/{configId}/actions/reconfig
Assets/File Operations
These operations provide the ability to export, import, and retrieve assets and asset log files.
- Export Asset
- Method: postPath:
/rest/v16/assets/{id}/actions/export
- Export Assets
- Method: postPath:
/rest/v16/assets/actions/export
- Import Assets
- Method: postPath:
/rest/v16/assets/actions/import
Assets/Projected Asset
The operations from the Assets/Projected Asset category.
- Search Projected Assets by Customer
- Method: postPath:
/rest/v16/projectedAssets/actions/search
BOM Item Setups
The BOM Item Setup REST API contains endpoints to create BOM data table entries and validate parts for BOM mapping implementations via REST services. REST services to maintain BOM Mapping rules are also included in this topic.
- Create a BOM Item Definition
- Method: postPath:
/rest/v16/bomItemSetups
- Create a BOM Item Mapping for a Parent BOM Item
- Method: postPath:
/rest/v16/bomItemSetups/{bomItemVarName}/bomItemMappings
- Create a BOM Item Tree
- Method: postPath:
/rest/v16/bomItemSetups/actions/createBomItemTree
- Delete a BOM Item Definition
- Method: deletePath:
/rest/v16/bomItemSetups/{bomItemVarName}
- Delete a BOM Mapping for a Parent BOM Item
- Method: deletePath:
/rest/v16/bomItemSetups/{bomItemVarName}/bomItemMappings/{bomItemMapVarName}
- Generate Configurator
- Method: postPath:
/rest/v16/bomItemSetups/{bomItemVarName}/actions/generateConfigurator
- Get a BOM Item Child Definition for a Parent BOM Item
- Method: getPath:
/rest/v16/bomItemSetups/{bomItemVarName}/children/{childVarName}
- Get a BOM Item Definition
- Method: getPath:
/rest/v16/bomItemSetups/{bomItemVarName}
- Get a BOM Item Mapping for a Parent BOM Item
- Method: getPath:
/rest/v16/bomItemSetups/{bomItemVarName}/bomItemMappings/{bomItemMapVarName}
- Get a BOM Item Tree
- Method: postPath:
/rest/v16/bomItemSetups/{bomItemVarName}/actions/getBomItemTree
- Get All BOM Item Child Definitions for a Parent BOM Item
- Method: getPath:
/rest/v16/bomItemSetups/{bomItemVarName}/children
- Get All BOM Item Definitions
- Method: getPath:
/rest/v16/bomItemSetups
- Get All BOM Item Mappings for a Parent BOM Item
- Method: getPath:
/rest/v16/bomItemSetups/{bomItemVarName}/bomItemMappings
- Get Related Configurators
- Method: postPath:
/rest/v16/bomItemSetups/{bomItemVarName}/actions/getRelatedConfigurators
- Update a BOM Item Definition
- Method: putPath:
/rest/v16/bomItemSetups/{bomItemVarName}
- Update a BOM Item Tree
- Method: postPath:
/rest/v16/bomItemSetups/{bomItemVarName}/actions/updateBomItemTree
- Update the BOM Item Mapping for a Parent BOM Item
- Method: putPath:
/rest/v16/bomItemSetups/{bomItemVarName}/bomItemMappings/{bomItemMapVarName}
- Upsert BOM Item List
- Method: postPath:
/rest/v16/bomItemSetups/actions/upsertBomItemList
- Validate Part for BOM
- Method: postPath:
/rest/v16/bomItemSetups/actions/validatePartForBOM
BOM Item Setups/BOM Mapping Rules
- Create a BOM Mapping Rule
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules
- Delete a BOM Mapping Rule
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules/{ruleId}/actions/delete
- Delete a BOM Mapping Rule
- Method: deletePath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules/{ruleId}
- Get a BOM Mapping Rule
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules/{ruleId}
- Get a BOM Mapping Rule Condition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules/{ruleId}/conditions/{ruleConditionIndex}
- Get All BOM Mapping Rule Conditions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules/{ruleId}/conditions
- Get All BOM Mapping Rules
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules
- Update a BOM Mapping Rule
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules/{ruleId}
Calculate Price
The Calculate Price REST API allows an external application to query CPQ for pricing information. Oracle CPQ executes contract rules and relevant profiles to calculate and return the final list price.
- Calculate Price
- Method: postPath:
/rest/v16/pricing/actions/calculatePrice
Certificates
The Certificates REST APIs are used to retrieve certificate details using REST API services.
- Get a Certificate
- Method: getPath:
/rest/v16/certificates/{name}
- Get List of All Certificates
- Method: getPath:
/rest/v16/certificates
Collaborative Quote Queue
This REST API provides support to manage Collaborative Quote Queues via web services.
- Clear Current Queue
- Method: postPath:
/rest/v16/collabOperationQueues/{bsId}/actions/clearCurrentQueue
- Get Collaborative Quote Queue
- Method: getPath:
/rest/v16/collabOperationQueues/{bsId}
Commerce
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:
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 CPQ Administrator Online Help > Web Services > Interface Catalog for information about accessing your site-specific REST APIs.
- Add Transaction Lines
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/addLineItem_t
- Alternate Address - Retrieve
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_retrieve_alternate_address
- Alternate Address - Select
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_select_alternate_address_action
- Archive Transactions
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_archive_transactions
- Auto-fill Account Information
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_auto_fill_action
- Back to Quotes List/Transaction Manager
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/back_to_transactionmanager_t
- Back to Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_back
- Calculate Transaction Line Item Price
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_calculate_price_action
- Change Transaction Currency
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_change_currency
- Copy Sequence
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_copy_sequence
- Copy to Favorites
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/copyToFavorites
- Copy Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_copy_transaction
- Copy Transaction Lines
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/copyLineItems_t
- Create Transaction Lines
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}
- Create Transaction Version
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/versionTransaction_t
- Create Transaction with Line Items
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}
- Create Transaction without Line Items
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_new_transaction
- Delete Archived Transactions
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_delete_archived_transactions
- Delete Transaction Line
- Method: deletePath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}
- Delete Transaction Lines
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_remove_transactionLine
- Drop Cache
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_dropCache
- Email - Generate Transaction Email
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_process_email_print
- Email - Send Transaction Email
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_send_email
- eSignature - Cancel Request
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_esig_cancel
- eSignature - Request Details
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_esig_details
- eSignature - Send Request
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_esig_send
- Export Transaction Attachment
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/exportAttachment
- Forward Transactions
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_forward
- Generate Proposal
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/generateProposal
- Get Archived Transactions
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_get_archived_transactions
- Get History
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/{displayHistoryActionVarName}
- Get Transaction
- Method: getPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}
- Get Transaction Line
- Method: getPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}
- Get Transaction Line Available Rate Plan
- Method: getPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_availableRatePlanSet/{_row_number}
- Get Transaction Line Available Rate Plans
- Method: getPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_availableRatePlanSet
- Get Transaction Line Charge
- Method: getPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_chargeSet/{_row_number}
- Get Transaction Line Charges
- Method: getPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_chargeSet
- Get Transaction Lines
- Method: getPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}
- Get Transactions
- Method: getPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}
- Group (Aggregate) Transactions
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_aggregate
- Interact - Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_interact
- Interact - Transaction Line
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_interact
- Lock Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/lockTransaction
- My Approvals Search
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_search/_my_approval_search
- Open Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_open_transaction
- Open Transaction Line
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_open_transactionLine
- Orders - Cancel Sales Order
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/order_cancel
- Orders - Reject Sales Order
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/order_reject
- Orders - Start Sales Order
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/order_start
- Orders - Update Sales Order
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/order_update
- Pipeline Viewer - Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_pipelineViewer
- Pipeline Viewer - Transaction Line
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_pipelineViewer
- Print - Generate Transaction Document
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_process_print
- Print Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_print_document
- Reconfigure Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_reconfigure_action
- Reconfigure Transaction - Inbound
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_reconfigure_inbound_action
- Reconfigure Transaction Line
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_reconfigure_action
- Reconfigure Transaction Line - Inbound
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_reconfigure_inbound_action
- Restore Archived Transactions
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_restore_archived_transactions
- Save Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/cleanSave_t
- Save Transaction Line
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/save_l
- Save Transaction Version
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/versionSave_t
- Submit - Approve Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/approve_submit_t
- Submit - Reject Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/reject_submit_t
- Submit - Request Transaction Approval
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/request_approval_submit_t
- Submit - Revise Transaction
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/revise_submit_t
- Submit Transaction for Approval
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/submit_t
- Unlock Transactions
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_process_unlock
- Update Transaction Lines
- Method: postPath:
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_update_line_items
Commerce/Commerce Document Layout
Transaction Administration services return CPQ transaction desktop layout definitions for UI frameworks to consume. The desktop layout definitions contain: layout parameters and properties for panels, tabs, columns, action strips, and transaction line grids; properties for actions and attributes; and translations for layout items. Metadata Services expose information about the definitions of the Commerce main document, sub document, actions, attributes, and translations.
- Get Document Layout
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/layouts/{mainDocVarName}
Commerce/Commerce Document Metadata
Transaction Administration services return CPQ transaction desktop layout definitions for UI frameworks to consume. The desktop layout definitions contain: layout parameters and properties for panels, tabs, columns, action strips, and transaction line grids; properties for actions and attributes; and translations for layout items. Metadata Services expose information about the definitions of the Commerce main document, sub document, actions, attributes, and translations.
- Get Action Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName}
- Get Action Translation
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName}/translations/{languageCode}
- Get Action Translations
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName}/translations
- Get Actions Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs
- Get Array Set Attribute Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}
- Get Array Set Attributes Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}/attributes
- Get Array Set Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}
- Get Array Sets Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets
- Get Attribute Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}
- Get Attribute Translation
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/translations/{languageCode}
- Get Attribute Translations
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/translations
- Get Attributes Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/attributes
- Get Document Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}
- Get Documents Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents
- Get Menu Item Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}
- Get Menu Item Translation
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}/translations/{languageCode}
- Get Menu Item Translations
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}/translations
- Get Menu Items Metadata
- Method: getPath:
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems
Commerce/Commerce UI Settings
Return Commerce Settings and applicable General Site settings for the Redwood Transaction UI
- Get Commerce UI Settings
- Method: getPath:
/rest/v16/commerceUISettings
Company
The company endpoint is used to get company information, most especially supported languages and currencies, using REST API services.
- Add Translations for Host Company or Partner Organization
- Method: postPath:
/rest/v16/companies/{companyLoginName}/translations
- Bulk Update Partner Organization and/or Host Company Details
- Method: patchPath:
/rest/v16/companies
- Create a Partner Organization Style Sheet
- Method: postPath:
/rest/v16/companies/{companyLoginName}/styleSheets
- Create Partner Oraganization
- Method: postPath:
/rest/v16/companies
- Delete a Style Sheet for a Partner Organization
- Method: deletePath:
/rest/v16/companies/{companyLoginName}/styleSheets/{name}
- Delete a Translation for a Host Company or Partner Organization
- Method: deletePath:
/rest/v16/companies/{companyLoginName}/translations/{languageCode}
- Export Details for Multiple Partner Organizations
- Method: postPath:
/rest/v16/companies/actions/bulkExport
- Get a Style Sheet for a Partner Organization
- Method: getPath:
/rest/v16/companies/{companyLoginName}/styleSheets/{name}
- Get All Style Sheets for a Partner Organization
- Method: getPath:
/rest/v16/companies/{companyLoginName}/styleSheets
- Get All Translation Details for Host Company or a Partner Organization
- Method: getPath:
/rest/v16/companies/{companyLoginName}/translations
- Get Host Company and All Partner Organizations
- Method: getPath:
/rest/v16/companies
- Get Host Company or Partner Organization Details
- Method: getPath:
/rest/v16/companies/{companyLoginName}
- Get Specific Translation Details for a Host Company or Partner Organization
- Method: getPath:
/rest/v16/companies/{companyLoginName}/translations/{languageCode}
- Import Details for Multiple Partner Oragnizations
- Method: postPath:
/rest/v16/companies/actions/bulkImport
- Update a Partner Organization Style Sheet
- Method: putPath:
/rest/v16/companies/{companyLoginName}/styleSheets/{name}
- Update All Host Company or Partner Organization Details
- Method: putPath:
/rest/v16/companies/{companyLoginName}
- Update Host Company or Partner Organization Translations
- Method: patchPath:
/rest/v16/companies/{companyLoginName}/translations
- Update Specific Host Company or Partner Organization Details
- Method: patchPath:
/rest/v16/companies/{companyLoginName}
Configuration
The Configuration Run-Time Data endpoints expose information and perform an action for a model. All Configuration Run-Time Data REST APIs follow a required product hierarchy starting with the product family then product line followed by the model. A variable name for the product entity is required. For example, /config{prodFamVarName}.{prodLineVarName}.{modelVarName}/ is the standard Configuration Run-Time Data product path for an endpoint URL.
- Add Model to Favorites
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_cm_favoriteslistinvocationID
- Add Multiple Models to a Transaction
- Method: postPath:
/rest/v16/config/actions/_bulkAddToTxn
- Add Row to Array Set
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_set{arraySetVarName}/actions/_add
- Add To Transaction
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_addToTxn
- Cancel
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_cancel
- Configuration Integration
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_integration_integratedCart
- Configure a Model
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_configure
- Configure Model in System
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_configureInSystem
- Delete Row from an Array
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_set{arraySetVarName}/actions/_delete
- Drop Cache
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_dropCache
- Get All Pick List Options
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_pickLists/actions/getOptions
- Get BOM Items
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_bom/actions/getBomItems
- Get Mandatory Models
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_mandatoryModels/actions/getMandatoryModels
- Get Mandatory Parts
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_mandatoryParts/actions/getMandatoryParts
- Get Price Books
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_priceBooks/actions/getPriceBooks
- Get Recommended Models
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_recmdModels/actions/getRecmdModels
- Get Recommended Parts
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_recmdParts/actions/getRecmdParts
- Interact
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_interact
- Load Array Set Data
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_set{arraySetVarName}/actions/_loadData
- Load Configuration Data
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_loadData
- Next Configuration Node
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_next
- Previous Configuration Node
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_previous
- Process Invocation Action
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_cm_invocationID
- Reconfigure from Favorites
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_reconfigureFav
- Reconfigure Model
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_reconfigureTxn
- Reconfigure Model from Partner
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_reconfigureClient
- Resume Configuration
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_resumeConfig
- Save Reconfiguration
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_save
- Start Over
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_startOver
- Update
- Method: postPath:
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_update
- x Add From Catalog (Not supported after v7)
- Method: postPath:
/rest/v7/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_addFromCatalog
Configuration/Configuration Layout
Configuration Layout Services return Oracle CPQ Configuration desktop layout definitions for UI frameworks to consume. The desktop layout definition contains the following items: Layout components and properties for panels, tabs, columns, grids and their associated attributes; and Properties for Product Families, Product Lines, and Models
- Get Configuration Layout Attribute Data
- Method: getPath:
/rest/v16/layoutCache/{prodFamVarName}/{prodLineVarName}/{modelVarName}/attributes
- Get Model Layout
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/layouts/{layoutVarName}
- Get Product Family Layout
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/layouts/{layoutVarName}
- Get Product Line Layout
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/layouts/{layoutVarName}
Configuration/Configuration Metadata
Configuration Metadata Services expose information about the definitions of the Product Families, Product Lines, Models, attributes, array sets, menu items, and translations. All of the Configuration metadata REST APIs follow a standard product path based on the hierarchy of product family to product line to model. Depending on the metadata being requested, the product path for the endpoint URL requires the broader product structure specified by variable name. Therefore, to retrieve Model-level configuration metadata, the Product Family and Product Line variable names are required.
- Get Model Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}
- Get Models Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models
- Get Product Families Metadata
- Method: getPath:
/rest/v16/productFamilies
- Get Product Family Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}
- Get Product Line Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}
- Get Product Lines Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines
Configuration/Configuration Metadata/Array Set Attribute Menu Items
These services return the array set attribute menu item metadata for the specified attribute or array set of a Product Family, Product Line, or Model.
- Get Model Array Set Attribute Menu Item Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}
- Get Model Array Set Attribute Menu Items Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems
- Get Product Family Array Set Attribute Menu Item Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}
- Get Product Family Array Set Attribute Menu Items Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems
- Get Product Line Array Set Attribute Menu Item Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}
- Get Product Line Array Set Attribute Menu Items Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems
Configuration/Configuration Metadata/Array Set Attributes
These services return the array set attribute metadata for the specified Product Family, Product Line, or Model.
- Get Model Array Set Attribute Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}
- Get Model Array Set Attributes Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName}/attributes
- Get Product Family Array Set Attribute Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}
- Get Product Family Array Set Attributes Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName}/attributes
- Get Product Line Array Set Attribute Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}
- Get Product Line Array Set Attributes Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets/{arraySetVarName}/attributes
Configuration/Configuration Metadata/Array Sets
These services return the array set metadata for the specified Product Family, Product Line, or Model.
- Get Model Array Set Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName}
- Get Model Array Sets Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets
- Get Product Family Array Set Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName}
- Get Product Family Array Sets Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/arraySets
- Get Product Line Array Set Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets/{arraySetVarName}
- Get Product Line Array Sets Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets
Configuration/Configuration Metadata/Attribute Menu Items
These services return the attribute menu item metadata for the specified Product Family, Product Line, or Model.
- Get Model Attribute Menu Item Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}
- Get Model Attribute Menu Items Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems
- Get Product Family Attribute Menu Item Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}
- Get Product Family Attribute Menu Items Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems
- Get Product Line Attribute Menu Item Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}
- Get Product Line Attribute Menu Items Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems
Configuration/Configuration Metadata/Attributes
These services return the attribute metadata for the specified Product Family, Product Line, or Model.
- Get Model Attribute Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}
- Get Model Attributes Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes
- Get Product Family Attribute Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/attributes/{attributeVarName}
- Get Product Family Attributes Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/attributes
- Get Product Line Attribute Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}
- Get Product Line Attributes Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes
Configuration/Configuration Metadata/Integrations
Configuration Metadata Integration Services expose information about Product Family integrations.
- Get Product Family Integration Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/integrations
- Get Product Family Integrations Metadata
- Method: getPath:
/rest/v16/productFamilies/{prodFamVarName}/integrations/{integrationVarName}
Configuration/Product Administration
- Deploy a Product Family
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/actions/deploy
- Get Related, Undeployed Data Tables
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/actions/getRelatedUndeployedDataTables
Configuration/Product Administration/Action Definitions
- Create a Model Action
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions
- Create a Model Action Translation
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}/translations
- Create a Product Family Action
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions
- Create a Product Family Action Translation
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}/translations
- Create a Product Line Action
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions
- Create a Product Line Action Translation
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions/{actionVarName}/translations
- Delete a Model Action
- Method: deletePath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}
- Delete a Model Action Translation
- Method: deletePath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}/translations/{translation_Id}
- Delete a Product Family Action
- Method: deletePath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}
- Delete a Product Family Action Translation
- Method: deletePath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}/translations/{translation_Id}
- Delete a Product Line Action
- Method: deletePath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions/{actionVarName}
- Delete a Product Line Action Translation
- Method: deletePath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions/{actionVarName}/translations/{translation_Id}
- Get a Model Action
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}
- Get a Model Action Translation
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}/translations/{translation_Id}
- Get a Product Family Action
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}
- Get a Product Family Action Translation
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}/translations/{translation_Id}
- Get a Product Line Action
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions/{actionVarName}
- Get a Product Line Action Translation
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions/{actionVarName}/translations/{translation_Id}
- Get List of Model Action Translations
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}/translations
- Get List of Model Actions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions
- Get List of Product Family Action Translations
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}/translations
- Get List of Product Family Actions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions
- Get List of Product Line Action Translations
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions/{actionVarName}/translations
- Get List of Product Line Actions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions
- Update a Model Action
- Method: putPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}
- Update a Model Action Translation
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}/translations/{translation_Id}
- Update a Product Family Action
- Method: putPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}
- Update a Product Family Action Translation
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}/translations/{translation_Id}
- Update a Product Line Action
- Method: putPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions/{actionVarName}
- Update a Product Line Action Translation
- Method: postPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions/{actionVarName}/translations/{translation_Id}
Configuration/Product Administration/Attribute Definitions
- Get a Model Attribute Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}
- Get a Product Family Attribute Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}
- Get a Product Line Attribute Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}
- Get an All Product Families Attribute Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/attributes/{attributeVarName}
- Get List of All Product Families Attribute Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/attributes
- Get List of Model Attribute Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes
- Get List of Product Family Attribute Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes
- Get List of Product Line Attribute Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes
Configuration/Product Administration/Catalog Definitions
- Get a Model Catalog Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}
- Get a Product Family Catalog Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}
- Get a Product Line Catalog Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}
- Get an All Product Families Catalog Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}
- Get List of All Product Families Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups
- Get List of Model Catalog Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models
- Get List of Product Family Catalog Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies
- Get List of Product Line Catalog Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines
Configuration/Product Administration/Menu Item Definitions
- Get a Model Menu Item Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}
- Get a Model Menu Item Image Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images/{image_Id}
- Get a Model Menu Item Price Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices/{price_Id}
- Get a Product Family Menu Item Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}
- Get a Product Family Menu Item Image Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images/{image_Id}
- Get a Product Family Menu Item Price Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices/{price_Id}
- Get a Product Line Menu Item Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}
- Get a Product Line Menu Item Image Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images/{image_Id}
- Get a Product Line Menu Item Price Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices/{price_Id}
- Get an All Product Families Menu Item Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}
- Get an All Product Families Menu Item Image Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images/{image_Id}
- Get an All Product Families Menu Item Price Definition
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices/{price_Id}
- Get List of All Product Families Menu Item Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/attributes/{attributeVarName}/menuItems
- Get List of All Product Families Menu Item Image Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images
- Get List of All Product Families Menu Item Price Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices
- Get List of Model Menu Item Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems
- Get List of Model Menu Item Image Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images
- Get List of Model Menu Item Price Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices
- Get List of Product Family Menu Item Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems
- Get List of Product Family Menu Item Image Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images
- Get List of Product Family Menu Item Price Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices
- Get List of Product Line Menu Item Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems
- Get List of Product Line Menu Item Image Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images
- Get List of Product Line Menu Item Price Definitions
- Method: getPath:
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices
DOCX Compare & Merge
Commerce Document Generation Actions provide services to generate proposals, and document compare and merge features for Contract Negotiation.
- DOCX Compare
- Method: postPath:
/rest/v16/docxCompare
- DOCX Merge
- Method: postPath:
/rest/v16/docxMerge
Data Tables
CPQ Data Table REST APIs allow administrators to access and support CPQ Data Tables. The Data Table REST APIs support functions for data table properties, folders, columns, records, imports, exports, and searches. Deployed Data Table REST APIs allow external systems to retrieve deployed data from CPQ Data Tables.
Note: Refer to the Task REST APIs for the following task-related functions: Get List of Tasks, Get Task, Cancel Task, Delete Task, Delete Tasks, Get Task File List, and Download a Task File.
Note: Refer to the Task REST APIs for the following task-related functions: Get List of Tasks, Get Task, Cancel Task, Delete Task, Delete Tasks, Get Task File List, and Download a Task File.
- Create Data Table
- Method: postPath:
/rest/v16/datatables
- Delete Data Table
- Method: deletePath:
/rest/v16/datatables/{tableName}
- Delete Data Tables
- Method: postPath:
/rest/v16/datatables/actions/deleteTables
- Deploy Data Tables
- Method: postPath:
/rest/v16/datatables/actions/deploy
- Export Data Tables
- Method: postPath:
/rest/v16/datatables/actions/export
- Get Data Table Properties
- Method: getPath:
/rest/v16/datatables/{tableName}
- Get List of Data Tables
- Method: getPath:
/rest/v16/datatables
- Import Data Tables
- Method: postPath:
/rest/v16/datatables/actions/import
- Move Data Tables
- Method: postPath:
/rest/v16/datatables/actions/moveTables
- Update Data Table Properties
- Method: postPath:
/rest/v16/datatables/{tableName}
Data Tables/Data Table Columns
The data table column endpoints retrieve data table column information and perform actions to create, delete, synchronize, and update data table columns.
- Create or Update Data Table Column
- Method: postPath:
/rest/v16/datatables/{tableName}/fields
- Delete Data Table Column
- Method: deletePath:
/rest/v16/datatables/{tableName}/fields/{fieldName}
- Delete Data Table Columns
- Method: postPath:
/rest/v16/datatables/{tableName}/fields/actions/deleteFields
- Get Data Table Column Properties
- Method: getPath:
/rest/v16/datatables/{tableName}/fields/{fieldName}
- Get List of Data Table Columns
- Method: getPath:
/rest/v16/datatables/{tableName}/fields
- Synchronize Data Table Columns
- Method: postPath:
/rest/v16/datatables/{tableName}/fields/actions/synchronize
- Update Data Table Column Properties
- Method: postPath:
/rest/v16/datatables/{tableName}/fields/{fieldName}
Data Tables/Data Table Data
The data table row endpoints retrieve data table rows (i.e. data or records) and perform actions to clear, create, delete, synchronize, and update data table rows.
- Clear Data Table Data
- Method: postPath:
/rest/v16/adminCustom{tableName}/actions/clearData
- Create Data Table Row
- Method: postPath:
/rest/v16/adminCustom{tableName}
- Delete Data Table Row
- Method: deletePath:
/rest/v16/adminCustom{tableName}/{rowId}
- Delete Data Table Rows
- Method: postPath:
/rest/v16/adminCustom{tableName}/actions/deleteRows
- Get Data Table Data
- Method: getPath:
/rest/v16/adminCustom{tableName}
- Get Data Table Row
- Method: getPath:
/rest/v16/adminCustom{tableName}/{rowId}
- Search Data Tables
- Method: postPath:
/rest/v16/datatables/actions/getQueryStatistics
- Synchronize Data Table Rows
- Method: postPath:
/rest/v16/adminCustom{tableName}/actions/synchronize
- Update Data Table Row
- Method: postPath:
/rest/v16/adminCustom{tableName}/{rowId}
Data Tables/Data Table Folders
The data table folder endpoints retrieve data table folder properties and perform actions to create, update, and delete data table folders.
- Create Data Table Folder
- Method: postPath:
/rest/v16/folders
- Delete Data Table Folder
- Method: deletePath:
/rest/v16/folders/{folderVarName}
- Get Data Table Folder
- Method: getPath:
/rest/v16/folders/{folderVarName}
- Get Data Table Folders
- Method: getPath:
/rest/v16/folders
- Update Data Table Folder
- Method: postPath:
/rest/v16/folders/{folderVarName}
Data Tables/Deployed Data Tables
These endpoints allow an external system to access deployed data in CPQ data tables. When executed correctly, the external system will receive the CPQ data table's deployed data in the REST response body. NOTE: Currently only Read operations are supported when interacting with the custom{DataTable} API.
- Get Deployed Data Table
- Method: getPath:
/rest/v16/custom{DataTable}
- Get Deployed Data Table Record
- Method: getPath:
/rest/v16/custom{DataTable}/{id}
Developer Toolkit
The following REST APIs are available to support the following Developer Toolkit functions: download, validate, save, and deploy site BML and BMLT (BigMachines Extensible Language Test) files.
- Developer Toolkit Deploy
- Method: postPath:
/rest/v16/adminMeta/actions/deploy
- Developer Toolkit Force Deploy
- Method: postPath:
/rest/v16/adminMeta/actions/forceDeploy
- Developer Toolkit Force Save
- Method: postPath:
/rest/v16/adminMeta/actions/forceSave
- Developer Toolkit Save
- Method: postPath:
/rest/v16/adminMeta/actions/save
- Developer Toolkit Test
- Method: postPath:
/rest/v16/adminMeta/actions/test
- Developer Toolkit Validate
- Method: postPath:
/rest/v16/adminMeta/actions/validate
- Get All BML and BMLT Files
- Method: getPath:
/rest/v16/adminMeta
Eligibility Rules
CPQ exposes eligibility data through REST APIs. As described in this section, Eligibility APIs allow external applications to create, read, update, delete, and deploy eligibility data.
- Create Eligibility Rule
- Method: postPath:
/rest/v16/eligibilityRule
- Delete Eligibility Rule
- Method: deletePath:
/rest/v16/eligibilityRule/{id}
- Delete Eligibility Rule
- Method: postPath:
/rest/v16/eligibilityRule/{id}/actions/delete
- Deploy Eligibility Rule
- Method: postPath:
/rest/v16/eligibilityRule/{id}/actions/deploy
- Deploy Multiple Eligibility Rules
- Method: postPath:
/rest/v16/eligibilityRule/actions/deploy
- Get All Eligibility Rules
- Method: getPath:
/rest/v16/eligibilityRule
- Get Eligibility Rule
- Method: getPath:
/rest/v16/eligibilityRule/{id}
- Update Eligibility Rule
- Method: postPath:
/rest/v16/eligibilityRule/{id}
Eligibility Rules/Conditions and Selections
These operations retrive conditions and selections for Eligibility Rules.
- Get All Eligibility Rule Conditions
- Method: getPath:
/rest/v16/eligibilityRule/{id}/condition
- Get All Eligibility Rule Selections
- Method: getPath:
/rest/v16/eligibilityRule/{id}/selection
- Get Eligibility Rule Condition
- Method: getPath:
/rest/v16/eligibilityRule/{id}/condition/{ruleConditionIndex}
- Get Eligibility Rule Selection
- Method: getPath:
/rest/v16/eligibilityRule/{id}/selection/{ruleSelectionIndex}
External Configurator
This REST API provides support for the External Configurator Integration. The REST service invokes the External Configurator Advanced Save function to create a transaction, Add from Catalog, or Reconfigure.
- External Configurator
- Method: postPath:
/rest/v16/productFamilies/{pfVar}/productLines/{plVar}/models/{modelVar}/actions/_externalConfigurationSave
Extract Data
The Extract Data REST API sends bulk transaction and transaction line data to the Fusion Analytics Warehouse (FAW) to produce advanced reports and dashboards.
- Cancel Data Extract Task
- Method: postPath:
/rest/v16/extract/cancel/{taskId}
- Extract Data Stores
- Method: postPath:
/rest/v16/extract/dataStores/actions/extractData
- Get All Data Store Attributes
- Method: getPath:
/rest/v16/extract/dataStores/{dataStoreName}/attributes
- Get All Data Stores
- Method: getPath:
/rest/v16/extract/dataStores
- Get Data Extract Task Status
- Method: getPath:
/rest/v16/extract/status/{taskId}
- Get Site Status for Data Extract
- Method: getPath:
/rest/v16/extract/siteStatus
- Request Data Extract
- Method: postPath:
/rest/v16/extract/transactions
Favorites
The following REST APIs support Oracle CPQ Favorites, Favorites Lists, Favorites Folder, Sharing Favorites. Favorites allow each user to list their favorite products and/or parts for quick access and quote creation in a Favorites List, which can be shared with other Sales Users and Sales Groups.
- Copy a Favorite
- Method: postPath:
/rest/v16/favorites/{id}/actions/copyTo
- Copy a List of Favorites to a Folder
- Method: postPath:
/rest/v16/favorites/actions/copyTo
- Delete a Favorite
- Method: postPath:
/rest/v16/favorites/{id}/actions/delete
- Delete a List of Favorites
- Method: postPath:
/rest/v16/favorites/actions/delete
- Get a Favorite
- Method: getPath:
/rest/v16/favorites/{id}
- Get Details of a Favorite's Selected Option
- Method: getPath:
/rest/v16/favorites/{rootId}/subItems/{subitemId}
- Get List of the Selected Options from a Favorite
- Method: getPath:
/rest/v16/favorites/{rootId}/subItems
- Get Sharing Settings for a Favorite
- Method: getPath:
/rest/v16/favorites/{id}/sharePermissions
- Get User's List of Favorites
- Method: getPath:
/rest/v16/favorites
- Move a Favorite to a Folder
- Method: postPath:
/rest/v16/favorites/{id}/actions/moveTo
- Move a List of Favorites to a Folder
- Method: postPath:
/rest/v16/favorites/actions/moveTo
- Reconfigure a Favorite
- Method: postPath:
/rest/v16/favorites/{id}/actions/reconfigure
- Remove Myself from a Shared Favorite
- Method: postPath:
/rest/v16/favorites/{id}/actions/removeMe
- Update Sharing Settings for a Favorite
- Method: putPath:
/rest/v16/favorites/{id}/sharePermissions
Favorites/Favorite Folders
The following REST APIs support personal and company Favorite Folders.
- Create a Favorite Folder
- Method: postPath:
/rest/v16/favoriteFolders
- Delete a Favorite Folder
- Method: deletePath:
/rest/v16/favoriteFolders/{id}
- Get a Favorite Folder
- Method: getPath:
/rest/v16/favoriteFolders/{id}
- Get a List of Favorite Folders
- Method: getPath:
/rest/v16/favoriteFolders
- Get Permissions for a Favorite Folder
- Method: getPath:
/rest/v16/favoriteFolders/{id}/sharePermissions
- Update or Remove Permissions for a Favorite Folder
- Method: putPath:
/rest/v16/favoriteFolders/{id}/sharePermissions
Favorites/Favorite Process Invocations
The following REST APIs support favorite process invocations.
- Get Favorite Process Inocations
- Method: postPath:
/rest/v16/favorites/actions/getProcessInvocations
- Invoke Favorite
- Method: postPath:
/rest/v16/favorites/actions/start
- Shopping Cart Action Invocation for Favorites
- Method: postPath:
/rest/v16/favorites/actions/shoppingCart
Generate Document
The Document Generator REST APIs allow an external system to send a REST call to generate a document using a Document Designer template and retrieve generated documents.
- Generate Document
- Method: postPath:
/rest/v16/documentGenerator
- Get Generated Document
- Method: getPath:
/rest/v16/documentGenerator/{id}
- Get Generated Documents List
- Method: getPath:
/rest/v16/documentGenerator
Generate Email
The REST APIs enable an external entity to use an existing Email Designer template and generate an html email for a given transaction. The API allows POST with the Transaction ID and appropriate Email Designer template details, to create the output email.
- Generate Email Document
- Method: postPath:
/rest/v16/emailGenerator
- Get Generated Email Document
- Method: getPath:
/rest/v16/emailGenerator/{id}
- Get Generated Email Documents List
- Method: getPath:
/rest/v16/emailGenerator
Global Branding
The Global Branding REST API services support retrieving the global branding defined for site.
- Get Global Branding
- Method: getPath:
/rest/v16/globalBranding
Global Dictionary
The Global Dictionary REST API services support retrieving, updating, and deleting the values in the global dictionary defined for a site.
- Add or Update Global Dictionary Key Values
- Method: postPath:
/rest/v16/globalDict
- Delete a Global Dictionary Key Value
- Method: deletePath:
/rest/v16/globalDict/{key}
- Get All Global Dictionary Key Values
- Method: getPath:
/rest/v16/globalDict
- Get Global Dictionary Key Value
- Method: getPath:
/rest/v16/globalDict/{key}
Groups
The Groups REST API services supports groups for partner organizations and the host company via REST API services.
- Bulk Update Users within Groups
- Method: patchPath:
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}/users
- Create a Group for Host Company or Partner Organization
- Method: postPath:
/rest/v16/companies/{companyLoginName}/groups
- Get a Group for Host Company or Partner Organization
- Method: getPath:
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}
- Get All Access Segments for a Group
- Method: getPath:
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments
- Get All Groups
- Method: getPath:
/rest/v16/groups
- Get All Users of a Group
- Method: getPath:
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}/users
- Get Data Table Access Rights
- Method: getPath:
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments/_dataTables/folders/{folderVarName}/accessRights
- Get Groups for the Host Company or for a Partner Organization
- Method: getPath:
/rest/v16/companies/{companyLoginName}/groups
- Update a Group for Host Company or Partner Organization
- Method: putPath:
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}
- Update Data Tables Access Rights for a Group
- Method: postPath:
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments/_dataTables/actions/updateAccessRights
- Update Group Access Segments for a Group
- Method: patchPath:
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments
- Update Specific Group Details for the Host Company or Partner Organization
- Method: patchPath:
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}
Integration Vendors
The Integration Vendors REST APIs are used to retrieve OAuth integration information, create a new OAuth integration, and delete or update an existing OAuth integration in the Integration Center.
- Create an Integration
- Method: postPath:
/rest/v16/integrationVendors
- Delete an Integration
- Method: deletePath:
/rest/v16/integrationVendors/{id}
- Get an Integration
- Method: getPath:
/rest/v16/integrationVendors/{id}
- Get List of Integrations
- Method: getPath:
/rest/v16/integrationVendors
- Update an Integration
- Method: patchPath:
/rest/v16/integrationVendors/{id}
Migration Package
Oracle CPQ supports Migration Package REST API endpoints to aid administrators in the creation, distribution, and deployment of migration packages to different environments. In order for the Migration Package REST API to be available in the Oracle CPQ Integration Catalog, log a Service Request on My Oracle Support.
- Create a Migration Package
- Method: postPath:
/rest/v16/migrationPackages
- Delete a Migration Package
- Method: deletePath:
/rest/v16/migrationPackages/{identifier}
- Export Migration Package
- Method: postPath:
/rest/v16/migrationPackages/{identifier}/actions/export
- Get All Migration Package Content
- Method: getPath:
/rest/v16/migrationPackages/{identifier}/contents
- Get List of Migration Packages
- Method: getPath:
/rest/v16/migrationPackages
- Get Migration Package Category Content
- Method: getPath:
/rest/v16/migrationPackages/{identifier}/contents/{category}
- Get Migration Package Content Dependencies
- Method: getPath:
/rest/v16/migrationPackages/{identifier}/contents/dependencies
- Get Migration Package Properties
- Method: getPath:
/rest/v16/migrationPackages/{identifier}
- Get Migration Package Resource Low-level Details
- Method: getPath:
/rest/v16/migrationPackages/{identifier}/contents/{category}/{variableName}
- Import Migration Package
- Method: postPath:
/rest/v16/migrationPackages/actions/import
- Migrate package
- Method: postPath:
/rest/v16/migrationPackages/actions/migrate
- Update a Migration Package
- Method: patchPath:
/rest/v16/migrationPackages/{identifier}
- Update Migration Package Content
- Method: putPath:
/rest/v16/migrationPackages/{identifier}/contents
- Update Migration Package Resource Low-level Details
- Method: putPath:
/rest/v16/migrationPackages/{identifier}/contents/{category}/{variableName}
- Upload Zip File for a Migration Package
- Method: postPath:
/rest/v16/migrationPackages/actions/uploadPackage
- Version a Migration Package
- Method: postPath:
/rest/v16/migrationPackages/{identifier}/actions/newVersion
Migration Package/Migration Resources
Migration Resource endpoints retrieve the data source entities that are required for successful migration. Oracle CPQ supports retrieving all migration resources, migration resources within a defined Oracle CPQ category, and specific migration resources from within a category.
- Get All Migration Resources
- Method: getPath:
/rest/v16/migrationResources
- Get Category Migration Resources
- Method: getPath:
/rest/v16/migrationResources/{category}
- Get Dependencies for Selected Migration Resources or a Migration Package from Source Site
- Method: postPath:
/rest/v16/migrationResources/dependencies
- Get Migration Resource Low-level Details
- Method: getPath:
/rest/v16/migrationResources/{category}/{variableName}
- Migrate Selected Migration Resources or Migration Package from Source Site
- Method: postPath:
/rest/v16/migrationResources/actions/migrate
Parts
This REST API is used to retrieve and search for Oracle CPQ parts. All endpoints are read-only; parts cannot be added, modified, or deleted using these web services.
- Get a Part
- Method: getPath:
/rest/v16/parts/{id}
- Get All Parts
- Method: getPath:
/rest/v16/parts
- Searches Parts List
- Method: postPath:
/rest/v16/parts/actions/search
Parts Setup
The Part Setup REST APIs enable administration of CPQ parts using REST API services.
- Create a Part
- Method: postPath:
/rest/v16/partSetups
- Create a Part Price
- Method: postPath:
/rest/v16/partSetups/{id}/prices
- Create a Part Translation
- Method: postPath:
/rest/v16/partSetups/{id}/translations
- Create Extended Descriptions for a Part
- Method: postPath:
/rest/v16/partSetups/{id}/extendedDescriptions
- Create Part Extended Description Translations
- Method: postPath:
/rest/v16/partSetups/{id}/extendedDescriptions/{descriptionsId}/translations
- Delete a Part
- Method: deletePath:
/rest/v16/partSetups/{id}
- Delete a Part Extended Description Translation
- Method: deletePath:
/rest/v16/partSetups/{id}/extendedDescriptions/{descriptionsId}/translations/{translationId}
- Delete a Part Price
- Method: deletePath:
/rest/v16/partSetups/{id}/prices/{priceId}
- Delete a Part Translation
- Method: deletePath:
/rest/v16/partSetups/{id}/translations/{translationId}
- Get a Part
- Method: getPath:
/rest/v16/partSetups/{id}
- Get a Part Extended Description Translation
- Method: getPath:
/rest/v16/partSetups/{id}/extendedDescriptions/{descriptionsId}/translations/{translationId}
- Get a Part Price
- Method: getPath:
/rest/v16/partSetups/{id}/prices/{priceId}
- Get a Part Translation
- Method: getPath:
/rest/v16/partSetups/{id}/translations/{translationId}
- Get All Part Extended Description Translations
- Method: getPath:
/rest/v16/partSetups/{id}/extendedDescriptions/{descriptionsId}/translations
- Get All Part Translations
- Method: getPath:
/rest/v16/partSetups/{id}/translations
- Get All Parts
- Method: getPath:
/rest/v16/partSetups
- Get All Prices for Part
- Method: getPath:
/rest/v16/partSetups/{id}/prices
- Get Part Extended Descriptions
- Method: getPath:
/rest/v16/partSetups/{id}/extendedDescriptions
- Get Part Extended Descriptions Using Extended Descriptions Id
- Method: getPath:
/rest/v16/partSetups/{id}/extendedDescriptions/{descriptionsId}
- Get Part Metadata Action
- Method: postPath:
/rest/v16/partSetups/actions/getPartMetadata
- Update a Part
- Method: putPath:
/rest/v16/partSetups/{id}
- Update a Part Price
- Method: putPath:
/rest/v16/partSetups/{id}/prices/{priceId}
- Update Part Extended Descriptions
- Method: putPath:
/rest/v16/partSetups/{id}/extendedDescriptions/{descriptionsId}
- Update/Insert Parts
- Method: postPath:
/rest/v16/partSetups/actions/upsertParts
Performance Logs
The REST API enables retrieving data about a sales user's activities and observed performance or other metrics during their interaction with the application. The information also provides application time as well as category information which can be used by customers to build their benchmark monitoring systems and proactively tackle any performance issues.
- Export Performance Log Event
- Method: postPath:
/rest/v16/performanceLogs/{id}/actions/export
- Export Performance Log Events
- Method: postPath:
/rest/v16/performanceLogs/actions/export
- Get All Performance Log Events
- Method: getPath:
/rest/v16/performanceLogs
- Get Performance Log Event
- Method: getPath:
/rest/v16/performanceLogs/{id}
Price Books
The Price Book REST APIs retrieve a list of Price Books or a specified Price Book. Price Books provide an additional method to associate parts with price. One part can be associated with multiple Price Books.
- Get All Price Books
- Method: getPath:
/rest/v16/priceBooks
- Get Price Book
- Method: getPath:
/rest/v16/priceBooks/{variableName}
- Get Price Book Translation
- Method: getPath:
/rest/v16/priceBooks/{variableName}/translations
Pricing Setup/Charge Attributes
These endpoints enable administration of Pricing Portal charge attributes using REST API services.
- Add Charge Attribute
- Method: postPath:
/rest/v16/pricingSetup/chargeAttributes
- Delete Charge Attribute
- Method: deletePath:
/rest/v16/pricingSetup/chargeAttributes/{attributeVarName}/
- Get Charge Attribute
- Method: getPath:
/rest/v16/pricingSetup/chargeAttributes/{attributeVarName}/
- Get Charge Attributes
- Method: getPath:
/rest/v16/pricingSetup/chargeAttributes
- Update Charge Attribute
- Method: patchPath:
/rest/v16/pricingSetup/chargeAttributes/{attributeVarName}/
- Update Charge Attributes
- Method: patchPath:
/rest/v16/pricingSetup/chargeAttributes
Pricing Setup/Charge Definitions
These endpoints enable administration of Pricing Portal charge definitions using REST API services.
- Add Charge Definition
- Method: postPath:
/rest/v16/pricingSetup/chargeDefinitions
- Delete Charge Definition
- Method: deletePath:
/rest/v16/pricingSetup/chargeDefinitions/{code}
- Get Charge Definitions
- Method: getPath:
/rest/v16/pricingSetup/chargeDefinitions
- Get Charge Defintion
- Method: getPath:
/rest/v16/pricingSetup/chargeDefinitions/{code}
- Update Charge Definition
- Method: patchPath:
/rest/v16/pricingSetup/chargeDefinitions/{code}
Pricing Setup/Price Agreements
The operations from the Pricing Setup/Price Agreements category.
- Add Price Agreement
- Method: postPath:
/rest/v16/pricingSetup/agreements
- Add Price Agreement Charge
- Method: postPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges
- Add Price Agreement Item
- Method: postPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems
- Add Price Agreement Rate Plan
- Method: postPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans
- Add Price Agreement Rate Plan Charge
- Method: postPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges
- Delete Price Agreement
- Method: deletePath:
/rest/v16/pricingSetup/agreements/{agreementVarName}
- Delete Price Agreement Charge
- Method: deletePath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges/{id}
- Delete Price Agreement Item
- Method: deletePath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}
- Delete Price Agreement Rate Plan
- Method: deletePath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}
- Delete Price Agreement Rate Plan Charge
- Method: deletePath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
- Get Price Agreement
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}
- Get Price Agreement Charge
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges/{id}
- Get Price Agreement Charges
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges
- Get Price Agreement Item
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}
- Get Price Agreement Items
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems
- Get Price Agreement Pricing Data
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/data
- Get Price Agreement Pricing Data Item
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/data/{id}
- Get Price Agreement Pricing Matrix Grid Data
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/matrixGrid
- Get Price Agreement Rate Plan
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}
- Get Price Agreement Rate Plan Charge
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
- Get Price Agreement Rate Plan Charges
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges
- Get Price Agreement Rate Plans
- Method: getPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans
- Get Price Agreements
- Method: getPath:
/rest/v16/pricingSetup/agreements
- Update Price Agreement
- Method: patchPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}
- Update Price Agreement Charge
- Method: patchPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges/{id}
- Update Price Agreement Charges
- Method: patchPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges
- Update Price Agreement Pricing Data
- Method: patchPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/data
- Update Price Agreement Pricing Matrix Grid Data
- Method: patchPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/matrixGrid
- Update Price Agreement Rate Plan
- Method: patchPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}
- Update Price Agreement Rate Plan Charge
- Method: patchPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
- Update Price Agreement Rate Plan Charges
- Method: patchPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges
- Update Price Agreement Rate Plans
- Method: patchPath:
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans
- Update Price Agreements
- Method: patchPath:
/rest/v16/pricingSetup/agreements
Pricing Setup/Price Items
These endpoints enable administration of Product Workbench pricing using REST API services.
- Add Price Item Charge Group
- Method: postPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups
- Add Price Item Charge Group Charge
- Method: postPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges
- Add Price Item Charge Group Rate Plan
- Method: postPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans
- Add Price Item Charge Group Rate Plan Charge
- Method: postPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges
- Add Price Item To Charge Group
- Method: postPath:
/rest/v16/pricingSetup/priceItems/actions/addItemToChargeGroup
- Delete Price Item Charge Group Charge
- Method: deletePath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges/{id}
- Delete Price Item Charge Group Rate Plan
- Method: deletePath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}
- Delete Price Item Charge Group Rate Plan Charge
- Method: deletePath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges/{id}
- Get Price Item
- Method: getPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}
- Get Price Item Charge Group
- Method: getPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}
- Get Price Item Charge Group Charge
- Method: getPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges/{id}
- Get Price Item Charge Group Charges
- Method: getPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges
- Get Price Item Charge Group Rate Plan
- Method: getPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}
- Get Price Item Charge Group Rate Plan Charge
- Method: getPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges/{id}
- Get Price Item Charge Group Rate Plan Charges
- Method: getPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges
- Get Price Item Charge Group Rate Plans
- Method: getPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans
- Get Price Item Charge Groups
- Method: getPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups
- Get Price Items
- Method: getPath:
/rest/v16/pricingSetup/priceItems
- Link or Unlink a Charge Group with a Price Item
- Method: patchPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}
- Search Price Items
- Method: postPath:
/rest/v16/pricingSetup/priceItems/actions/search
- Update Price Item Charge Group Charge
- Method: patchPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges/{id}
- Update Price Item Charge Group Charges
- Method: patchPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/charges
- Update Price Item Charge Group Rate Plan
- Method: patchPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}
- Update Price Item Charge Group Rate Plan Charge
- Method: patchPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges/{id}
- Update Price Item Charge Group Rate Plan Charges
- Method: patchPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans/{ratePlanNumber}/charges
- Update Price Item Charge Group Rate Plans
- Method: patchPath:
/rest/v16/pricingSetup/priceItems/{priceItemId}/chargeGroups/{chargeGroupId}/ratePlans
Pricing Setup/Price Models
These endpoints enable administration of Pricing Engine price models using REST API services.
- Add Price Model
- Method: postPath:
/rest/v16/pricingSetup/models
- Add Price Model Item
- Method: postPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems
- Add Price Model Item Charge
- Method: postPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/charges
- Add Price Model Item Rate Plan
- Method: postPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans
- Add Price Model Item Rate Plan Charge
- Method: postPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges
- Delete Price Model
- Method: deletePath:
/rest/v16/pricingSetup/models/{modelVarName}
- Delete Price Model Item
- Method: deletePath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}
- Delete Price Model Item Charge
- Method: deletePath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/charges/{id}
- Delete Price Model Item Rate Plan
- Method: deletePath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}
- Delete Price Model Item Rate Plan Charge
- Method: deletePath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges/{id}
- Get Price Model
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}
- Get Price Model Item
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}
- Get Price Model Item Charge
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/charges/{id}
- Get Price Model Item Charges
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/charges
- Get Price Model Item Rate Plan
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}
- Get Price Model Item Rate Plan Charge
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges/{id}
- Get Price Model Item Rate Plan Charges
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges
- Get Price Model Item Rate Plans
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans
- Get Price Model Items
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems
- Get Price Model Pricing Data
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/data
- Get Price Model Pricing Data Item
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/data/{id}
- Get Price Model Pricing Matrix Grid Data
- Method: getPath:
/rest/v16/pricingSetup/models/{modelVarName}/matrixGrid
- Get Price Models
- Method: getPath:
/rest/v16/pricingSetup/models
- Update Price Model
- Method: patchPath:
/rest/v16/pricingSetup/models/{modelVarName}
- Update Price Model Item Charge
- Method: patchPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/charges/{id}
- Update Price Model Item Charges
- Method: patchPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/charges
- Update Price Model Item Rate Plan
- Method: patchPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}
- Update Price Model Item Rate Plan Charge
- Method: patchPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges/{id}
- Update Price Model Item Rate Plan Charges
- Method: patchPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges
- Update Price Model Item Rate Plans
- Method: patchPath:
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/ratePlans
- Update Price Model Pricing Data Items
- Method: patchPath:
/rest/v16/pricingSetup/models/{modelVarName}/data
- Update Price Model Pricing Matrix Grid Data
- Method: patchPath:
/rest/v16/pricingSetup/models/{modelVarName}/matrixGrid
- Update Price Models
- Method: patchPath:
/rest/v16/pricingSetup/models
Pricing Setup/Pricing Actions
These endpoints enable administration of pricing export, import, and synchronization actions using REST API services.
- Export Pricing Entity
- Method: postPath:
/rest/v16/pricingSetup/actions/export
- Import Pricing Entity
- Method: postPath:
/rest/v16/pricingSetup/actions/import
- Submit Fusion Contracts Synchronization Task
- Method: postPath:
/rest/v16/pricingSetup/actions/syncWithFusionContracts
- Submit Fusion Pricing Synchronization Task
- Method: postPath:
/rest/v16/pricingSetup/actions/syncWithFusionPricing
Pricing Setup/Pricing Attributes
These endpoints enable administration of Pricing Engine pricing attributes using REST API services.
- Add Pricing Attribute
- Method: postPath:
/rest/v16/pricingSetup/attributes
- Add Pricing Attribute Mapping
- Method: postPath:
/rest/v16/pricingSetup/attributes/{attributeVarName}/mappings
- Delete Pricing Attribute
- Method: deletePath:
/rest/v16/pricingSetup/attributes/{attributeVarName}/
- Get Pricing Attribute
- Method: getPath:
/rest/v16/pricingSetup/attributes/{attributeVarName}/
- Get Pricing Attribute Mappings
- Method: getPath:
/rest/v16/pricingSetup/attributes/{attributeVarName}/mappings
- Get Pricing Attributes
- Method: getPath:
/rest/v16/pricingSetup/attributes
- Update Pricing Attribute
- Method: patchPath:
/rest/v16/pricingSetup/attributes/{attributeVarName}/
- Update Pricing Attribute Mappings
- Method: patchPath:
/rest/v16/pricingSetup/attributes/{attributeVarName}/mappings
- Update Pricing Attributes
- Method: patchPath:
/rest/v16/pricingSetup/attributes
Pricing Setup/Pricing Lookups
These endpoints enable administration or pricing lookup values that are available for use in product charges.
- Add Pricing Lookup Type
- Method: postPath:
/rest/v16/pricingSetup/pricingLookups
- Add Pricing Lookup Value
- Method: postPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues
- Add Pricing Lookup Value Translations
- Method: putPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues/{lookupCode}/translations/
- Delete Pricing Lookup Type
- Method: deletePath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}
- Delete Pricing Lookup Value
- Method: deletePath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues/{lookupCode}/
- Get Pricing Lookup Type
- Method: getPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}
- Get Pricing Lookup Types
- Method: getPath:
/rest/v16/pricingSetup/pricingLookups
- Get Pricing Lookup Value
- Method: getPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues/{lookupCode}/
- Get Pricing Lookup Value Translation
- Method: getPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues/{lookupCode}/translations/{languageCode}/
- Get Pricing Lookup Value Translations
- Method: getPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues/{lookupCode}/translations/
- Get Pricing Lookup Values
- Method: getPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues
- Update Pricing Lookup Type
- Method: patchPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}
- Update Pricing Lookup Types
- Method: patchPath:
/rest/v16/pricingSetup/pricingLookups
- Update Pricing Lookup Value
- Method: patchPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues/{lookupCode}/
- Update Pricing Lookup Values
- Method: patchPath:
/rest/v16/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues
Pricing Setup/Pricing Matrices & Templates
The operations from the Pricing Setup/Pricing Matrices & Templates category.
- Add Pricing Matrix
- Method: postPath:
/rest/v16/pricingSetup/matrixes
- Add Pricing Matrix Template
- Method: postPath:
/rest/v16/pricingSetup/matrixTemplates
- Add Pricing Matrix Template Column
- Method: postPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns
- Delete Pricing Matrix
- Method: deletePath:
/rest/v16/pricingSetup/matrixes/{pricingMatrixVarName}
- Delete Pricing Matrix Template
- Method: deletePath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/
- Delete Pricing Matrix Template Column
- Method: deletePath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns/{columnVarName}/
- Get Pricing Matrices
- Method: getPath:
/rest/v16/pricingSetup/matrixes
- Get Pricing Matrix
- Method: getPath:
/rest/v16/pricingSetup/matrixes/{pricingMatrixVarName}
- Get Pricing Matrix Data
- Method: getPath:
/rest/v16/pricingSetup/matrixes/{pricingMatrixVarName}/data
- Get Pricing Matrix Template
- Method: getPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/
- Get Pricing Matrix Template Column
- Method: getPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns/{columnVarName}/
- Get Pricing Matrix Template Column Translation
- Method: getPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns/{columnVarName}/translations/{languageCode}/
- Get Pricing Matrix Template Column Translations
- Method: getPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns/{columnVarName}/translations/
- Get Pricing Matrix Template Columns
- Method: getPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns
- Get Pricing Matrix Template Translation
- Method: getPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/translations/{languageCode}/
- Get Pricing Matrix Template Translations
- Method: getPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/translations/
- Get Pricing Matrix Templates
- Method: getPath:
/rest/v16/pricingSetup/matrixTemplates
- Get Pricing Matrix Translation
- Method: getPath:
/rest/v16/pricingSetup/matrixes/{pricingMatrixVarName}/translations/{languageCode}
- Get Pricing Matrix Translations
- Method: getPath:
/rest/v16/pricingSetup/matrixes/{pricingMatrixVarName}/translations
- Update Pricing Matrix
- Method: patchPath:
/rest/v16/pricingSetup/matrixes/{pricingMatrixVarName}
- Update Pricing Matrix Data
- Method: patchPath:
/rest/v16/pricingSetup/matrixes/{pricingMatrixVarName}/data
- Update Pricing Matrix Template
- Method: patchPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/
- Update Pricing Matrix Template Column
- Method: patchPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns/{columnVarName}/
- Update Pricing Matrix Template Column Translations
- Method: putPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns/{columnVarName}/translations/
- Update Pricing Matrix Template Columns
- Method: patchPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns
- Update Pricing Matrix Template Translations
- Method: putPath:
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/translations/
- Update Pricing Matrix Translations
- Method: putPath:
/rest/v16/pricingSetup/matrixes/{pricingMatrixVarName}/translations
Pricing Setup/Pricing Options
These endpoints enable administration of Pricing Options using REST API services.
- Get Pricing Options
- Method: getPath:
/rest/v16/pricingSetup/pricingOptions
- Update Pricing Options
- Method: patchPath:
/rest/v16/pricingSetup/pricingOptions
Pricing Setup/Pricing Previews
These endpoints enable administration of Pricing Previews using REST API services.
- Get Transaction Line Item Pricing Items
- Method: getPath:
/rest/v16/pricingSetup/preview/{bsId}/items/{docNumber}
- Get Transaction Pricing
- Method: getPath:
/rest/v16/pricingSetup/preview/{bsId}
- Get Transaction Pricing Items
- Method: getPath:
/rest/v16/pricingSetup/preview/{bsId}/items
Pricing Setup/Pricing Rules
These endpoints enable administration of Pricing Engine pricing rules using REST API services.
- Add Customer Specific Condition
- Method: postPath:
/rest/v16/pricingSetup/rules/{ruleVarName}/customerSpecificConditions
- Add Pricing Rule
- Method: postPath:
/rest/v16/pricingSetup/rules
- Delete Customer Specific Condition
- Method: deletePath:
/rest/v16/pricingSetup/rules/{ruleVarName}/customerSpecificConditions/{conditionId}
- Delete Pricing Rule
- Method: deletePath:
/rest/v16/pricingSetup/rules/{ruleVarName}
- Get Customer Specific Condition
- Method: getPath:
/rest/v16/pricingSetup/rules/{ruleVarName}/customerSpecificConditions/{conditionId}
- Get Customer Specific Conditions
- Method: getPath:
/rest/v16/pricingSetup/rules/{ruleVarName}/customerSpecificConditions
- Get Price Models Linked to Pricing Rule
- Method: getPath:
/rest/v16/pricingSetup/rules/{ruleVarName}/ruleModels
- Get Pricing Rule
- Method: getPath:
/rest/v16/pricingSetup/rules/{ruleVarName}
- Get Pricing Rules
- Method: getPath:
/rest/v16/pricingSetup/rules
- Link a Price Model to Pricing Rule
- Method: postPath:
/rest/v16/pricingSetup/rules/{ruleVarName}/ruleModels
- Unlink a Price Model from a Pricing Rule
- Method: deletePath:
/rest/v16/pricingSetup/rules/{ruleVarName}/ruleModels/{modelVarName}
- Update Customer Specific Condition
- Method: patchPath:
/rest/v16/pricingSetup/rules/{ruleVarName}/customerSpecificConditions/{conditionId}
- Update Customer Specific Conditions
- Method: patchPath:
/rest/v16/pricingSetup/rules/{ruleVarName}/customerSpecificConditions
- Update Price Model Linked to a Pricing Rule
- Method: patchPath:
/rest/v16/pricingSetup/rules/{ruleVarName}/ruleModels/{modelVarName}
- Update Price Models Linked to a Pricing Rule
- Method: patchPath:
/rest/v16/pricingSetup/rules/{ruleVarName}/ruleModels
- Update Pricing Rule
- Method: patchPath:
/rest/v16/pricingSetup/rules/{ruleVarName}
- Update Pricing Rules
- Method: patchPath:
/rest/v16/pricingSetup/rules
Pricing Setup/Rate Cards & Templates
These endpoints enable administration of Rate Cards and Rate Card Templates using REST API services.
- Add Rate Card
- Method: postPath:
/rest/v16/pricingSetup/rateCards
- Add Rate Card Template
- Method: postPath:
/rest/v16/pricingSetup/rateCardTemplates
- Add Rate Card Template Column
- Method: postPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns
- Add Rate Card Template Column Translations
- Method: putPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns/{id}/translations/
- Add Rate Card Template Translations
- Method: putPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/translations/
- Add Rate Card Translations
- Method: putPath:
/rest/v16/pricingSetup/rateCards/{rateCardVarName}/translations
- Delete Rate Card
- Method: deletePath:
/rest/v16/pricingSetup/rateCards/{rateCardVarName}
- Delete Rate Card Template
- Method: deletePath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/
- Delete Rate Card Template Column
- Method: deletePath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns/{id}/
- Get Rate Card
- Method: getPath:
/rest/v16/pricingSetup/rateCards/{rateCardVarName}
- Get Rate Card Data
- Method: getPath:
/rest/v16/pricingSetup/rateCards/{rateCardVarName}/data
- Get Rate Card Template
- Method: getPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/
- Get Rate Card Template Column
- Method: getPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns/{id}/
- Get Rate Card Template Column Translation
- Method: getPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns/{id}/translations/{languageCode}/
- Get Rate Card Template Column Translations
- Method: getPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns/{id}/translations/
- Get Rate Card Template Columns
- Method: getPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns
- Get Rate Card Template Translation
- Method: getPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/translations/{languageCode}/
- Get Rate Card Template Translations
- Method: getPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/translations/
- Get Rate Card Templates
- Method: getPath:
/rest/v16/pricingSetup/rateCardTemplates
- Get Rate Card Translation
- Method: getPath:
/rest/v16/pricingSetup/rateCards/{rateCardVarName}/translations/{languageCode}
- Get Rate Card Translations
- Method: getPath:
/rest/v16/pricingSetup/rateCards/{rateCardVarName}/translations
- Get Rate Cards
- Method: getPath:
/rest/v16/pricingSetup/rateCards
- Update Rate Card
- Method: patchPath:
/rest/v16/pricingSetup/rateCards/{rateCardVarName}
- Update Rate Card Data
- Method: patchPath:
/rest/v16/pricingSetup/rateCards/{rateCardVarName}/data
- Update Rate Card Template
- Method: patchPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/
- Update Rate Card Template Column
- Method: patchPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns/{id}/
- Update Rate Card Template Columns
- Method: patchPath:
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns
Pricing Setup/xLookups
The Pricing Engine references several other business objects within CPQ. These lookup APIs retrieve an unfiltered list of important values for the specified business object comprising a set of ids, lookup codes, meanings, and descriptions. For example, the lookup codes retrieved for accounts are the account Ids visible in the CPQ native Account Object. For parts, the lookup codes are part numbers.
- Get Account Lookups
- Method: getPath:
/rest/v16/pricingSetup/lookups/accounts
- Get an Account Lookup
- Method: getPath:
/rest/v16/pricingSetup/lookups/accounts/{lookupId}
- Get Attributes for a Data Source Lookup
- Method: getPath:
/rest/v16/pricingSetup/lookups/dataSources/{dataSourceVarName}/attributes
- Get Part Lookup
- Method: getPath:
/rest/v16/pricingSetup/lookups/parts/{lookupId}
- Get Part Lookups
- Method: getPath:
/rest/v16/pricingSetup/lookups/parts
- Get Simple Condition Attribute Lookups
- Method: getPath:
/rest/v16/pricingSetup/lookups/simpleConditionAttributes
- Get Supported Currency Lookup
- Method: getPath:
/rest/v16/pricingSetup/lookups/currencies/{lookupId}
- Get Supported Currency Lookups
- Method: getPath:
/rest/v16/pricingSetup/lookups/currencies
- Get Supported Data Source Lookups
- Method: getPath:
/rest/v16/pricingSetup/lookups/dataSources
Product Search
This REST API is used to retrieve and search for Oracle CPQ products. Products consist of both stand-alone parts and product structures (i.e. BOM hierarchies).
- Get a Product
- Method: getPath:
/rest/v16/products/{productId}
- Get All Products
- Method: getPath:
/rest/v16/products
- Search for Products
- Method: postPath:
/rest/v16/products/actions/search
SSO Configuration
SSO REST APIs are used to retrieve and configure the Security Assertion Markup Language (SAML) properties to enable Single Sign-On for multiple web applications.
- Configure Single Sign-On
- Method: postPath:
/rest/v16/ssoConfiguration
- Get Single Sign-On Properties
- Method: getPath:
/rest/v16/ssoConfiguration
Sales Companies, Groups, and Users
The operations from the Sales Companies, Groups, and Users category.
- Get Sales Companies
- Method: getPath:
/rest/v16/salesCompanies
- Get Sales Company
- Method: getPath:
/rest/v16/salesCompanies/{companyLogin}
- Get Sales Company Group
- Method: getPath:
/rest/v16/salesCompanies/{companyLogin}/groups/{groupVarName}
- Get Sales Company Groups
- Method: getPath:
/rest/v16/salesCompanies/{companyLogin}/groups
- Get Sales Company User
- Method: getPath:
/rest/v16/salesCompanies/{companyLogin}/users/{userLoginName}
- Get Sales Company Users
- Method: getPath:
/rest/v16/salesCompanies/{companyLogin}/users
- Get Sales Group
- Method: getPath:
/rest/v16/salesGroups/{id}
- Get Sales Groups
- Method: getPath:
/rest/v16/salesGroups
- Get Sales User
- Method: getPath:
/rest/v16/salesUsers/{key}
- Get Sales Users
- Method: getPath:
/rest/v16/salesUsers
Saved Searches
The Saved Search REST APIs allow administrators to manage CPQ Quotes List Saved Searches using REST web services.
- Create a Saved Search
- Method: postPath:
/rest/v16/searchResources/{resourceVarName}
- Delete a Saved Search
- Method: deletePath:
/rest/v16/searchResources/{resourceVarName}/{searchId}
- Get a Saved Search
- Method: getPath:
/rest/v16/searchResources/{resourceVarName}/{searchId}
- Get Saved Searches
- Method: getPath:
/rest/v16/searchResources/{resourceVarName}
- Update a Saved Search
- Method: patchPath:
/rest/v16/searchResources/{resourceVarName}/{searchId}
- Update Saved Search Access Permissions
- Method: postPath:
/rest/v16/searchResources/{resourceVarName}/accessSavedSearches
- Update Site Default Saved Search
- Method: postPath:
/rest/v16/searchResources/{resourceVarName}/entityPreferenceForSite
- Update User Default Saved Search
- Method: postPath:
/rest/v16/searchResources/{resourceVarName}/entityPreferenceForUser
Shopping Carts
The Shopping Cart REST APIs to support the Oracle CPQ Shopping Cart features. The Shopping Cart feature is based on user session, therefore, the Shopping Cart REST APIs cannot be used in headless mode.
- Add Selected Items to Quote
- Method: postPath:
/rest/v16/shoppingCarts/{processVarName}/actions/_addToQuote
- Check Out the Selected Items
- Method: postPath:
/rest/v16/shoppingCarts/{processVarName}/actions/_checkout
- Clear a Shopping Cart Item
- Method: deletePath:
/rest/v16/shoppingCarts/{processVarName}/shoppingCartItems/{id}
- Clear All Shopping Cart Items
- Method: postPath:
/rest/v16/shoppingCarts/{processVarName}/actions/_clearItems
- Get All Shopping Cart Items
- Method: getPath:
/rest/v16/shoppingCarts/{processVarName}/shoppingCartItems
- Get All Shopping Cart Layouts
- Method: getPath:
/rest/v16/shoppingCarts/{processVarName}/layouts
- Get List of All Shopping Carts
- Method: getPath:
/rest/v16/shoppingCarts
- Get Most Recent Shopping Cart
- Method: postPath:
/rest/v16/shoppingCarts/actions/_getMostRecentShoppingCart
- Get Shopping Cart
- Method: getPath:
/rest/v16/shoppingCarts/{processVarName}
- Get Shopping Cart (POST)
- Method: postPath:
/rest/v16/shoppingCarts/{processVarName}/actions/_getShoppingCart
- Get Shopping Cart Item
- Method: getPath:
/rest/v16/shoppingCarts/{processVarName}/shoppingCartItems/{id}
- Get Shopping Cart Layout
- Method: getPath:
/rest/v16/shoppingCarts/{processVarName}/layouts/{layoutVarName}
- Return to Quote
- Method: postPath:
/rest/v16/shoppingCarts/{processVarName}/actions/_returnToQuote
Tasks
Use the Task endpoints retrieve status for data table and migration tasks, cancel and delete tasks, and retrieve files associated with a task (e.g. log files and export zip files).
Note: The '/tasks/{taskId}/actions/cancel' endpoint is deprecated in Oracle CPQ 20B. Use the PATCH method of the '/rest/v9/tasks/{taskId}' endpoint to cancel tasks.
Note: The '/tasks/{taskId}/actions/cancel' endpoint is deprecated in Oracle CPQ 20B. Use the PATCH method of the '/rest/v9/tasks/{taskId}' endpoint to cancel tasks.
- Cancel Task
- Method: patchPath:
/rest/v16/tasks/{taskId}
- Delete Task
- Method: deletePath:
/rest/v16/tasks/{taskId}
- Delete Tasks
- Method: postPath:
/rest/v16/tasks/actions/deleteTasks
- Download a Task File
- Method: getPath:
/rest/v16/tasks/{taskId}/files/{fileName}
- Get List of Tasks
- Method: getPath:
/rest/v16/tasks
- Get Task
- Method: getPath:
/rest/v16/tasks/{taskId}
- Get Task File List
- Method: getPath:
/rest/v16/tasks/{taskId}/files
Unit Conversion
The Unit Conversion REST API provides support for unit conversion for Float Attributes.
Usage Metrics
Oracle CPQ Usage Metrics REST API allows administrators easy access to licensing information such as the total number of API licenses available and the number of API licenses consumed within a specified date/time range; total number of eCommerce interactions available and the number of eCommerce interactions consumed within a specified date/time range; total number of internal licenses purchased and the number of enabled internal licenses; and total number of channel licenses purchased and the number of enabled channel licenses for a Partner Organization.
- Get Usage Metrics
- Method: getPath:
/rest/v16/companies/usage
User Management
Oracle CPQ customers can leverage identity management solutions such as Oracle Identity Cloud Service (IDCS) to simplify the administration of users and passwords. CPQ's integration features simplify the implementation of identity services for Enterprise customers by allowing customers to delegate user management activities such as user creation, activation, revocation, and password management for host company users to IDCS or other Identity Service providers.
- Bulk Update User Status
- Method: postPath:
/rest/v16/users/actions/bulkUpdate
- Create Company User
- Method: postPath:
/rest/v16/companies/{companyName}/users
- Get All Company Users
- Method: getPath:
/rest/v16/companies/{companyName}/users
- Get All Users
- Method: getPath:
/rest/v16/users
- Get Company User Details
- Method: getPath:
/rest/v16/companies/{companyName}/users/{userName}
- Get User Access Permissions
- Method: getPath:
/rest/v16/companies/{companyName}/users/{userName}/accessPermissions
- Get User Groups
- Method: getPath:
/rest/v16/companies/{companyName}/users/{userName}/groups
- Get User Password Security Question
- Method: getPath:
/rest/v16/companies/{companyName}/users/{userName}/password
- Import Company Users
- Method: postPath:
/rest/v16/companies/{companyName}/users/actions/import
- Reset User Password
- Method: postPath:
/rest/v16/companies/{companyName}/users/{userName}/actions/resetPassword
- Update Company User
- Method: patchPath:
/rest/v16/companies/{companyName}/users/{userName}
- Update User Access Permissions
- Method: putPath:
/rest/v16/companies/{companyName}/users/{userName}/accessPermissions
- Update User Groups
- Method: putPath:
/rest/v16/companies/{companyName}/users/{userName}/groups
- Update User Security Question or Password
- Method: patchPath:
/rest/v16/companies/{companyName}/users/{userName}/password
- Update/Create Company User
- Method: putPath:
/rest/v16/companies/{companyName}/users/{userName}
User Management/SCIM Compliant
User Management REST APIs which are compliant with the System for Cross-domain Identity Management (SCIM) specification. The SCIM specification is an open standard that facilitates managing user identities across cloud-based applications and services.
- Add, Update or Remove User Information
- Method: patchPath:
/rest/v16/scim/users/{id}
- Create a User
- Method: postPath:
/rest/v16/scim/users
- Get a User
- Method: getPath:
/rest/v16/scim/users/{id}
- Get All Users
- Method: getPath:
/rest/v16/scim/users
- Inactivate a User
- Method: deletePath:
/rest/v16/scim/users/{id}
- Update a User
- Method: putPath:
/rest/v16/scim/users/{id}
User Navigation Links
The User Navigation Links REST API services support retrieving the user navigation links defined in the Navigation Menu for a site.
- Get All User Navigation Links
- Method: getPath:
/rest/v16/userNavigationLinks
User Personalizations
The User Personalizations REST API contains endpoints to manage Line Item Grid preferences for sales users using REST web services.
- Get a User Personalization
- Method: getPath:
/rest/v16/userPersonalizations/{personalizationName}
- Get All User Personalizations
- Method: getPath:
/rest/v16/userPersonalizations
- Reset User Personalization
- Method: postPath:
/rest/v16/userPersonalizations/actions/reset
- Save User Personalization
- Method: postPath:
/rest/v16/userPersonalizations/actions/save