Price Agreement REST APIs

Oracle CPQ 24B provides the endpoints to support Price Agreements.

Add a Price Agreement

Use this endpoint to add a price agreement.

• Endpoint: /rest/v16/pricingSetup/agreements
• Method:  POST

Get All Price Agreements

Use this endpoint to retrieve all price agreements.

• Endpoint: /rest/v16/pricingSetup/agreements
• Method:  GET

Update Price Agreements

Use this endpoint to update price agreements.

• Endpoint: /rest/v16/pricingSetup/agreements
• Method:  PATCH

Delete a Price Agreement

Use this endpoint to delete the specified price agreement.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}
• Method:  DELETE

Get a Price Agreement

Use this endpoint to retrieve the specified price agreement.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}
• Method:  GET

Update a Price Agreement

Use this endpoint to update the specified price agreement.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}
• Method:  PATCH

Get Price Agreement Data

Use this endpoint to retrieve data for the specified price agreement.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/data
• Method:  GET

Update Price Agreement Data

Use this endpoint to update data for the specified price agreement.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/data
• Method:  PATCH

Get a Price Agreement Data Item

Use this endpoint to retrieve the specified price agreement data item.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/data/{id}
• Method:  GET

Add a Price Agreement Item

Use this endpoint to add a price agreement item.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems
• Method:  POST

Get All Price Agreement Items

Use this endpoint to retrieve all items for the specified price agreement.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems
• Method:  GET

Delete a Price Agreement Item

Use this endpoint to delete the specified price agreement item.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems
• Method:  DELETE

Get a Price Agreement Item

Use this endpoint to retrieve the specified price agreement item.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}
• Method:  GET

Add a Price Agreement Charge

Use this endpoint to add a charge to the specified price agreement item.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges
• Method:  POST

Get All Price Agreement Charges

Use this endpoint to retrieve all charges for the specified price agreement item.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges
• Method:  GET

Update Price Agreement Charges

Use this endpoint to update charges for the specified price agreement item.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges
• Method:  PATCH

Get a Price Agreement Charge

Use this endpoint to retrieve the specified price agreement item charge.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges/{id}
• Method:  GET

Delete a Price Agreement Charge

Use this endpoint to delete the specified price agreement item charge.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges/{id}
• Method:  DELETE

Update a Price Agreement Charge

Use this endpoint to update the specified price agreement item charge.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/charges/{id}
• Method:  PATCH

Add a Price Agreement Rate Plan

Use this endpoint to add a rate plan to the specified price agreement item.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans
• Method:  POST

Get All Price Agreement Rate Plans

Use this endpoint to retrieve all rate plans for the specified price agreement.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans
• Method:  GET

Update Price Agreement Rate Plans

Use this endpoint to update rate plans for the specified price agreement item.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans
• Method:  PATCH

Delete a Price Agreement Rate Plan

Use this endpoint to delete the specified price agreement item rate plan.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}
• Method:  DELETE

Get a Price Agreement Rate Plan

Use this endpoint to retrieve the specified price agreement item rate plan.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}
• Method:  GET

Update a Price Agreement Rate Plan

Use this endpoint to update the specified price agreement item rate plan.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}
• Method:  PATCH

Add a Price Agreement Rate Plan Charge

Use this endpoint to add a charge to the specified price agreement item rate plan.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges
• Method:  POST

Get All Price Agreement Rate Plan Charges

Use this endpoint to retrieve all charges for the specified price agreement item rate plan.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges
• Method:  GET

Update Price Agreement Rate Plan Charges

Use this endpoint to update charges for the specified price agreement item rate plan.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges
• Method:  PATCH

Delete a Price Agreement Rate Plan Charge

Use this endpoint to delete the specified price agreement item rate plan charge.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
• Method:  DELETE

Get a Price Agreement Rate Plan Charge

Use this endpoint to retrieve the specified price agreement item rate plan charge.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
• Method:  GET

Update a Price Agreement Rate Plan Charge

Use this endpoint to update the specified price agreement item rate plan charge.

• Endpoint: /rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
• Method:  PATCH

These endpoints provide web service support for Price Agreements.

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.