Commerce Process Setups REST API

Overview

These REST API enpoints provide web service support for administrative tasks associated with managing processes

Administration

Commerce Process

Create a Commerce Process
Description	Use this endpoint to create a Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	autoUnlockActionIds	An array of action Ids to automatically unlock the transaction
	blockAutofill	Auto Fill Options
	continueOnTimeout	Execute action if associated integrations timeout
	deleteSecureAttributeEncryptionKey	Delete Secure Attribute Encryption Key if true
	description	Description of the process
	fiscalYearStartDate	Fiscal year start date
	initialImports	An array of Selected Imports
	layoutOptions	Layout options available for the process
	nonOwnerUnlock	Let other users perform unlock actions
	pageLength	Page length
	processName	Process name
	secureAttributeEncryptionKey	Secure Attribute Encryption Key Not allowed
	stage	Enabled Stages
	tabLabelDataMapId	Tab Label
	transactionEditingMode	Transaction Editing Mode
	type	Process type
	useRedwoodForTxnsList	Whether to use Redwood layout for quotes/transactions list
	variableName	Variable Name
Response Body Parameters	Returns one of the following: `processId` - the process Id, when creating a Blank Process `taskId` - the task Id, when creating a Standard Process

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups

Request Body Sample

{ "processName": "Test new blank process", "description": "process description", "variableName": "testNewBlankProcess", "pageLength": 30, "blockAutofill": 1, "type": 1, "fiscalYearStartDate": "12/30", "transactionEditingMode": 1, "nonOwnerUnlock": 0, "useRedwoodForTxnsList": true, "stage": 0 }

Response Body Sample

{ "processId": 12312 }

Delete an Undeployed Commerce Process

Delete an Undeployed Commerce Process
Description	Use this endpoint to delete an undeployed specified Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups/{processId}
Endpoint Parameters	processId	The Commerce process Id
HTTP Method	DELETE
Request Body Parameters	None
Success Response	204

Get Commerce Process Auto-Unlock Actions

Get Commerce Process Auto-Unlock Actions
Description	Use this endpoint to retrieve actions that automatically unlock the specified Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/autoUnlockActions
Endpoint Parameters	processVarName	The Commerce process variable name
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	An array of auto-unlock actions
	id	ID of auto-unlock action
	label	The label for the auto-unlock action
	variableName	The variable name of auto-unlock action
	selected	?

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/autoUnlockActions

Response Body Sample

{ "items": [ { "id": 3023136164, "label": "Revise Quote", "variableName": "_s_request_quote_revision", "selected": false }, { "id": 3022962141, "label": "Save", "variableName": "cleanSave_t", "selected": false }, { "id": 3023317342, "label": "Self Service Checkout", "variableName": "_s_selfServiceCheckout", "selected": false }, { "id": 3022962823, "label": "Update Asset", "variableName": "updateAsset", "selected": false }, { "id": 3023317346, "label": "Update Price Guidance", "variableName": "_s_updatePriceGuidance_t", "selected": false }, { "id": 3022962757, "label": "Update SFA", "variableName": "oRCL_SFA_UpdateOpportunity", "selected": false } ] }

Perform Commerce Process Deployment Center Actions

Perform Commerce Process Deployment Center Actions
Description	Use this endpoint to perform Deployment Center actions for the specified Commerce Process. The following actions can be performed: Deploy Process, Clone Process, Repopulate Column Data, Remove Transactions, Mass Update Transactions, Export Process, Delete Process, and Generate Schema and WSDL.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/deploymentCenter/actions
Endpoint Parameters	processVarName	The Commerce process variable name
HTTP Method	POST
Request Body Parameters	category	The deployment center action category
	emailTo	Email To address
	processVarName	The Commerce process variable name
	scheduledTime	The action scheduled time
	sendEmail	Specifies whether to send email
	stepIds	Step Ids
Response Body Parameters	taskId	The task Id

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/deploymentCenter/actions

Request Body Samples

Deploy Process Sample

{ "emailTo": "abcd@oracle.com", "sendEmail": true, "category": "DEPLOY_PROCESS", "scheduledTime": "12/06/2024 6:09 AM" }

Clone Process Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "CLONE_PROCESS", "scheduledTime": "12/06/2024 6:09 AM" }

Repopulate Data Columns Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "REPOPULATE_COLUMN_DATA", "scheduledTime": "12/06/2024 6:09 AM" }

Remove Transactions Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "REMOVE_TRANSACTION", "scheduledTime": "12/06/2024 6:09 AM" }

