Overview
These REST API endpoints provide web service support for administrative tasks associated with managing commerce process integrations.
Administration
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
https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo/integrations
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" } ] }
{ "id": 3023626061 }
|
Description |
Use this endpoint to retrieve available integrations for the specified commerce process. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/commerceProcessSetups/{processVarName}/integrations |
|
|
Endpoint Parameters |
processVarName |
Process variable name |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
| Response Body Parameters |
An array of 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 |
|
https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo/integrations
{ "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 Integration Initial Imports
|
Description |
Use this endpoint to retrieve enabled initial integration imports for the specified commerce process. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/commerceProcessSetups/{processVarName}/initialImports |
|
|
Endpoint Parameters |
processVarName |
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 |
|
https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo/initialImports
{ "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 Integration Settings
|
Description |
Use this endpoint to retrieve Commerce integration settings. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/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 |
|
https://sitename.oracle.com/rest/v19/commerceProcessSetups/integrationSettings
{ "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 Integration Types
|
Description |
Use this endpoint to retrieve commerce integrations types. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/commerceProcessSetups/integrationTypes |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
| Response Body Parameters |
An array of commerce 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 |
|
https://sitename.oracle.com/rest/v19/commerceProcessSetups/integrationTypes
{ "items": [{ "label": "Integration Cloud Service", "displayLabel": "Integration Cloud Service", "type": "MIDDLEWARE_IMPORT", "enabled": true }, { "name": "BML", "displayLabel": "[BML]", "type": "BML", "enabled": true } ] }
| Description | Use this endpoint to update an integration for the specified commerce process. | ||
|---|---|---|---|
| URI Endpoint |
/rest/v19/commerceProcessSetups/{processVarName}/integrations/{integrationVarName} |
||
| Endpoint Parameters |
processVarName |
Process variable name |
|
|
integrationVarName |
Integration variable name |
||
| HTTP Method |
PATCH |
||
| Request Header Content-Type | multipart/form-data | ||
| Request Body |
payload |
JSON payload of the 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 |
||
|
documentSelection |
Document selection 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 |
||
|
lineFilterType |
Line item 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 |
||
|
processVarName |
Process variable name |
||
|
promptName |
Prompt Name used for Quote Summary Integration |
||
|
queryParams |
This field takes the query parameters to be passed in the request to the above integration endpoint. |
||
|
ruleMetaId |
Rule Meta Id of BML function used for the Integration |
||
|
ruleType |
Specifies when the BML function is run |
||
|
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 |
||
|
queryFile |
SOAP Generator XSL |
||
|
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
-
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
https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo/integrations/test
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" } ] }
