New Commerce REST API Endpoints

Oracle CPQ 24D introduces the following endpoints:

Accept Quote

Use this endpoint to accept the quote for the specified transaction.

• Endpoint: /commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_s_accept_quote
• Method: POST

Create Price Agreement

Use this endpoint to create a CPQ Price Agreement from the current transaction sales agreement.

• Endpoint: /rest/v17/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_s_createAgreement
• Method: POST

Get Transaction Comment

Use this endpoint to retrieve the specified transaction comment.

• Endpoint: /commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/_s_transactionComments_t/{_row_number}
• Method: GET

Get Transaction Comments

Use this endpoint to retrieve comments for the specified transaction.

• Endpoint: /commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/_s_transactionComments_t
• Method: GET

Publish Quote

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

• Endpoint: /commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_s_publish_quote
• Method: POST

Request Quote Revision

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

• Endpoint:/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_s_request_quote_revision
• Method: POST

Self Service Checkout

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

• Endpoint: /rest/v17/commerce{Stage}(ProcessVarName}{MainDocVarName}/{id}/actions/_s_selfServiceCheckout
• Method: POST

The new Commerce REST API endpoints provide web service support for price agreements and self-service checkout.

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.