Mass Update Transactions Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "MASS_UPDATE_TRANSACTIONS", "scheduledTime": "12/06/2024 6:09 AM", "stepIds": "123456,234564,987654" }

Export Process Sample

{ "category": "BULK_DOWNLOAD" }

Delete Process Sample

{ "emailTo": "abcd.abcd@oracle.com", "sendEmail": true, "category": "DELETE_PROCESS", "scheduledTime": "12/06/2024 6:09 AM" }

Generate Schema and WSDL Sample

{ "category": "GENERATE_SCHEMA_AND_WSDL" }

Response Body Sample

{ taskId: 12345678 }

Update a Commerce Process

Update a Commerce Process
Description	Use this endpoint to update the specified Commerce Process. Specify the file to import in the request body. The request can also contain a description, target process variable name, a notification email address, an option to include a snapshot, and the option to delete other versions of the package.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}
Endpoint Parameters	processVarName	The Commerce process variable name
HTTP Method	PATCH
Request Header	Content-Type: multipart/form-data
Request Body Parameters	secureAttributeEncryptionKey	Secure attribute encryption key file The public key must be in the .CER format and equal to 2048 or more bytes.
	processSettings	JSON proccess settings
		autoUnlockActionIds	An array of action Ids to automatically unlock the transaction
		blockAutofill	Auto Fill Options
		continueOnTimeout	Execute action if associated integrations timeout
		deleteSecureAttributeEncryptionKey	Delete Secure Attribute Encryption Key if true
		description	Description of the process
		fiscalYearStartDate	Fiscal year start date
		initialImports	An array of Selected Imports Not allowed
		layoutOptions	Layout options available for the process
		nonOwnerUnlock	Let other users perform unlock actions
		pageLength	Page length
		processName	Process name
		secureAttributeEncryptionKey	Secure Attribute Encryption Key
		stage	Enabled Stages
		tabLabelDataMapId	Tab Label
		transactionEditingMode	Transaction Editing Mode
		type	Process type
		useRedwoodForTxnsList	Whether to use Redwood layout for quotes/transactions list
		variableName	Variable Name
Response Body Parameters	Returns one of the following: `processId` - the process Id, when creating a Blank Process `taskId` - the task Id, when creating a Standard Process

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo

Request Body Sample

payload: // JSON as text
{ "transactionEditingMode": 1, "stage": 3, "deleteSecureAttributeEncryptionKey": false, "blockAutofill": 2, "continueOnTimeout": 1, "nonOwnerUnlock": true, "fiscalYearStartDate": "02/29", "initialImports": [ 12321 ], "autoUnlockActionIds": [ 1234, 2345 ], "description": "Description is changed", "layoutOptions": { "generationRequested": 1, "layoutAccess": [{ "layoutType": 0, "priority": 3, "enabled": true }, { "layoutType": 1, "priority": 2, "enabled": true }, { "layoutType": 2, "priority": 1, "enabled": true } ] } },
resultFile: "test.cer", // File expected

Response Body Sample

{ "processId": 12312 }

Commerce Process Data Columns

Create a Commerce Process Data Column

Create a Commerce Process Data Column
Description	Use this endpoint to create a Data Column for the specified Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/dataColumns
Endpoint Parameters	processVarName	The Commerce process variable name
HTTP Method	POST
Request Body Parameters	attributeType	The type of attribute. Allowed values: 'COMMERCE' or 'CONFIG'
	catAttrId	Id of catalog attribute
	catModelId	Id of catalog model Id
	catPlineId	Id of catalog product line Id
	catSegmentId	Id of catalog segment Id
	cmAttrId	Id of the Commerce attribute
	documentId	The document Id
	isIndexed	Is Indexing enabled for the data column
	isKeywordSearch	Is keyword search enabled
	reportLabel	The report label
	searchLabel	The search label
	variableName	The variable name of the data column
Response Body Parameters	id	The data column Id

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/dataColumns

Request Body Sample

{ "attributeType": "COMMERCE", "documentId": 3023304905, "isIndexed": false, "isKeywordSearch": false, "cmAttrId": 3023312918, "catAttrId": -1, "searchLabel": "abc", "reportLabel": "abc", "variableName": "abcdhjiIIii_c", "catSegmentId": 50, "catPlineId": 3023271275, "catModelId": 3023271276 }

Response Body Sample

{ "id": 3023491496 }

Get Commerce Process Data Column References

