Commerce Process REST APIs

Overview

Commerce Process REST APIs provide access to process level data. If you are using a custom process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

Administration

ClosedCustom Process Endpoint Parameters

Commerce REST APIs use the following resource paths for the standard process:

  • Main document /commerceDocumentsOraclecpqoTransaction

  • Sub document /commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine

The following variable may differ for custom processes:

  • {Stage} The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders) e.g. Documents

  • {ProcessVarName} The variable name of the commerce process, note the first letter must be capitalized. e.g. Oraclecpqo

  • {MainDocVarName} The variable name of the main document, note the first letter must be capitalized. e.g. Transaction

  • {id} The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. e.g. 36365444

  • {subDocVarName} The sub-document number e.g. transactionLine

Commerce REST APIs use the following resource paths for the standard process:

  • Main document /commerceDocumentsOraclecpqoTransaction

  • Sub document /commerceDocumentsOraclecpqoTransaction/{id}/TransactionLine

The following variable may differ for custom processes:

  • {Stage} The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders) e.g. Documents

  • {ProcessVarName} The variable name of the commerce process, note the first letter must be capitalized. e.g. Oraclecpqo

  • {MainDocVarName} The variable name of the main document, note the first letter must be capitalized. e.g. Transaction

  • {id} The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site. e.g. 36365444

  • {subDocVarName} The sub-document number e.g. transactionLine

ClosedArchive Transactions

Archive Transactions Post method

Description

Use this endpoint to archive the specified transactions.

Note: This action is only available for Application Administrators.

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_archive_transactions
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

Request Body Parameters

 

selectionCriteria

This criteria query definition is used to specify items for collection-based process actions. selectionCriteria supports the following parameters:

  • fields - An array of field names to be returned.

  • orderby - An array of field names to specify the order of items returned in the response

  • q - A filter (a "where" clause) to restrict the items returned in the collection. By default, no filtering is applied.

HTTP Method

POST

Success Response

204 No Content

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_archive_transactions

ClosedRequest Sample

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

ClosedCopy Sequence

Copy Sequence Post method

Description

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

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_copy_sequence
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

HTTP Method

POST

Request Parameters

 None
Response Parameters

sequences

 An array of sequence definitions

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_copy_sequence

ClosedResponse Sample

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

ClosedDelete Archived Transactions

Delete Archived Transactions Post method

Description

Use this endpoint to delete the specified archived transactions.

Note: This action is only available for Application Administrators.

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_delete_archived_transactions
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

Request Body Parameters

selectionCriteria

An array of archived transaction id items to be deleted.

HTTP Method

POST

Success Response

204 No Content

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_delete_archived_transactions

ClosedRequest Sample

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

ClosedExport Transactions

Export Transactions Post method

Description

Use this endpoint to export selected data column values for all selected transactions in a zipped excel file.

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/export_transactions
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

id

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

HTTP Method

POST

Request Body Parameters

selectionCriteria

This criteria query definition is used to specify items for collection-based process actions. selectionCriteria supports the following parameters:

  • fields - An array of field names to be returned.

  • orderby - An array of field names to specify the order of items returned in the response

  • q - A filter (a "where" clause) to restrict the items returned in the collection. By default, no filtering is applied.
Response Body Parameters

fileUrl

The URL of the file.

warnings

Array of messages that have been generated for a specific object.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/export_transactions

ClosedRequest Body Sample

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

ClosedResponse Body Sample

ClosedForward Transactions

Forward Transactions Post method

Description

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

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_forward
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

HTTP Method

POST

Request Body Parameters

 

company

The company name

ids

The list of transactions that are forwarded to user / groups

salesGroups

List of sales groups to forward the transaction to

salesUsers

List of sales use logins to forward the transaction to

Success Response

204 No Content
Quick registration - buy type users cannot be targeted using this endpoint.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_forward

ClosedRequest Sample

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

ClosedGet Archived Transactions

Get Archived Transactions Post method

Description

Use this endpoint to retrieve a list of archived transactions.

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

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_get_archived_transactions
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

Request Body Parameters

criteria

