Overview
These endpoints enable administration of Pricing Engine pricing rules using REST API services.
Administration
|
Description |
Use this endpoint to add a pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the rule is active. |
|
description |
The description of the pricing rule. | |
|
endDate |
The date after which the pricing rule will no longer be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
name |
The name of the pricing rule. | |
|
orderNumber |
The linked model is added at the end with the highest order number. If the model needs to be linked at a specific orderNumber, then the orderNumber property can be specified. |
|
|
ruleConditionType |
The condition type of the pricing rule. Allowed values:"alwaysTrue", "customerSpecific", "simple", or "advanced". | |
|
ruleModels |
A collection of Price Models linked to the pricing rule. | |
|
simpleConditions |
An array of simple conditions for the pricing rule. | |
|
startDate |
The date from which the pricing rule will be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
variableName |
The unique variable name of the pricing rule. | |
|
Response Body Parameters |
JSON data for the added pricing rule. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules
{ "dateModified": "2022-12-02T17:02:43Z", "dateAdded": "2022-12-02T17:00:47Z", "name": "New Pricing Rule", "variableName": "newPricingRule", "ruleConditionType": "simple", "active": true, "simpleConditions": { "ruleExpression": "1", "simpleConditionRows": [{ "index": 1, "variableName": "itemQuantity", "displayName": "Item Quantity", "operator": "GREATER_THAN_EQUAL_TO", "value": "10.0" } ] } }
{ "dateModified": "2022-12-02T17:09:16Z", "dateAdded": "2022-12-02T17:09:16Z", "name": "New Pricing Rule", "variableName": "newPricingRule", "orderNumber": 20, "ruleConditionType": "simple", "active": true, "simpleConditions": { "ruleExpression": "1", "simpleConditionRows": [{ "index": 1, "variableName": "itemQuantity", "displayName": "Item Quantity", "operator": "GREATER_THAN_EQUAL_TO", "value": "10.0" } ] } }
Add Pricing Rule Customer Specific Condition
|
Description |
Use this endpoint to add a customer specific condition for the specified pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/customerSpecificConditions |
|
|
Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the customer specific condition is active. |
|
customerId |
The unique identifier of the customer. | |
|
customerName |
The name of the customer. | |
|
endDate |
The date after which the customer specific condition will no longer be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
startDate |
The date from which the customer specific condition will be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
Response Body Parameters |
JSON data for the added customer specific condition. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/newCSPPricingRule/customerSpecificConditions
{ "active": true, "customerId": "1001", "customerName": "ABC Solutions, Inc.", "startDate": "2023-01-01T06:00:00Z", "endDate": "2023-01-31T06:00:00Z" }
{ "id": 38824940, "active": true, "customerId": "1001", "customerName": "ABC Solutions, Inc.", "startDate": "2023-01-01T06:00:00Z", "endDate": "2023-01-31T06:00:00Z", "dateModified": "2022-12-02T17:43:22Z", "dateAdded": "2022-12-02T17:43:22Z" }
|
Description |
Use this endpoint to delete the specified pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName} |
|
|
Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/cSPPricingRule
Delete Pricing Rule Customer Specific Condition
|
Description |
Use this endpoint to delete the specified customer specific condition for a pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/customerSpecificConditions/{conditionId} |
|
| Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
conditionId |
The unique identifier of the customer specific condition. | |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/newCSPPricingRule/38824940
|
Description |
Use this endpoint to retrieve all pricing rules in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules |
|
|
Endpoint Parameters |
None |
|
|
(Optional) This endpoint supports the following query specifications: |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of pricing rules. |
|
|
active |
Indicates if the rule is active. | |
|
createdBy |
The details of the user who created the record. |
|
|
customerSpecificConditions |
A collection of Customer Specific Conditions. | |
|
dateAdded |
Creation date of the pricing rule. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
dateModified |
Last modified date of the pricing rule. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
description |
The description of the pricing rule. | |
|
endDate |
The date after which the pricing rule will no longer be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
The name of the pricing rule. | |
|
orderNumber |
The position of the current pricing rule in an ordered list of all pricing rules. | |
|
productCount |
The count of products linked to this rule. | |
|
ruleConditionType |
The condition type of the pricing rule. Allowed values:"alwaysTrue", "customerSpecific", "simple", or "advanced". | |
|
ruleModelCount |
The count of Price Models linked to this rule. (Read-only) | |
|
ruleModels |
A collection of Price Models linked to the pricing rule. | |
|
simpleConditions |
An array of simple conditions for the pricing rule. | |
|
startDate |
The date from which the pricing rule will be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
variableName |
The unique variable name of the pricing rule. | |
https://sitename.oracle.com/rest/v17/pricingSetup/rules
The following example includes the limit query specification to limit the pricing rules in the results to five per page, and the orderBy query specification to order the results by order number in ascending order.
https://sitename.oracle.com/rest/v17/pricingSetup/rules/?limit=5&orderby=orderNumber:ASC
{ "items": [{ "dateModified": "2022-06-27T23:17:09Z", "dateAdded": "2022-06-27T23:16:44Z", "name": "Base Pricing Rule", "variableName": "basePricingRule", "orderNumber": 1, "ruleConditionType": "advanced", "active": true, "ruleModelCount": 2, "productCount": 3, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/basePricingRule" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/basePricingRule/ruleModels" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/basePricingRule/customerSpecificConditions" } ] }, { "dateModified": "2022-06-27T23:16:51Z", "dateAdded": "2022-06-22T20:37:40Z", "name": "Tier and Volume Pricing", "variableName": "tierAndVolumePricing", "orderNumber": 2, "ruleConditionType": "customerSpecific", "active": true, "ruleModelCount": 0, "productCount": 0, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/tierAndVolumePricing" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/tierAndVolumePricing/ruleModels" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/tierAndVolumePricing/customerSpecificConditions" } ] }, { "dateModified": "2022-06-27T23:16:51Z", "dateAdded": "2019-05-02T13:37:28Z", "name": "oRCL_pRC_runAllProfiles", "variableName": "oRCLpRCrunAllProfiles", "orderNumber": 3, "ruleConditionType": "advanced", "active": true, "ruleModelCount": 2, "productCount": 0, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/customerSpecificConditions" } ] }, { "dateModified": "2022-12-01T15:54:29Z", "dateAdded": "2019-11-04T14:56:12Z", "name": "CSP ABC Corp", "variableName": "cSPABCCorp", "orderNumber": 4, "ruleConditionType": "advanced", "active": true, "ruleModelCount": 1, "productCount": 0, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/cSPABCCorp" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/cSPABCCorp/ruleModels" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/cSPABCCorp/customerSpecificConditions" } ] }, { "dateModified": "2022-12-01T15:54:29Z", "dateAdded": "2021-06-22T12:03:11Z", "name": "Banking Rule", "variableName": "bankingRule", "orderNumber": 5, "ruleConditionType": "customerSpecific", "active": true, "ruleModelCount": 1, "productCount": 3, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/ruleModels" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/customerSpecificConditions" } ] } ], "offset": 0, "limit": 5, "count": 5, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules?offset=0&limit=5&orderby=orderNumber:ASC" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules?offset=5&limit=5&orderby=orderNumber:ASC" } ] }
|
Description |
Use this endpoint to retrieve the specified pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName} |
|
| Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
(Optional) This endpoint supports the |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
|
Response Body Parameters |
active |
Indicates if the rule is active. |
|
createdBy |
The details of the user who created the record. |
|
|
customerSpecificConditions |
A collection of Customer Specific Conditions. | |
|
dateAdded |
Creation date of the pricing rule. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
dateModified |
Last modified date of the pricing rule. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
description |
The description of the pricing rule. | |
|
endDate |
The date after which the pricing rule will no longer be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
The name of the pricing rule. | |
|
orderNumber |
The position of the current pricing rule in an ordered list of all pricing rules. | |
|
productCount |
The count of products linked to this rule. | |
|
ruleConditionType |
The condition type of the pricing rule. Allowed values:"alwaysTrue", "customerSpecific", "simple", or "advanced". | |
|
ruleModelCount |
The count of Price Models linked to this rule. (Read-only) | |
|
ruleModels |
A collection of Price Models linked to the pricing rule. | |
|
simpleConditions |
An array of simple conditions for the pricing rule. | |
|
startDate |
The date from which the pricing rule will be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
variableName |
The unique variable name of the pricing rule. | |
https://sitename.oracle.com/rest/v17/pricingSetup/rules/US_enterprise_pricing_rule2
{ "active": true, "name": "US Enterprise Pricing 2", "variableName": "US_enterprise_pricing_rule2", "startDate": "2021-04-23T18:25:43.511Z", "endDate": "2032-04-23T18:25:43.511Z", "description": "Pricing rule 2 for U.S. enterprise customers", "ruleModelCount": 3, "productCount": 18 }
Get Pricing Rule Customer Specific Conditions
|
Description |
Use this endpoint to retrieve customer specific conditions for the specified pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/customerSpecificConditions |
|
|
Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
(Optional) This endpoint supports the following query specifications: |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of Customer Specific Conditions. |
|
|
active |
Indicates if the customer specific condition is active. | |
|
createdBy |
The details of the user who created the record. |
|
|
customerId |
The unique identifier of the customer. | |
|
customerName |
The name of the customer. | |
|
dateAdded |
Creation date of the customer specific condition for the pricing rule. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
dateModified |
Last modified date of the customer specific condition for the pricing rule. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
endDate |
The date after which the customer specific condition will no longer be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
id |
The unique identifier of the customer specific condition. | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
startDate |
The date from which the customer specific condition will be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/customerSpecificConditions
{ "items": [{ "id": 38581345, "active": true, "customerId": "1001", "customerName": "ABC Solutions, Inc.", "startDate": "2021-06-22T00:00:00Z", "endDate": "2021-12-31T23:59:59Z", "dateModified": "2021-06-22T12:03:34Z", "dateAdded": "2021-06-22T12:03:34Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/customerSpecificConditions/38581345" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/customerSpecificConditions" } ] } ], "offset": 0, "limit": 1000, "count": 1, "hasMore": false, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/customerSpecificConditions" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/customerSpecificConditions?offset=0&limit=1000" } ] }
Get Pricing Rule Customer Specific Condition
|
Description |
Use this endpoint to retrieve the specified customer specific condition for a pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/customerSpecificConditions/{conditionId} |
|
|
Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
conditionId |
The Id of the customer specific condition. | |
|
None |
||
|
(Optional) This endpoint supports the |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
| Response Body Parameters |
active |
Indicates if the customer specific condition is active. |
|
createdBy |
The details of the user who created the record. |
|
|
customerId |
The unique identifier of the customer. | |
|
customerName |
The name of the customer. | |
|
dateAdded |
Creation date of the customer specific condition for the pricing rule. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
dateModified |
Last modified date of the customer specific condition for the pricing rule. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
endDate |
The date after which the customer specific condition will no longer be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
id |
The unique identifier of the customer specific condition. | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
startDate |
The date from which the customer specific condition will be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/customerSpecificConditions/38581345
{ "id": 38581345, "active": true, "customerId": "1001", "customerName": "ABC Solutions, Inc.", "startDate": "2021-06-22T00:00:00Z", "endDate": "2021-12-31T23:59:59Z", "dateModified": "2021-06-22T12:03:34Z", "dateAdded": "2021-06-22T12:03:34Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/customerSpecificConditions/38581345" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/bankingRule/customerSpecificConditions" } ] }
Get Price Models Linked to a Pricing Rule
|
Description |
Use this endpoint to retrieve all the Price Models that are linked to the specified pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/rulemodels |
|
|
Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
(Optional) This endpoint supports the following query specifications: |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of Price Models that are linked to the pricing rule. |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the Price Model pricing rule link. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
dateModified |
Last modified date of the Price Model pricing rule link. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
description |
The description of the linked Price Model. | |
|
dynamicPricingType |
The type of dynamic pricing applied by the linked Price Model. | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
The name of the linked Price Model. | |
|
orderNumber |
The position of the linked Price Model within in the pricing rule. | |
|
ruleCount |
The count of pricing rules linked to the Price Model. | |
|
valueType |
The type of discount applied by the linked Price Model. | |
|
variableName |
The unique variable name of the linked Price Model. | |
https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels
{ "items": [{ "variableName": "subscriptionCharges", "orderNumber": 1, "dateModified": "2019-05-06T05:03:51Z", "dateAdded": "2019-05-02T13:37:28Z", "name": "Subscription Charges", "ruleCount": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels/subscriptionCharges" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels" } ], "valueType": "absolutePrice", "dynamicPricingType": "advanced" }, { "variableName": "configSMS", "orderNumber": 2, "dateModified": "2020-04-20T16:14:23Z", "dateAdded": "2020-04-20T16:14:23Z", "name": "Config SMS", "ruleCount": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels/configSMS" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels" } ], "valueType": "absolutePrice", "dynamicPricingType": "advanced" } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels?offset=0&limit=1000" } ] }
Link a Price Model to a Pricing Rule
|
Description |
Use this endpoint to link a Price Model to a pricing rule in Pricing Engine. Note: This operation does not add a new Price Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/ruleModels |
|
| Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
HTTP Method |
POST |
|
| Request Body Parameters |
variableName |
The variable name of the Price Model. |
|
orderNumber |
(optional) The linked model is added at the end of the linked Price Model list. If the Price Model needs a specific orderNumber, then the orderNumber property can be specified. |
|
|
Response Body Parameters |
JSON data for the linked Price Model. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/basePricingRule/ruleModels
{ "variableName": "tierDiscountPricing" }
{ "variableName": "tierDiscountPricing", "orderNumber": 2, "dateModified": "2022-12-02T21:02:13Z", "dateAdded": "2022-12-02T21:02:13Z", "name": "Tier Discount Pricing", "valueType": "discountAmount", "dynamicPricingType": "tiered" }
|
Description |
Use this endpoint to add, update, reorder, or delete pricing rules in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
PATCH |
|
|
Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Add Pricing Rule for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules
{ [{ "op": "add", "path": "/", "value": { "active": true, "name": "US Enterprise Pricing", "variableName": "US_enterprise_pricing_rule", "startDate": "2021-04-23T18:25:43.511Z", "endDate": "2032-04-23T18:25:43.511Z", "description": "Pricing rule for U.S. enterprise customers" } }, { "op": "remove", "path": "/US_enterprise_pricing_rule_dummy" }, { "op": "replace", "path": "/Enterprise_pricing_new" "value": { "orderNumber": 3 } } ] }
|
Description |
Use this endpoint to update the specified pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName} |
|
| Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates if the rule is active. |
|
description |
The description of the pricing rule. | |
|
endDate |
The date after which the pricing rule will no longer be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
name |
The name of the pricing rule. | |
|
orderNumber |
The linked model is added at the end with the highest order number. If the model needs to be linked at a specific orderNumber, then the orderNumber property can be specified. |
|
|
ruleConditionType |
The condition type of the pricing rule. Allowed values:"alwaysTrue", "customerSpecific", "simple", or "advanced". | |
|
ruleModels |
A collection of Price Models linked to the pricing rule. | |
|
simpleConditions |
An array of simple conditions for the pricing rule. | |
|
startDate |
The date from which the pricing rule will be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/US_enterprise_pricing_rule
{ "active": false, "name": "US Enterprise Pricing (Inactive)" }
Update Pricing Rule Customer Specific Conditions
|
Description |
Use this endpoint to update or delete customer specific conditions for the specified pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/customerSpecificConditions |
|
| Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
HTTP Method |
PATCH |
|
|
Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Add Customer Specific Condition for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/US_enterprise_pricing_rule
[{ "op": "add", "path": "/", "value": { "active": true, "customerId": "usEnterprisePricing1", "startDate": "2021-04-23T18:25:43.511Z", "endDate": "2032-04-23T18:25:43.511Z" } }, { "op": "remove", "path": "/39854321" }, { "op": "replace", "path": "/13457765", "value": { "endDate": null } } ]
Update Pricing Rule Customer Specific Condition
|
Description |
Use this endpoint to update the specified customer specific condition for a pricing rule in Pricing Engine. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/customerSpecificConditions/{conditionId} |
|
| Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
conditionId |
The unique identifier of the customer specific condition. | |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates if the customer specific condition is active. |
|
endDate |
The date after which the customer specific condition will no longer be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
startDate |
The date from which the customer specific condition will be applicable. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/US_enterprise_pricing_rule/customerSpecificConditions/39854399
{ "startDate": "2023-01-23T18:25:43.511Z", "endDate": "2024-01-23T18:25:43.511Z" }
Update Price Models Linked to a Pricing Rule
|
Description |
Use this endpoint to add, reorder, or delete Price Models that are linked to a Pricing Engine Rule. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/rulemodels |
|
| Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
HTTP Method |
PATCH |
|
|
Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". Note: You can only link, unlink, or reorder Price Models using this endpoint.
|
|
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles
[{ "op": "add", "path": "/", "value": { "variableName": "absolutePrice" } }, { "op": "replace", "path": "/configSMS", "value": { "orderNumber": 1 } }, { "op": "remove", "path": "/subscriptionCharges" } ]
Update Price Model Linked to a Pricing Rule
|
Description |
Use this endpoint to change the order number for the specified Price Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/rulemodels/{modelVariableName} |
|
| Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
modelVariableName |
The variable name of the Price Model. | |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
orderNumber |
The position of the linked Price Model within the pricing rule. |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels/subscriptionCharges
{ "orderNumber": "5" }
Unlink a Price Model from a Pricing Rule
|
Description |
Use this endpoint to unlink the specified Price Model from a pricing rule in Pricing Engine. Note: This operation does not delete Price Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rules/{ruleVariableName}/rulemodels/{modelVariableName} |
|
| Endpoint Parameters |
ruleVariableName |
The variable name of the pricing rule. |
|
modelVariableName |
The variable name of the linked Price Model. | |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels/subscriptionCharges