Get Commerce Process Data Column References
Description	Use this endpoint to retrieve references to the specified Commerce Process Data Column.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/dataColumns/{id}
Endpoint Parameters	processVarName	The Commerce process variable name
Endpoint Parameters	id	The data column Id
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	Returns a list of reference items

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/dataColumns/18356111

Response Body Sample

{ "items": [ "Process Manager Column (Transaction Number)", "Search (My Approval Search)" ] }

Update a Commerce Process Data Column

Update a Commerce Process Data Column
Description	Use this endpoint to update the specified Commerce Process Data Column
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/dataColumns/{id}
Endpoint Parameters	processVarName	The Commerce process variable name
Endpoint Parameters	id	The data column Id
HTTP Method	PATCH
Request Body Parameters	attributeType	The type of attribute
	catAttrId	Id of catalog attribute
	catModelId	Id of catalog model Id
	catPlineId	Id of catalog product line Id
	catSegmentId	Id of catalog segment Id
	cmAttrId	Id of the Commerce attribute
	documentId	The document Id
	isIndexed	Is Indexing enabled for the data column
	isKeywordSearch	Is keyword search enabled
	reportLabel	The report label
	searchLabel	The search label
	variableName	The variable name of the data column
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/dataColumns/18356111

Request Body Sample

Commerce Process Documents

Create a Commerce Process Document

Create a Commerce Process Document
Description	Use this endpoint to create a main document or sub-document for the specified Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/documents
Endpoint Parameters	processVarName	The Commerce process variable name
HTTP Method	POST
Request Body Parameters	description	Description of the document
	label	Label of the document
	opportunityIdMapping	Stores the field name of mapped opportunity Id
	type	Type of document (Main or Sub)
	variableName	Variable name of the document
Response Body Parameters	description	Description of the document
	id	Id of the document
	label	Label of the document
	opportunityIdMapping	Stores the field name of mapped opportunity Id
	type	Type of document (Main or Sub)
	variableName	Variable name of the document

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/documents

Request Body Samples

Main Document Sample

{ "variableName": "maindocument_c", "label": "Main document", "description": "Description for the main document", "type": 0, "opportunityIdMapping": "transaction.opportunityNumber" }

Sub-Document Sample

{ "variableName": "subdocument_c", "label": "Sub document", "description": "Description for the sub document", "type": 1 }

Response Body Samples

Main Document Sample

{ "id": 1543613, "variableName": "maindocument_c", "label": "Main document", "description": "Description for the main document", "type": 0 }

Sub-Document Sample

{ "id": 1543614, "variableName": "subdocument_c", "label": "Sub document", "description": "Description for the sub document", "type": 1 }

Delete a Commerce Process Document

Delete a Commerce Process Document
Description	Use this endpoint to delete the specified undeployed Commerce Process document.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/documents/{id}
Endpoint Parameters	processVarName	The Commerce variable name
Endpoint Parameters	id	The Id of the Commerce process document
HTTP Method	DELETE
Request Body Parameters	None
Success Response	204

Get Commerce Process Document Modify Options

Get Commerce Process Document Modify Options
Description	Use this endpoint to retrieve modify options for the specified Commerce Process document.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/documents/{docVarName}/modifyTab
Endpoint Parameters	processVarName	The Commerce process variable name
Endpoint Parameters	docVarName	The Commerce process document variable name
Endpoint Query Parameters	This endpoint supports the following query specifications: `limit`, `offset`, and `q`. For more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	An array of Commerce process document modify option items
	attributeId	The attribute Id
	attributeLabel	The attribute label
	attributeVarName	The attribute variable name
	customAttribute	Specifies whether the attribute is custom or not
	formulaPresent	Specifies whether the attribute has formula defined
	overrideModify	Specifies whether the standard option should be overridden
	useFormula	Specifies whether formula should be used or not

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/automationStd/documents/transactionLine/modifyTab?limit=10&offset=0&q={"attributeVarName":"contactCity_t"}

Response Body Sample

{ "offset": 0, "limit": 2, "count": 2, "totalResults": 28, "hasMore": true, "items": [{ "attributeId": 3022948822, "useFormula": false, "overrideModify": false, "customAttribute": false, "formulaPresent": false, "attributeVarName": "_customer_t_company_name", "attributeLabel": "Customer Company Name" }, { "attributeId": 3022948844, "useFormula": false, "overrideModify": false, "customAttribute": false, "formulaPresent": false, "attributeVarName": "_customer_t_company_name_2", "attributeLabel": "Customer Company Name 2" } ] }

Update a Commerce Process Document