The criteria query definition supports the following parameters to retrieve specific content and limit the size of the response.

  • actions - An array of action names, whose state is requested in the state object response.

  • childDefs - An array of child query definitions that specifies query requests for child resources.

  • enableHierarchy - This Boolean parameter is used to enable hierarchical search and sort. Default value is false.

  • excludeFieldTypes - An array of field names that you want to exclude in the response.

  • expandedDomainCriteria - A map of dynamic menu field names, whose expanded domains are requested in the state object response.

  • expandedDomains - An array of field names, whose expanded domains are requested in the state object response.

  • expandNodes - This Boolean parameter is used to expand nodes and is only be available when enableHierarchy is true.

  • expand - An array of child resource names that you want to expand so that the contents return with the parent in the same request.

  • fields - An array of field names to be returned. The fields array values determine the "attributes" in the response's state object.

  • groups - An array of group names, whose state is requested in the state object response.

  • layoutRules - This parameter specifies the state of layout rules which need to be fetched and executed. By default, this value is set to NO_RULE indicating that layout rules is not executed.

  • limit - A positive integer value that specifies the maximum number of items returned by the server.

  • nodesExceptionList - An array of document numbers recording the nodes that violate current expandNodes flag.

  • offset - A non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.

  • orderby - An array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.

  • parentFields - An array of field names to include in the parentFields of each resource row.

  • q - A filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.

  • rootFields - An array of field names to include in the rootFields of each resource row.

  • state - This Boolean parameter specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.

  • totalResults - This Boolean parameter specifies whether to calculate the total results. By default, this value is set to false indicating that total results is not calculated.

HTTP Method

POST

Response Body Parameters

documents

The transaction collection

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_get_archived_transactions

ClosedRequest Sample

{ "criteria": { "orderby": ["_id:DESC"], "totalResults": true, "limit": 2, "offset": 0 } }

ClosedResponse Sample

{ "documents": { "offset": 0, "limit": 2, "count": 2, "hasMore": true, "items": [{ { "documents": { "totalResults": 3, "offset": 0, "limit": 2, "count": 2, "hasMore": true, "items": [{ "totalOneTimeListAmount_t": { "value": 0.0, "currency": "USD" }, "_locked_by_user_login": null, "lastUpdatedDate_t": "2024-05-22T21:15:00Z", "_document_var_name": "transaction", "lastPricedDate_t": "2024-05-22T21:11:00Z", "_customer_id": "300100122967029", "_customer_t_company_name": "Vision Development US)", "totalAnnualValue_t": { "value": 0.0, "currency": "USD" }, "totalContractValue_t": { "value": 0.0, "currency": "USD" }, "_locked_time": null, "createdDate_t": "2024-05-22", "_date_modified": "2024-06-09T15:11:09.000Z", "_last_document_number": 6, "_date_added": "2024-06-09T15:11:09.000Z", "transactionName_t": "05/22 Vision Development US)", "_id": 38780366, "_pp_id": null, "owner_t": "Albert M", "_process_var_name": "oraclecpqo", "_locked_by_user_first_name": null, "_step_var_name": "pending_process", "totalOneTimeNetAmount_t": { "value": 0.0, "currency": "USD" }, "_lock_status": null, "totalMonthlyListAmount_t": { "value": 0.0, "currency": "USD" }, "_locked_by_user_last_name": null, "version_t": 1, "transactionID_t": "CPQ-90124B", "_buyer_company_name": "cpq-techwriter1", "totalMonthlyDiscount_t": { "value": 0.0, "currency": "USD" }, "_date_tx_modified": "2024-05-22T21:15:57.000Z", "_supplier_company_name": "cpq-techwriter1", "_locked_by_user": null, "version_number_versionTransaction_t": "1", "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_pp_name": null, "priceWithinPolicy_t": true, "totalOneTimeDiscount_t": { "value": 0.0, "currency": "USD" }, "status_t": { "value": "CREATED", "displayValue": "Created" }, "totalMonthlyNetAmount_t": { "value": 0.0, "currency": "USD" } }, { "totalOneTimeListAmount_t": { "value": 0.0, "currency": "USD" }, "_locked_by_user_login": null, "lastUpdatedDate_t": "2024-05-22T21:05:00Z", "_document_var_name": "transaction", "lastPricedDate_t": "2024-05-06T21:32:00Z", "_customer_id": "300100122967029", "_customer_t_company_name": "Vision Development US)", "totalAnnualValue_t": { "value": 0.0, "currency": "USD" }, "totalContractValue_t": { "value": 0.0, "currency": "USD" }, "_locked_time": null, "createdDate_t": "2024-05-06", "_date_modified": "2024-06-09T15:11:19.000Z", "_last_document_number": 3, "_date_added": "2024-06-09T15:11:19.000Z", "transactionName_t": "05/06 Vision Development US)", "_id": 38736262, "_pp_id": null, "owner_t": "Albert M", "_process_var_name": "oraclecpqo", "_locked_by_user_first_name": null, "_step_var_name": "pending_process", "totalOneTimeNetAmount_t": { "value": 0.0, "currency": "USD" }, "_lock_status": null, "totalMonthlyListAmount_t": { "value": 0.0, "currency": "USD" }, "_locked_by_user_last_name": null, "version_t": 1, "transactionID_t": "CPQ-90024B", "_buyer_company_name": "cpq-techwriter1", "totalMonthlyDiscount_t": { "value": 0.0, "currency": "USD" }, "_date_tx_modified": "2024-05-22T21:06:23.000Z", "_supplier_company_name": "cpq-techwriter1", "_locked_by_user": null, "version_number_versionTransaction_t": "1", "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_pp_name": null, "priceWithinPolicy_t": true, "totalOneTimeDiscount_t": { "value": 0.0, "currency": "USD" }, "status_t": { "value": "CREATED", "displayValue": "Created" }, "totalMonthlyNetAmount_t": { "value": 0.0, "currency": "USD" } } ] } } "totalOneTimeListAmount_t": { "value": 5899.0, "currency": "USD" }, "_locked_by_user_login": null, "lastUpdatedDate_t": "2024-02-02T17:47:00Z", "_document_var_name": "transaction", "lastPricedDate_t": "2024-02-02T13:28:00Z", "_customer_id": "300100122967029", "_customer_t_company_name": "Vision Development US)", "totalAnnualValue_t": { "value": 612.0, "currency": "USD" }, "totalContractValue_t": { "value": 6511.0, "currency": "USD" }, "_locked_time": null, "createdDate_t": "2024-02-02", "_date_modified": "2024-06-09T15:11:26.000Z", "_last_document_number": 6, "_date_added": "2024-06-09T15:11:26.000Z", "transactionName_t": "02/02 Vision Development US)", "_id": 38642415, "_pp_id": null, "owner_t": "Albert M", "_process_var_name": "oraclecpqo", "_locked_by_user_first_name": null, "_step_var_name": "pending_process", "totalOneTimeNetAmount_t": { "value": 5899.0, "currency": "USD" }, "_lock_status": null, "totalMonthlyListAmount_t": { "value": 306.0, "currency": "USD" }, "_locked_by_user_last_name": null, "version_t": 1, "transactionID_t": "CPQ-89924B", "_buyer_company_name": "cpq-techwriter1", "totalMonthlyDiscount_t": { "value": 0.0, "currency": "USD" }, "_date_tx_modified": "2024-05-17T20:49:31.000Z", "_supplier_company_name": "cpq-techwriter1", "_locked_by_user": null, "version_number_versionTransaction_t": "1", "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_pp_name": null, "priceWithinPolicy_t": true, "totalOneTimeDiscount_t": { "value": 0.0, "currency": "USD" }, "status_t": { "value": "CREATED", "displayValue": "Created" }, "totalMonthlyNetAmount_t": { "value": 306.0, "currency": "USD" } }, { "totalOneTimeListAmount_t": { "value": 0.0, "currency": "USD" }, "_locked_by_user_login": null, "lastUpdatedDate_t": "2024-05-22T21:05:00Z", "_document_var_name": "transaction", "lastPricedDate_t": "2024-05-06T21:32:00Z", "_customer_id": "300100122967029", "_customer_t_company_name": "Vision Development US)", "totalAnnualValue_t": { "value": 0.0, "currency": "USD" }, "totalContractValue_t": { "value": 0.0, "currency": "USD" }, "_locked_time": null, "createdDate_t": "2024-05-06", "_date_modified": "2024-06-09T15:11:19.000Z", "_last_document_number": 3, "_date_added": "2024-06-09T15:11:19.000Z", "transactionName_t": "05/06 Vision Development US)", "_id": 38736262, "_pp_id": null, "owner_t": "Albert M", "_process_var_name": "oraclecpqo", "_locked_by_user_first_name": null, "_step_var_name": "pending_process", "totalOneTimeNetAmount_t": { "value": 0.0, "currency": "USD" }, "_lock_status": null, "totalMonthlyListAmount_t": { "value": 0.0, "currency": "USD" }, "_locked_by_user_last_name": null, "version_t": 1, "transactionID_t": "CPQ-90024B", "_buyer_company_name": "cpq-techwriter1", "totalMonthlyDiscount_t": { "value": 0.0, "currency": "USD" }, "_date_tx_modified": "2024-05-22T21:06:23.000Z", "_supplier_company_name": "cpq-techwriter1", "_locked_by_user": null, "version_number_versionTransaction_t": "1", "_currency_pref": { "id": 5190368, "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v19/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/currencies/USD" } ] }, "_pp_name": null, "priceWithinPolicy_t": true, "totalOneTimeDiscount_t": { "value": 0.0, "currency": "USD" }, "status_t": { "value": "CREATED", "displayValue": "Created" }, "totalMonthlyNetAmount_t": { "value": 0.0, "currency": "USD" } } ] } }