Update a Commerce Process Document
Description	Use this endpoint to update the specified Commerce Process document.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/documents/{docVarName}
Endpoint Parameters	processVarName	The Commerce process variable name
Endpoint Parameters	docVarName	The Commerce document variable name
HTTP Method	PATCH
Request Body Parameters	coverageEnabled	Indicates whether Coverage feature is enabled
	coverageMapping	Property object for storing coverage related mappings
	cvgStdDefaultOverride	Specifies whether the standard coverage options are overridden
	description	Description of the document
	id	Id of the document
	label	Label of the document
	modifyRuleExecPolicy	Indicates whether Modify Rule Exec Policy is enabled
	opportunityIdMapping	Stores the field name of mapped opportunity Id
	postAdvancedDefault	Property object for After Advanced Modify
	postAutoUpdate	Property object for After Auto Update
	preAdvancedDefault	Property object for Before Advanced Modify
	preAutoUpdate	Property object for Before Auto Update
	subDocId	Document Id of the linked sub-document
	type	Type of document (Main or Sub)
	variableName	Variable name of the document
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/documents/transaction

Request Body Samples

Standard Process Sample

{ "label": "Transaction", "variableName": "transaction", "subDocId": 62376263, "description": "Main (Header Level) Commerce Document - serves as Quote/ Order depending on step in process flow", "opportunityIdMapping": "transaction.opportunityNumber", "preAutoUpdate": { "overrideEnabled": false, "functionDefined": false } "postAutoUpdate": { "overrideEnabled": false, "functionDefined": true } "preAdvancedDefault": { "overrideEnabled": false, "functionDefined": true } }

Non-Standard Process Sample

{ "label": "Main", "variableName": "main", "subDocId": 62376263, "description": "test126", "opportunityIdMapping": "", "preAutoUpdate": { "functionDefined": false }, "postAutoUpdate": { "functionDefined": true }, "preAdvancedDefault": { "functionDefined": false } }

Update Commerce Process Document Modify Options

Update Commerce Process Document Modify Options
Description	Use this endpoint to update modify options for the specified Commerce Process document.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/documents/{docVarName}/modifyTab
Endpoint Parameters	processVarName	The Commerce process variable name
Endpoint Parameters	docVarName	The Commerce process document variable name
HTTP Method	PATCH
Request Body Parameters	The array of Commerce process document modify option items
	attributeId	The attribute Id
	attributeLabel	The attribute label
	attributeVarName	The attribute variable name
	customAttribute	Specifies whether the attribute is custom or not
	formulaPresent	Specifies whether the attribute has formula defined
	overrideModify	Specifies whether the standard option should be overridden
	useFormula	Specifies whether formula should be used or not
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/automationStd/documents/transactionLine/modifyTab

Request Body Sample

{ "items": [ { "attributeId": 3022948910, "useFormula": true, "overrideModify": false, "customAttribute": false, "attributeVarName": "_customer_t_city" } ] }

Commerce Process Integrations

Create a Commerce Process Integration

Create a Commerce Process Integration
Description	Use this endpoint to create an integration for the specified Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/integrations
Endpoint Parameters	processVarName	The Commerce process variable name
HTTP Method	POST
Request Header Content-Type	multipart/form-data
Request Body Parameters	batchSize	Quote lines to be integrated in a single invocation for the Integration
	childEntity	Name of the child resource from metadata for mapping attributes.
	description	Description of the Integration
	endpoint	ICS Endpoint for the Integration.
	filterField	Filter Field used for the Integration if Custom Line Type Filter is selected
	headers	This field takes the headers to be passed in the request to the integration endpoint
	id	Id of the integration
	instanceType	Specifies when the BML function is run
	integrationVendorVarName	Integration Vendor Variable Name of the Integration
	isPreview	Indicates whether preview contract is enabled for the Integration
	lineSelection	Line Type Filter of the Integration
	metadataURL	The endpoint to retrieve the metadata about CRM attributes available for mapping for this integration.
	name	Name of the Integration
	partnerAttachmentField	Partner Attachment Field of the Integration
	partnerIdField	This field indicates which Commerce attribute stores the external ID of the object being updated by the integration
	payload	JSON payload of the parameters
	promptName	Prompt Name used for Quote Summary Integration
	queryParams	This field takes the query params to be passed in the request to the above integration endpoint.
	ruleMetaId	Rule Meta Id of BML function used for the Integration
	serviceName	Service Name of the Integration
	serviceVarName	Service Variable Name of the Integration
	timeout	Timeout of the Integration
	type	Type of the Integration
	variableName	Variable Name of the Integration