ClosedGroup (Aggregate) Transactions

Group (Aggregate) Transactions Post method

Description

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

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_aggregate
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

HTTP Method

POST

Request Body Parameters

aggregate

Captures information to aggregate transactions.

criteria

The criteria query definition supports the following parameters to retrieve specific content and limit the size of the response.

  • actions - An array of action names, whose state is requested in the state object response.

  • childDefs - An array of child query definitions that specifies query requests for child resources.

  • enableHierarchy - This Boolean parameter is used to enable hierarchical search and sort. Default value is false.

  • excludeFieldTypes - An array of field names that you want to exclude in the response.

  • expandedDomainCriteria - A map of dynamic menu field names, whose expanded domains are requested in the state object response.

  • expandedDomains - An array of field names, whose expanded domains are requested in the state object response.

  • expandNodes - This Boolean parameter is used to expand nodes and is only be available when enableHierarchy is true.

  • expand - An array of child resource names that you want to expand so that the contents return with the parent in the same request.

  • fields - An array of field names to be returned. The fields array values determine the "attributes" in the response's state object.

  • groups - An array of group names, whose state is requested in the state object response.

  • layoutRules - This parameter specifies the state of layout rules which need to be fetched and executed. By default, this value is set to NO_RULE indicating that layout rules is not executed.

  • limit - A positive integer value that specifies the maximum number of items returned by the server.

  • nodesExceptionList - An array of document numbers recording the nodes that violate current expandNodes flag.

  • offset - A non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.

  • orderby - An array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.

  • parentFields - An array of field names to include in the parentFields of each resource row.

  • q - A filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.

  • rootFields - An array of field names to include in the rootFields of each resource row.

  • state - This Boolean parameter specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.

  • totalResults - This Boolean parameter specifies whether to calculate the total results. By default, this value is set to false indicating that total results is not calculated.

Response Body Parameters

 JSON data containing the grouped transactions

ClosedURI Endpoint Sample

http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions_aggregate

ClosedSample Request Body

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

ClosedSample Response Body

{ "groups": [{ "groupName": "", "totalCount": 808, "nextlink": { "rel": "next", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction?offset=100&limit=100&q={\"_customer_id\":{\"$ne\":\"account112\"},\"processManagerSSM\":{\"$exists\":false}}&fields=_customer_id,_id&totalResults=true" } }, { "groupName": "value1", "totalCount": 3, "nextlink": { "rel": "self", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction?offset=0&limit=100&q={\"_customer_id\":{\"$ne\":\"account112\"},\"processManagerSSM\":\"value1\"}&fields=_customer_id,_id&totalResults=true" } }, { "groupName": "value2", "totalCount": 2, "nextlink": { "rel": "self", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction?offset=0&limit=100&q={\"_customer_id\":{\"$ne\":\"account112\"},\"processManagerSSM\":\"value2\"}&fields=_customer_id,_id&totalResults=true" } } ], "primaryResults": { "totalResults": 808, "offset": 0, "limit": 100, "count": 100, "hasMore": true, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction" } ], "items": [{ "_customer_id": "SpecialAccount6", "_id": 15555314, "links": [{ ... ], }, { "_customer_id": "SpecialAccount6", "_id": 15556582, "links": [{ ... ] }, ... ] } }

ClosedMy Approvals Search

My Approvals Search Post method

Description

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

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_my_approval_search
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

id

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

Request Body Parameters

criteria

The criteria query definition supports the following parameters to retrieve specific content and limit the size of the response.

  • actions - An array of action names, whose state is requested in the state object response.

  • childDefs - An array of child query definitions that specifies query requests for child resources.

  • enableHierarchy - This Boolean parameter is used to enable hierarchical search and sort. Default value is false.

  • excludeFieldTypes - An array of field names that you want to exclude in the response.

  • expandedDomainCriteria - A map of dynamic menu field names, whose expanded domains are requested in the state object response.

  • expandedDomains - An array of field names, whose expanded domains are requested in the state object response.

  • expandNodes - This Boolean parameter is used to expand nodes and is only be available when enableHierarchy is true.

  • expand - An array of child resource names that you want to expand so that the contents return with the parent in the same request.

  • fields - An array of field names to be returned. The fields array values determine the "attributes" in the response's state object.

  • groups - An array of group names, whose state is requested in the state object response.

  • layoutRules - This parameter specifies the state of layout rules which need to be fetched and executed. By default, this value is set to NO_RULE indicating that layout rules is not executed.

  • limit - A positive integer value that specifies the maximum number of items returned by the server.

  • nodesExceptionList - An array of document numbers recording the nodes that violate current expandNodes flag.

  • offset - A non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.

  • orderby - An array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.

  • parentFields - An array of field names to include in the parentFields of each resource row.

  • q - A filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.

  • rootFields - An array of field names to include in the rootFields of each resource row.

  • state - This Boolean parameter specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.

  • totalResults - This Boolean parameter specifies whether to calculate the total results. By default, this value is set to false indicating that total results is not calculated.

HTTP Method

POST

Response Body Parameters

A list containing the requested fields and items matching the search criteria

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_my_approval_search

ClosedRequest Sample

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

ClosedResponse Sample

ClosedRestore Archived Transactions

Restore Archived Transactions Post method

Description

Use this endpoint to restore the specified archived transactions.

Note: This action is only available for Application Administrators.

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_restore_archived_transactions
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

Request Body Parameters

selectionCriteria

An array of archived transaction id items to be restored.

HTTP Method

POST

Success Response

204 No Content

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_restore_archived_transactions

ClosedRequest Sample

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

ClosedUnlock Transactions

Unlock Transactions Post method

Description

Use this endpoint to unlock the specified Transactions in a Commerce process that are locked for editing.

This endpoint is not available / supported for Partner organization users.

URI Endpoint

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_process_unlock
Endpoint Parameters

Note: If you are using a custom commerce process your endpoints may vary, refer to Custom Process Endpoint Parameters for more information.

Request Body Parameters

selections

An array of transaction Ids to archive.

HTTP Method

POST
Response Body Parameters

layoutVariableName

The redwood quote layout variable name.

warnings

An array of messages that have been generated for a specific object.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_process_unlock

ClosedRequest Sample

{ "selections": [3022127625, 3022127628, 3022127629] }

Related Topics

Related Topics Link IconSee Also