Request Files	queryFile	SOAP Generator XSL
Request Files	resultFile	Result Parser XSL
Response Body Parameters	id	Id of the integration

Allowed Request Fields for Integration Types

BML: id, variableName, name, description, type, runType, ruleMetaId
Contact Management: id, variableName, name, description, type, timeout, preview, partnerAttachmentField, resultFile, queryFile
Integration Cloud Service: variableName, name, description, type, timeout, endpoint
REST Export: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity
REST Export Lines: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity, batchSize, lineTypeFilter, filterField
REST Import: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity, batchSize, queryParams.value, queryParams.key, documentSelection
SOAP Export: id, variableName, name, description, type, timeout, endpoint, partnerIdField, resultFile, queryFile
SOAP Import: id, variableName, name, description, type, timeout, endpoint, partnerIdField, resultFile, queryFile

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/integrations

Request Body Samples

SOAP Import Sample

payload: // JSON as text { "variableName": "testVar6_c", "name": "testVar3", "description": "ics descpr", "type": "SOAP_IMPORT", "timeout": 100, "endpoint": "sitename.oracle.com", "partnerIdField": "a.b", "metadataURL": "123", "documentSelection": "MAIN_DOCUMENT" }, resultFile: "test.xsl", // File expected queryFile: "test2.xsl" // File expected

REST Export Sample

payload: { "id": -1, "variableName": "testVar2_c", "name": "testVar1_c", "description": "ics desc", "type": "REST_EXPORT", "timeout": 100, "documentSelection": "MAIN_DOCUMENT", "batchSize": 1, "runType": "GENERIC", "endpoint": "sitename.oracle.com", "partnerIdField": "a.b", "metadataURL": "123", "promptName": "khabce", "queryParams": [{ "key": "a", "value": "b" }, { "key": "c", "value": "d" } ] }

Response Body Sample

{ "id": 3023626061 }

Get Commerce Process Integration Initial Imports

Get Commerce Process Integration Initial Imports
Description	Use this endpoint to retrieve enabled initial integration imports for the specified Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/initialImports
Endpoint Parameters	processVarName	The Commerce process variable name
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	An array of enabled initial import items
	integrationId	The integration Id
	name	The name of the integration
	selected	The initial imports Ids that are selected
	type	The integration type

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/initialImports

Response Body Sample

{ "items": [{ "integrationId": 3023136163, "Name": "Get so status form FO", "type": "BML", "selected": false }, { "integrationId": 3023290263, "Name": "Rest import opportunity", "type": "REST - Import", "selected": true }, { "integrationId": 3022962251, "Name": "Cancel So from CPQ", "variableName": "BML", "selected": false } ] }

Get Commerce Process Integrations

Get Commerce Process Integrations
Description	Use this endpoint to retrieve available integrations for the specified Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/integrations
Endpoint Parameters	processVarName	The Commerce process variable name
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	An array of Commerce process integrations items
	description	The integration description
	id	The integration Id
	idField	This field indicates which Commerce attribute stores the external Id of the object being updated by the integration
	modifiedDate	Latest date in which the integration was modified
	name	The name of the integration
	orderNo	Order number of the Integration in the list
	type	The type of integration

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/integrations

Response Body Sample

{ "items": [{ "orderNo": 5, "name": "Sync Quote Lines", "type": "REST - Export Lines", "idField": "transaction.oRCL_SFA_TransactionID_t", "description": "Creates, updates or deletes the SFA quote line", "modifiedDate": "09/23/2024 02:32" } ] }

Get Commerce Process Integration Settings

Get Commerce Process Integration Settings
Description	Use this endpoint to retrieve Commerce Process integration settings.
URI Endpoint	/rest/v18/commerceProcessSetups/integrationSettings
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	defaultBatchSize	Default batch size used for integration
	docSelections	Document selections list for drop-down
	instanceTypes	Instance types list for drop-down
	lineTypeFilters	Line type filters list for drop-down

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/integrationSettings

Response Body Sample

{ "defaultBatchSize": 500, "instanceTypes": { "items": [{ "value": "GENERIC", "displayValue": "Always Run" }, { "value": "DYNAMICS", "displayValue": "Requires Partner Session" } ] }, "lineTypeFilters": { "items": [{ "value": "ROOT_LINES", "displayValue": "Root Lines" }, { "value": "PART_LINES", "displayValue": "Part Lines" }, { "value": "ALL_LINES", "displayValue": "All Lines" }, { "value": "CUSTOM", "displayValue": "Custom" } ] }, "docSelections": { "items": [{ "value": "MAIN_DOCUMENT", "displayValue": "Main Document" }, { "value": "SUB_DOCUMENT", "displayValue": "Sub Document" } ] } }

Get Commerce Process Integration Types

Get Commerce Process Integration Types
Description	Use this endpoint to retrieve integration types for the specified Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups/integrationTypes
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	An array of Commerce process integration type items
	displayLabel	Language translated display label for the integration type
	enabled	Indicates whether integration type is enabled or not
	label	Label for the integration type
	type	Variable name or key value of the integration type

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/integrationTypes

Response Body Sample

{ "items": [{ "label": "Integration Cloud Service", "displayLabel": "Integration Cloud Service", "type": "MIDDLEWARE_IMPORT", "enabled": true }, { "name": "BML", "displayLabel": "[BML]", "type": "BML", "enabled": true } ] }

Update a Commerce Process Integration

Update a Commerce Process Integration
Description	Use this endpoint to update an integration for the specified Commerce Process.
URI Endpoint	/rest/v18/commerceProcessSetups/{processVarName}/integrations
Endpoint Parameters	processVarName	The Commerce process variable name
HTTP Method	PATCH
Request Header Content-Type	multipart/form-data
Request Body Parameters	batchSize	Quote lines to be integrated in a single invocation for the Integration
	childEntity	Name of the child resource from metadata for mapping attributes.
	description	Description of the Integration
	endpoint	ICS Endpoint for the Integration.
	headers	This field takes the headers to be passed in the request to the integration endpoint
	id	Id of the integration
	instanceType	Specifies when the BML function is run
	integrationVendorVarName	Integration Vendor Variable Name of the Integration
	isPreview	Indicates whether preview contract is enabled for the Integration
	metadataURL	The endpoint to retrieve the metadata about CRM attributes available for mapping for this integration.
	name	Name of the Integration
	partnerAttachmentField	Partner Attachment Field of the Integration
	partnerIdField	This field indicates which Commerce attribute stores the external ID of the object being updated by the integration
	payload	JSON payload of the parameters
	promptName	Prompt Name used for Quote Summary Integration
	queryParams	This field takes the query params to be passed in the request to the above integration endpoint.
	ruleMetaId	Rule Meta Id of BML function used for the Integration
	serviceName	Service Name of the Integration
	serviceVarName	Service Variable Name of the Integration
	timeout	Timeout of the Integration
	type	Type of the Integration
	variableName	Variable Name of the Integration
Request Files	queryFile	SOAP Generator XSL
Request Files	resultFile	Result Parser XSL
Success Response	204

Allowed Request Fields for Integration Types

BML: id, variableName, name, description, type, runType, ruleMetaId
Contact Management: id, variableName, name, description, type, timeout, preview, partnerAttachmentField, resultFile, queryFile
Integration Cloud Service: variableName, name, description, type, timeout, endpoint
REST Export: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity
REST Export Lines: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity, batchSize
REST Import: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity, batchSize, queryParams.value, queryParams.key
SOAP Export: id, variableName, name, description, type, timeout, endpoint, partnerIdField, documentSelection, resultFile, queryFile
SOAP Import: id, variableName, name, description, type, timeout, endpoint, partnerIdField, resultFile, queryFile

URI Endpoint Sample

https://sitename.oracle.com/rest/v18/commerceProcessSetups/oraclecpqo/integrations/test

Request Body Samples

SOAP Import Sample

payload: // JSON as text { "variableName": "test", "name": "testVar3", "description": "ics descpr", "type": "SOAP_IMPORT", "timeout": 100, "endpoint": "sitename.oracle.com", "partnerIdField": "a.b", "metadataURL": "123", "documentSelection": "MAIN_DOCUMENT" }, resultFile: "test.xsl", // File expected queryFile: "test2.xsl" // File expected

REST Export Sample

payload: { "id": -1, "variableName": "test", "name": "testVar1_c", "description": "ics desc", "type": "REST_EXPORT", "timeout": 100, "documentSelection": "MAIN_DOCUMENT", "batchSize": 1, "runType": "GENERIC", "endpoint": "sitename.oracle.com", "partnerIdField": "a.b", "metadataURL": "123", "promptName": "khabce", "queryParams": [{ "key": "a", "value": "b" }, { "key": "c", "value": "d" } ] }

Commerce Process Setups REST API

Overview

Administration