Overview
These endpoints enable administration of CPQ Price Models, Price Model Items, Price Model stand-alone Charges, Price Model Rate Plans, and Price Model Rate Plan Charges using REST API services.
Administration
Price Models
|
Description |
Use this endpoint to create a new price model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
adjustmentType |
The adjustment type of the price model. Allowed Values: "discountPercent", "discountAmount", "markupPercent", or "markupAmount" |
|
conditionType |
The condition type of the price model. Allowed Values: "alwaysTrue" or "simple" |
|
|
data |
List of data for the price model |
|
|
description |
Description of the price model |
|
|
dynamicPricingType |
The type of dynamic pricing applied by the price model. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
editRestriction |
The pricing edit restriction. Allowed Values: ["UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" |
|
|
endDate |
The date at which the price model will end |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
listType |
The List Type for the price model. Allowed Values:"priceList", "discountList", "advanced", "markupList", "advancedByTemplate" |
|
|
matrixTemplateName |
The dynamic matrix template name of the price model. |
|
|
matrixTemplateVariableName |
The dynamic matrix template variable name of the price model. |
|
|
name |
Name of the price model |
|
|
priceModelItems |
List of price items for the price model |
|
|
scriptingMatrixVariableName |
The scripting matrix variable name. |
|
|
startDate |
Effective start date of the price model |
|
|
shared |
Indicates whether this model is shared |
|
|
simpleConditions |
A collection of simple type conditions applied by the price model. This is optional for other condition types. |
|
|
supportedMatrixTemplateVariableName |
The supported dynamic matrix pricing template of the price model. |
|
|
valueType |
The value type of the price model Allowed Values:"absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent", "advancedByTemplate" |
|
|
variableName |
Unique number of the price model |
|
| Response Body Parameters |
JSON data for the newly added price model. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models
{ "name": "New Price Model", "variableName": "newPriceModel", "conditionType": "alwaysTrue", "valueType": "discountPercent", "dynamicPricingType": "tiered" }
{ "dateModified": "2022-11-23T17:49:27Z", "dateAdded": "2022-11-23T17:49:27Z", "name": "New Price Model", "variableName": "newPriceModel", "conditionType": "alwaysTrue", "valueType": "discountPercent", "dynamicPricingType": "tiered" }
|
Description |
Use this endpoint to delete the specified price model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint retrieve the specified price model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model. |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
adjustmentType |
The adjustment type of pricing model. Allowed Values: "discountPercent", "discountAmount", "markupPercent", or "markupAmount" |
|
conditionType |
The condition type of the price model. Allowed Values: "alwaysTrue" or "simple" |
|
|
createdBy |
The details of the user who created the record. |
|
|
data |
List of data for the price model |
|
|
dateAdded |
Creation date of the price model |
|
|
dateModified |
Last modified date of the price model |
|
|
description |
Description of the price model |
|
|
dynamicPricingType |
The type of dynamic pricing applied by the price model. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
editRestriction |
The pricing edit restriction. Allowed Values: ["UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" |
|
|
endDate |
The date at which the price model will end |
|
|
hasBomItem |
Indicates whether this price model has prices defined for BOM Items |
|
|
hasCharges |
Indicates whether this Price Model has any charges. |
|
|
hasRateCards |
Indicates if this price model data has linked rate cards (Preview only) |
|
|
hasRatePlans |
Indicates if this price model data has linked rate plans |
|
|
hasTiers |
Indicates whether this model has any price model data that has tiers |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
listType |
The List Type for the price model. Allowed Values:"priceList", "discountList", "advanced", "markupList", "advancedByTemplate" |
|
|
matrixTemplateName |
The dynamic matrix template name of the Price Model. |
|
|
matrixTemplateVariableName |
The dynamic matrix template variable name of the Price Model. |
|
|
name |
Name of the price model |
|
|
priceModelItems |
List of price items for the price model |
|
|
ruleCount |
The count of pricing rules linked to this model |
|
|
scriptingMatrixVariableName |
The scripting matrix variable name |
|
|
shared |
Indicates whether this model is shared |
|
|
simpleConditions |
A collection of simple type conditions applied by the price model. This is optional for other condition types. |
|
|
startDate |
Effective start date of the price model |
|
|
supportedMatrixTemplateVariableName |
The supported dynamic matrix pricing template of the Price Model. |
|
|
valueType |
The value type of the price model Allowed Values: "absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent", "advancedByTemplate" |
|
|
variableName |
Unique number of the price model |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/cSPABCCorp
{ "dateModified": "2019-11-04T17:01:48Z", "dateAdded": "2019-11-04T15:02:18Z", "name": "CSP ABC Corp", "variableName": "cSPABCCorp", "conditionType": "simple", "simpleConditions": { "ruleExpression": "1 OR 2", "simpleConditionRows": [{ "index": 1, "variableName": "companyName", "displayName": "Company Name", "operator": "EQUAL_TO", "value": "ABC Corp" }, { "index": 2, "variableName": "repeatCustomer", "displayName": "RepeatCustomer", "operator": "EQUAL_TO", "value": "true" } ] }, "shared": false, "ruleCount": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/cSPABCCorp" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/cSPABCCorp/data" } ], "valueType": "absolutePrice", "dynamicPricingType": "advanced" }
|
Description |
Use this endpoint retrieve all price models. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models |
|
| Endpoint Parameters |
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
|
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters | A collection of Price Models. | |
|
adjustmentType |
The adjustment type of pricing model. Allowed Values: "discountPercent", "discountAmount", "markupPercent", or "markupAmount" |
|
|
conditionType |
The condition type of the price model. Allowed Values: "alwaysTrue" or "simple" |
|
|
createdBy |
The details of the user who created the record. |
|
|
data |
List of data for the price model |
|
|
dateAdded |
Creation date of the price model |
|
|
dateModified |
Last modified date of the price model |
|
|
description |
Description of the price model |
|
|
dynamicPricingType |
The type of dynamic pricing applied by the price model. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
editRestriction |
The pricing edit restriction. Allowed Values: ["UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" |
|
|
endDate |
The date at which the price model will end |
|
|
hasBomItem |
Indicates whether this price model has prices defined for BOM Items |
|
|
hasCharges |
Indicates whether this Price Model has any charges. |
|
|
hasRateCards |
Indicates if this price model data has linked rate cards (Preview only) |
|
|
hasRatePlans |
Indicates if this price model data has linked rate plans |
|
|
hasTiers |
Indicates whether this model has any price model data that has tiers |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
listType |
The List Type for the price model. Allowed Values:"priceList", "discountList", "advanced", "markupList", "advancedByTemplate" |
|
|
matrixTemplateName |
The dynamic matrix template name of the Price Model. |
|
|
matrixTemplateVariableName |
The dynamic matrix template variable name of the Price Model. |
|
|
name |
Name of the price model |
|
|
priceModelItems |
List of price items for the price model |
|
|
ruleCount |
The count of pricing rules linked to this model |
|
|
scriptingMatrixVariableName |
The scripting matrix variable name |
|
|
shared |
Indicates whether this model is shared |
|
|
simpleConditions |
A collection of simple type conditions applied by the price model. This is optional for other condition types. |
|
|
startDate |
Effective start date of the price model |
|
|
supportedMatrixTemplateVariableName |
The supported dynamic matrix pricing template of the Price Model. |
|
|
valueType |
The value type of the price model Allowed Values: "absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent", "advancedByTemplate" |
|
|
variableName |
Unique number of the price model |
|
|
adjustmentType |
The adjustment type of pricing model. Allowed Values: "discountPercent", "discountAmount", "markupPercent", or "markupAmount" |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models
The limit query specification is used in the following example to limit the results to three models per page.
https://sitename.oracle.com/rest/v17/pricingSetup/models?limit=3
{ "items": [{ "dateModified": "2021-09-17T11:42:19Z", "dateAdded": "2019-05-02T13:37:28Z", "name": "Subscription Charges", "variableName": "subscriptionCharges", "conditionType": "simple", "simpleConditions": { "ruleExpression": "1 OR 2 OR 3 OR 4 OR 5 OR 6 OR 7 OR 8", "simpleConditionRows": [{ "index": 1, "variableName": "oRCL_pRC_partNumber", "displayName": "Part Number", "operator": "EQUAL_TO", "value": "Cloud Backup Service" }, { "index": 2, "variableName": "oRCL_pRC_partNumber", "displayName": "Part Number", "operator": "EQUAL_TO", "value": "Premium Cloud Backup Service" }, { "index": 3, "variableName": "oRCL_pRC_partNumber", "displayName": "Part Number", "operator": "EQUAL_TO", "value": "part10" }, { "index": 4, "variableName": "oRCL_pRC_partNumber", "displayName": "Part Number", "operator": "EQUAL_TO", "value": "part111" }, { "index": 5, "variableName": "oRCL_pRC_partNumber", "displayName": "Part Number", "operator": "EQUAL_TO", "value": "part1120" }, { "index": 6, "variableName": "oRCL_pRC_partNumber", "displayName": "Part Number", "operator": "EQUAL_TO", "value": "Surface Book 2" }, { "index": 7, "variableName": "oRCL_pRC_partNumber", "displayName": "Part Number", "operator": "EQUAL_TO", "value": "QP_Item3" }, { "index": 8, "variableName": "oRCL_pRC_productType", "displayName": "Product Type", "operator": "EQUAL_TO", "value": "subscription" } ] }, "shared": false, "ruleCount": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/subscriptionCharges" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/subscriptionCharges/data" } ], "valueType": "absolutePrice", "dynamicPricingType": "advanced" }, { "dateModified": "2021-06-03T07:01:41Z", "dateAdded": "2019-07-22T11:41:51Z", "name": "CSP", "variableName": "cSP", "conditionType": "alwaysTrue", "shared": true, "ruleCount": 2, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/cSP" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/cSP/data" } ], "valueType": "discountPercent", "dynamicPricingType": "static" }, { "dateModified": "2019-11-04T17:01:48Z", "dateAdded": "2019-11-04T15:02:18Z", "name": "CSP ABC Corp", "variableName": "cSPABCCorp", "conditionType": "simple", "simpleConditions": { "ruleExpression": "1 OR 2", "simpleConditionRows": [{ "index": 1, "variableName": "companyName", "displayName": "Company Name", "operator": "EQUAL_TO", "value": "ABC Corp" }, { "index": 2, "variableName": "repeatCustomer", "displayName": "RepeatCustomer", "operator": "EQUAL_TO", "value": "true" } ] }, "shared": false, "ruleCount": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/cSPABCCorp" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/cSPABCCorp/data" } ], "valueType": "absolutePrice", "dynamicPricingType": "advanced" } ], "offset": 0, "limit": 3, "count": 3, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models?offset=0&limit=3" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models?offset=3&limit=3" } ] }
Get Price Model Pricing Matrix Grid Data
|
Description |
Use this endpoint to retrieve all pricing matrix grid data. The matrix data input and output fields will be prefixed by the "matrix" string in the response to distinguish from other charge or reference fields with the same name. |
||
|---|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/matrixGrid |
||
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model. | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
|||
|
HTTP Method |
GET |
||
| Request Body Parameters | None | ||
| Response Body Parameters |
count |
The number of resource instances returned in the current range. | |
|
createdBy |
The details of the user who created the record. | ||
|
hasMore |
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. | ||
|
items |
An array of pricing matrix grid items | ||
|
_proxy_id |
The proxy identifier for the resource that was added. | ||
|
bomItemName |
The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request. | ||
|
bomItemVariableName |
The BOM Item's variable name. | ||
|
chargeDefinition |
The display label of the charge definition. | ||
|
chargeDefinitionCode |
The unique code of the charge definition. | ||
|
chargeDefinitionIntegrationId |
The integration Id of the charge definition. | ||
|
chargeEndDate |
The date at which the charge will end. | ||
|
chargeId |
ID of the Charge. | ||
|
chargeStartDate |
The date from which the Charge will be applicable. | ||
|
chargeType |
The category of charge. | ||
|
createdBy |
The details of the user who created the record. | ||
|
dateAdded |
Creation Date of the Pricing Matrix data. | ||
|
dateModified |
Last Modified date of the Pricing Matrix data. | ||
|
description |
The description of the Price Model Data | ||
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", and "attributeBasedCharge" | ||
|
id |
The Unique Identifier of the Pricing Matrix data. | ||
|
lastModifiedBy |
The details of the user who modified the record. | ||
|
links |
The link relations associated with the resource instance. | ||
|
partNumber |
The part Number of the Price Model Data. | ||
|
priceModelItemId |
ID of the Price Model item. | ||
|
pricePeriod |
The billing period. | ||
|
priceType |
The type of charge. | ||
|
primaryCharge |
Indicates whether this is the primary charge. | ||
|
ratePlanDescription |
The Rate Plan description. | ||
|
ratePlanEndDate |
The date at which the Rate Plan will end. | ||
|
ratePlanName |
The Rate Plan name | ||
|
ratePlanNumber |
The Rate Plan number | ||
|
ratePlanStartDate |
The date from which the Rate Plan will be applicable. | ||
|
rootBomItemName |
The root BOM item's display name. | ||
|
rootBomItemVariableName |
The root BOM item's variable name. | ||
|
salesProductType |
The Sales Product Type | ||
|
serviceDuration |
The Service Duration | ||
|
serviceDurationPeriod |
The Service Duration Period Code | ||
|
serviceDurationType |
The Service Duration Type | ||
|
usageUOM |
The unit of measure for the charge. | ||
|
lastModifiedBy |
The details of the user who modified the record. | ||
|
limit |
The actual paging size used by the server. | ||
|
links |
The link relations associated with the resource instance. | ||
|
offset |
The offset value used in the current page. | ||
|
totalResults |
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request. | ||
https://sitename.oracle.com/rest/v17/pricingSetup/models/mbpModel/matrixGrid
{ "items": [{ "id": 452345, "partNumber": "part10", "description": "Part 10", "bomItemVariableName": "child", "rootBomItemVariableName": "parent", "bomItemName": "Child", "rootBomItemName": "Parent", "serviceDuration": 1, "serviceDurationPeriod": "months", "chargeType": "salesPrice", "priceType": "oneTime", "ratePlanName": "myRatePlan", "ratePlanNumber": "RP10234", "dynamicPricingType": "attributeBasedCharge", "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "chargeStartDate": "2024-11-08T00:0:00Z", "chargeEndDate": "2025-10-07T23:59:59Z", "dateAdded": "2023-11-08T05:42:17Z", "dateModified": "2023-11-08T05:42:17Z", "str1_c": "test", "int1_c": 11, "_matrix_str1": "testMatrix1", "_matrix_int1": 102, "_matrix_itemPrice": { "currency": "USD", "value": 20 } }, { "id": 452346, "partNumber": "part10", "description": "Part 10", "bomItemVariableName": "child", "rootBomItemVariableName": "parent", "bomItemName": "Child", "rootBomItemName": "Parent", "serviceDuration": 1, "serviceDurationPeriod": "months", "chargeType": "salesPrice", "priceType": "oneTime", "ratePlanName": "myRatePlan", "ratePlanNumber": "RP10234", "dynamicPricingType": "attributeBasedCharge", "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "chargeStartDate": "2024-11-08T00:0:00Z", "chargeEndDate": "2025-10-07T23:59:59Z", "dateAdded": "2023-11-08T05:42:17Z", "dateModified": "2023-11-08T05:42:17Z", "str1_c": "test", "int1_c": 11, "_matrix_str1": "testMatrix2", "_matrix_int1": 103, "_matrix_itemPrice": { "currency": "USD", "value": 22 } } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false }
|
Description |
Use this endpoint to update the specified price model. In contrast to editing a price model in the UI, this endpoint also supports changing the part number for a price on an existing row. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model. |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
adjustmentType |
The adjustment type of the price model. Allowed Values: "discountPercent", "discountAmount", "markupPercent", or "markupAmount" |
|
conditionType |
The condition type of the price model. Allowed Values: "alwaysTrue" or "simple" |
|
|
data |
List of data for the price model |
|
|
description |
Description of the price model |
|
|
dynamicPricingType |
The type of dynamic pricing applied by the price model. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
editRestriction |
The pricing edit restriction. Allowed Values: ["UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" |
|
|
endDate |
The date at which the price model will end |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
listType |
The List Type for the price model. Allowed Values:"priceList", "discountList", "advanced", "markupList", "advancedByTemplate" |
|
|
matrixTemplateName |
The dynamic matrix template name of the price model. |
|
|
matrixTemplateVariableName |
The dynamic matrix template variable name of the price model. |
|
|
name |
Name of the price model |
|
|
priceModelItems |
List of price items for the price model |
|
|
scriptingMatrixVariableName |
The scripting matrix variable name. |
|
|
startDate |
Effective start date of the price model |
|
|
shared |
Indicates whether this model is shared |
|
|
simpleConditions |
A collection of simple type conditions applied by the price model. This is optional for other condition types. |
|
|
supportedMatrixTemplateVariableName |
The supported dynamic matrix pricing template of the price model. |
|
|
valueType |
The value type of the price model Allowed Values:"absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent", "advancedByTemplate" |
|
|
variableName |
Unique number of the price model |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/volumeDiscountPricing
{ "conditionType": "simple", "simpleConditions": { "ruleExpression": "1", "simpleConditionRows": [{ "index": 1, "variableName": "oRCL_pRC_quantity", "displayName": "Quantity", "operator": "GREATER_THAN", "value": "10" } ] } }
|
Description |
Use this endpoint to update or delete price models. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models |
|
|
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 Price Model for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models
There are three operations included in this example:
- Add the new Volume Discount Pricing model "volumeDiscountPricing"
- Replace the "configSMS" description
- Remove the "test" model
[{ "op": "add", "path": "/", "value": { "name": "Volume Discount Pricing", "variableName": "volumeDiscountPricing", "dynamicPricingType": "volume", "valueType": "discountAmount", "description": "This Price Model provides a volume discount." } }, { "op": "replace", "path": "/configSMS", "value": { "description": "This Price Model applies discounts based upon the low or medium text messaging services." } }, { "op": "remove", "path": "/test" } ]
Update Price Model Pricing Grid Data
|
Description |
Use this endpoint to update pricing matrix grid data. The matrix input and output fields should be prefixed with the "matrix" string. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/matrixGrid |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model. |
|
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 Get Price Model Pricing Matrix Grid Data for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/mbpModel/matrixGrid
[{ "op": "add", "path": "/", "value": { "id": -1, "partNumber": "part10", "description": "Part 10", "bomItemVariableName": "child", "rootBomItemVariableName": "parent", "bomItemName": "Child", "rootBomItemName": "Parent", "serviceDuration": 1, "serviceDurationPeriod": "months", "chargeType": "salesPrice", "priceType": "oneTime", "ratePlanName": "myRatePlan", "ratePlanNumber": "RP10234", "dynamicPricingType": "attributeBasedCharge", "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "chargeStartDate": "2024-11-08T00:0:00Z", "chargeEndDate": "2025-10-07T23:59:59Z", "dateAdded": "2023-11-08T05:42:17Z", "dateModified": "2023-11-08T05:42:17Z", "chargeAttrStr_c": "test", "chargeAttrInt_c": 11, "_matrix_str1": "testMatrix1", "_matrix_int1": 102, "_matrix_itemPrice": { "currency": "USD", "value": 20 } } }, { "op": "replace", "path": "/3453466", "value": { "_matrix_str1": "testMatrix1a", "_matrix_itemPrice": { "currency": "USD", "value": 21 } } } ]
{ [{ "_proxy_id": -1, "id": 456234 } ] }
Price Model Items
|
Description |
Use this endpoint to add a price model item to the specified price model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
HTTP Method |
POST |
|
| Request Body Parameters |
bomItemName |
The BOM item's display name |
|
bomItemVariableName |
The BOM item's variable name | |
|
charges |
An array of the prices (currency code and value) |
|
|
description |
Description of the price model item | |
|
id |
The unique identifier of the price model item | |
|
integrationId |
Integration ID | |
|
partNumber |
The part number of the price model data. This should match the part's lookup code. |
|
|
ratePlans |
An array of rate plan items | |
|
rootBomItemName |
The root BOM item's display name | |
|
rootBomItemVariableName |
The root BOM item's variable name | |
|
salesProductType |
The sales product type of the price model item | |
|
serviceDuration |
The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationPeriod |
The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationType |
The service duration type |
|
| Response Body Parameters |
JSON data for the newly added Price Model Item. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/testPriceModel/priceModelItems
{ "partNumber": "part12", "description": "", "bomItemName": "Name", "rootBomItemName": "Name", "bomItemVariableName": "ABOSampleChild", "rootBomItemVariableName": "ABOSampleRoot", "dateModified": "2023-04-18T16:12:51Z", "dateAdded": "2023-04-18T08:40:25Z" }
|
Description |
Use this endpoint to add pricing data to the specified price model. Beginning in Oracle CPQ 23D (v15) this endpoint is replaced with Add Price Model Item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/data |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model. |
|
HTTP Method |
POST |
|
| Request Body Parameters |
description |
The description of the Price Model data. |
|
id |
The unique identifier of the Price Model data. | |
|
partNumber |
The part number of the Price Model data. This should match the part's lookup code. | |
|
prices |
A key value pair with key as currency code and value as prices. | |
|
rangeFrom |
The starting range of the Price Model data. | |
|
rangeTo |
The ending range of the Price Model data. | |
|
bomItemVariableName |
The BOM item's variable name. | |
|
rootBomItemVariableName |
The root BOM item's variable name. | |
|
bomItemName |
The BOM item's display name. | |
|
rootBomItemName |
The root BOM item's display name. | |
|
Success Response |
JSON data for the pricing data added for a price model. |
|
https://sitename.oracle.com /rest/v17/pricingSetup/models/newPriceModel/data
Part Item Example - Request Body
{ "id": -1, "partNumber": "part20", "rangeFrom": 0, "rangeTo": 25, "prices": { "ALL": "0", "EUR": "0", "CAD": "0", "USD": "9", "CNY": "0" } }
BOM Item Example - Request Body
{ "id": -1, "bomItemVariableName": "bomItem13", "rootBomItemVariableName": "root13", "bomItemName": "bomItemName13", "rootBomItemName": "rootBomItemName13", "prices": { "ALL": "0", "EUR": "0", "CAD": "0", "USD": "1.1", "CNY": "0" } }
|
Description |
Use this endpoint to delete the specified price model item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
Delete Price Model Pricing Data
|
Description |
Use this endpoint to delete pricing data from the specified price model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/data/{id} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
id |
The unique id which represent the model data row |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified price model item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
bomItemName |
The BOM item's display name |
|
bomItemVariableName |
The BOM item's variable name | |
|
chargeCount |
The count of charges directly associated with this price model item | |
|
charges |
An array of the prices (currency code and value) |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the price model item |
|
|
dateModified |
Last modified date of the price model item |
|
|
description |
Description of the price model item | |
|
hasRatePlanSupport |
Indicates if the price model item supports rate plans. | |
|
id |
The Unique Identifier of the price model item | |
|
integrationId |
Integration ID | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
partNumber |
The part number of the price model data. This should match the part's lookup code. |
|
|
priceModelIntegrationId |
The parent price model Integration ID. |
|
|
ratePlanCount |
The count of rate plans linked to this price model item | |
|
ratePlans |
An array of rate plan items | |
|
rootBomItemName |
The root BOM item's display name | |
|
rootBomItemVariableName |
The root BOM item's variable name | |
|
salesProductType |
The sales product type of the price model item | |
|
serviceDuration |
The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationPeriod |
The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationType |
The service duration type |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/testPriceModel/priceModelItems/3022985793
{ "id": 3022985793, "partNumber": "part12", "description": "", "bomItemName": "Name", "rootBomItemName": "Name", "bomItemVariableName": "ABOSampleChild", "rootBomItemVariableName": "ABOSampleRoot", "dateModified": "2023-04-18T16:12:51Z", "dateAdded": "2023-04-18T08:40:25Z" }
|
Description |
Use this endpoint to retrieve all price model items for the specified price model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of price model items for the specified price model. |
|
|
bomItemName |
The BOM item's display name |
|
|
bomItemVariableName |
The BOM item's variable name | |
|
chargeCount |
The count of charges directly associated with this price model item | |
|
charges |
An array of the prices (currency code and value) |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the price model item |
|
|
dateModified |
Last modified date of the price model item |
|
|
description |
Description of the price model item | |
|
hasRatePlanSupport |
Indicates if the price model item supports rate plans. | |
|
id |
The Unique Identifier of the price model item | |
|
integrationId |
Integration ID | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
partNumber |
The part number of the price model data. This should match the part's lookup code. |
|
|
priceModelIntegrationId |
The parent price model Integration ID. |
|
|
ratePlanCount |
The count of rate plans linked to this price model item | |
|
ratePlans |
An array of rate plan items | |
|
rootBomItemName |
The root BOM item's display name | |
|
rootBomItemVariableName |
The root BOM item's variable name | |
|
salesProductType |
The sales product type of the price model item | |
|
serviceDuration |
The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationPeriod |
The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationType |
The service duration type |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/testPriceModel/priceModelItems
{ "items": [{ "id": 3022984798, "partNumber": "part12", "description": "", "bomItemName": "Name", "rootBomItemName": "Name", "bomItemVariableName": "ABOSampleChild", "rootBomItemVariableName": "ABOSampleRoot", "dateModified": "2023-04-18T10:02:14Z", "dateAdded": "2023-04-18T05:18:59Z" }, { "id": 3022985793, "partNumber": "part12", "description": "", "bomItemName": "Name", "rootBomItemName": "Name", "bomItemVariableName": "ABOSampleChild", "rootBomItemVariableName": "ABOSampleRoot", "dateModified": "2023-04-18T16:12:51Z", "dateAdded": "2023-04-18T08:40:25Z" } ] }
|
Description |
Use this endpoint to retrieve pricing data for the specified price model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/data |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of pricing data for the specified price model. Pricing data items include: description, id, part number, prices, and ranges. |
|
|
blockPrices |
The block price |
|
|
blockSize |
The block size |
|
|
bomItemName |
The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request. | |
|
bomItemVariableName |
The BOM Item's variable name | |
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitioniD |
The Id of the charge definition |
|
|
chargeType |
The category of charge | |
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the price model data | |
|
dateModified |
Last modified date of the price model data | |
|
description |
The description of the price model data | |
|
dynamicPricingType |
The dynamic pricing type of the price model charge. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the price model data | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
partNumber |
The part number of the price model data. This should match the part lookup's lookupCode. | |
|
pricePeriod |
The billing period |
|
|
prices |
The item prices | |
|
priceType |
The type of charge | |
|
primaryCharge |
Indicates whether this is the primary charge | |
|
rangeFrom |
The starting range of the price model data | |
|
rangeTo |
The ending range of the price model data | |
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
ratePlanName |
The rate plan name |
|
|
rootBomItemName |
The root BOM item's display name | |
|
rootBomItemVariableName |
The root BOM item's variable name | |
|
serviceDuration |
The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationPeriod |
The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationType |
The service duration type |
|
|
startDate |
The date from which the charge will be applicable. |
|
|
usageUOM |
The unit of measure for the charge | |
URI Endpoint Sample
https://sitename.oracle.com/rest/v17/pricingSetup/models/multipleProfiles2/data
Sample Response Body
{ "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/multipleProfiles2" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/multipleProfiles2/data" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/multipleProfiles2/data?offset=0&limit=1000" } ], "hasMore": false, "items": [{ "id": 3022743723, "partNumber": "part10", "description": "", "prices": { "EUR": "200", "USD": "3", "CNY": "1.75" } }, { "id": 15221418, "partNumber": "Customer Specific Pricing 19", "description": "test desc", "prices": { "USD": "12" } }, { "id": 3022746145, "partNumber": "part670", "description": "", "prices": { "EUR": "200", "USD": "3", "CNY": "1.75" } }, { "id": 3022746127, "partNumber": "part190", "description": "", "prices": { "EUR": "200", "USD": "3", "CNY": "1.75" } }, { "id": 3022746136, "partNumber": "part170", "description": "", "prices": { "EUR": "200", "USD": "3", "CNY": "1.75" } }, { "id": 3022746153, "partNumber": "part660", "description": "", "prices": { "EUR": "2", "USD": "3", "CNY": "1.75" } }, { "id": 3022756726, "partNumber": "part260", "description": "", "prices": { "EUR": "2", "USD": "3", "CNY": "1.75" } }, { "id": 3022746075, "partNumber": "part90", "description": "", "prices": { "EUR": "200", "USD": "3", "CNY": "1.75" } }, { "id": 3022896309, "partNumber": "part12", "prices": { "ALL": "0", "EUR": "0", "USD": "3.1", "CNY": "0" }, "bomItemName": "bomItemName12", "rootBomItemName": "rootBomItemName12", "bomItemVariableName": "bomItem12", "rootBomItemVariableName": "root12" } ], "offset": 0, "count": 8, "limit": 1000 }
URI Endpoint Sample
https://sitename.oracle.com/rest/v17/pricingSetup/models/tierDiscountPricing/data
Sample Response Body
{ "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/tPAOCommerce" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/tPAOCommerce/data" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/models/tPAOCommerce/data?offset=0&limit=1000" } ], "hasMore": false, "items": [{ "id": 3022649234, "partNumber": "part10", "description": "", "rangeFrom": 0, "rangeTo": 5, "prices": { "ALL": "0", "EUR": "0", "CAD": "0", "USD": "1.1", "CNY": "0" } }, { "id": 3022649235, "partNumber": "part10", "description": "", "rangeFrom": 5, "rangeTo": 10, "prices": { "USD": "2" } }, { "id": 3022649236, "partNumber": "part10", "description": "", "rangeFrom": 10, "rangeTo": 30, "prices": { "USD": "3" } }, { "id": 3022759072, "partNumber": "part10", "description": "", "rangeFrom": 30, "prices": { "ALL": "0", "EUR": "0", "CAD": "0", "USD": "1.1", "CNY": "0" } } ], "count": 4, "limit": 1000, "offset": 0 }
Get Price Model Pricing Data Item
|
Description |
Use this endpoint to retrieve the specified pricing data item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/data/{id} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
id |
The unique id which represent the model data row | |
|
(Optional) This endpoint supports the For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
| Response Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
bomItemName |
The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request. | |
|
bomItemVariableName |
The BOM Item's variable name | |
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitioniD |
The Id of the charge definition |
|
|
chargeType |
The category of charge | |
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the price model data | |
|
dateModified |
Last modified date of the price model data | |
|
description |
The description of the price model data | |
|
dynamicPricingType |
The dynamic pricing type of the price model charge. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the price model data | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
partNumber |
The part number of the price model data. This should match the part lookup's lookupCode. | |
|
pricePeriod |
The billing period |
|
|
prices |
The item prices | |
|
priceType |
The type of charge | |
|
primaryCharge |
Indicates whether this is the primary charge | |
|
rangeFrom |
The starting range of the price model data | |
|
rangeTo |
The ending range of the price model data | |
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
ratePlanName |
The rate plan name |
|
|
rootBomItemName |
The root BOM item's display name | |
|
rootBomItemVariableName |
The root BOM item's variable name | |
|
serviceDuration |
The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationPeriod |
The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. |
|
|
serviceDurationType |
The service duration type |
|
|
startDate |
The date from which the charge will be applicable. |
|
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/models/testPriceModel/data/3022746127
{ "id": 3022746127, "partNumber": "part190", "description": "", "prices": { "EUR": "200", "USD": "3", "CNY": "1.75" } }
Update Price Model Pricing Data
|
Description |
Use this endpoint to add, update, or delete pricing data for the specified price model. This endpoint can be used to Update collection of prices or discounts in a price model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/data |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model. |
|
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 Data for a Price Model for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/testPriceModel/data
Sample Request Body - Part Item Example
[{ "op": "replace", "path": "/3022746127", "value": { "partNumber": "part90", "prices": { "EUR": "2", "CNY": "1.75" } } } ]
Sample Request Body - BOM Item Examples
Update 'replace' Example
[{ "op": "replace", "path": "/36732751", "value": { "bomItemVariableName": "bomItem13", "rootBomItemVariableName": "root13", "prices": { "ALL": "0", "EUR": "0", "CAD": "0", "USD": "5.1", "CNY": "0" } } } ]
Add Example
[{ "op": "add", "path": "/", "value": { "id": -1, "partNumber": "part10", "bomItemVariableName": "bomItem12", "rootBomItemVariableName": "root12", "bomItemName": "bomItemName12", "rootBomItemName": "rootBomItemName12", "rangeFrom": 20, "rangeTo": 25, "prices": { "ALL": "0", "EUR": "0", "CAD": "0", "USD": "1.1", "CNY": "0" } } } ]
Price Model Charges
|
Description |
Use this endpoint to add a charge for the specified price model item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/charges |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
HTTP Method |
POST |
|
| Request Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
Display label of charge type |
|
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
Display label of price type |
|
|
pricingMatrixVariableName |
Pricing matrix variable name (Preview only. Not available for use.) |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
templateVariableName |
The pricing matrix template variable name |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
| Response Body Parameters |
JSON data for the newly added price model item charge. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36947090/charges
{ "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "primaryCharge": false, "dynamicPricingType": "static", "priceType": "One Time", "prices": [{ "currencyCode": "USD", "value": 59.99 } ] }
{ "id": 36988774, "dateModified": "2023-09-22T15:01:38Z", "dateAdded": "2023-09-22T15:01:38Z", "prices": [{ "currencyCode": "USD", "value": 59.99 } ], "chargeDefinition": "One-time Price", "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "chargeDefinitionId": 36895950, "primaryCharge": false, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static", "globalMarkets_c": "northAmerica_c" }
|
Description |
Use this endpoint to delete the specified price model item charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/charges/{id} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
id |
The unique identifier of the charge |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified price model item charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/charges/{id} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
id |
The unique identifier of the charge |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
Display label of charge type |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the charge definition |
|
|
dateModified |
Last modified date of the charge definition |
|
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
Display label of price type |
|
|
pricingMatrixVariableName |
Pricing matrix variable name (Preview only. Not available for use.) |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
templateVariableName |
The pricing matrix template variable name |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36964026/charges/3022960005
{ "id": 3022960005, "dateModified": "2023-05-16T14:57:50Z", "dateAdded": "2023-05-16T14:50:19Z", "prices": [{ "currencyCode": "JPY", "value": 50 }, { "currencyCode": "GBP", "value": 40 }, { "currencyCode": "USD", "value": 30 } ], "primaryCharge": true, "priceType": "One Time", "dynamicPricingType": "static" }
|
Description |
Use this endpoint to retrieve all charges for the specified price model item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/charges |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of charges. |
|
|
blockPrices |
The block price |
|
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
Display label of charge type |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the charge definition |
|
|
dateModified |
Last modified date of the charge definition |
|
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
Display label of price type |
|
|
pricingMatrixVariableName |
Pricing matrix variable name (Preview only. Not available for use.) |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
templateVariableName |
The pricing matrix template variable name |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36947090/charges
{ "items": [{ "id": 3022984798, "chargeDefinitionCode": "USAGE_SALE_PRICE", "priceType": "Usage", "pricePeriod": "Per Month", "primaryCharge": true, "prices": [{ "currencyCode": "USD", "value": 3002 } ], "dateModified": "2023-04-18T10:02:14Z", "dateAdded": "2023-04-18T05:18:59Z" }, { "id": 3022985793, "chargeDefinitionCode": "RECURRING_SALE_PRICE", "chargeType": "ORA_SALE", "priceType": "Recurring", "pricePeriod": "Per Month", "primaryCharge": false, "prices": [{ "currencyCode": "USD", "value": 2 } ], "dateModified": "2023-04-18T16:12:51Z", "dateAdded": "2023-04-18T08:40:25Z" } ] }
|
Description |
Use this endpoint to update a price model item charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/charges/{id} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
id |
The unique identifier of the charge |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
Display label of charge type |
|
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
Display label of price type |
|
|
pricingMatrixVariableName |
Pricing matrix variable name (Preview only. Not available for use.) |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
templateVariableName |
The pricing matrix template variable name |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36964026/charges/3022960005
{ "prices": [{ "currencyCode": "USD", "value": 30 }, { "currencyCode": "GBP", "value": 40 }, { "currencyCode": "JPY", "value": 50 } ] }
|
Description |
Use this endpoint to update charges for the specified price model item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/charges |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
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 Charge for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36947090/charges
[{ "op": "replace", "path": "/3022960005", "value": { "prices": [{ "currencyCode": "USD", "value": 10 }, { "currencyCode": "GBP", "value": 20 }, { "currencyCode": "JPY", "value": 30 } ] } } ]
Price Model Rate Plans
|
Description |
Use this endpoint to add a pricing rate plan to a price model item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
HTTP Method |
POST |
|
| Request Body Parameters |
charges |
An array of the prices (currency code and value) |
|
description |
Description of the pricing rate plan | |
|
endDate |
The date at which the charge will end |
|
|
integrationId |
Integration ID |
|
|
name |
Name of the pricing rate plan | |
|
orderNumber |
The position in a ordered list of rate plan |
|
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
Unique variable name of the pricing rate plan |
|
|
startDate |
The date from which the rate plan will be applicable |
|
| Response Body Parameters |
JSON data for the newly created rate plan. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/3022984792/ratePlans
{ "ratePlanNumber": "ratePlan3", "description": "Rate Plan used for Customer Specific Pricing 03", "name": "Rate Plan 3", "integrationId": "qpIntegrationId1", "startDate": "2023-02-18T10:02:14Z", "endDate": "2023-09-18T05:18:59Z", }
{ "id": 3022984300, "priceModelItemId": 3022984792, "ratePlanNumber": "ratePlan3", "description": "Rate Plan used for Customer Specific Pricing 03", "name": "Rate Plan 3", "integrationId": "qpIntegrationId1", "startDate": "2023-02-18T10:02:14Z", "endDate": "2023-09-18T05:18:59Z", "dateModified": "2023-04-18T10:02:14Z", "dateAdded": "2023-04-18T05:18:59Z" }
|
Description |
Use this endpoint to delete the specified price model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
The variable name of the pricing rate plan |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified the specified price model item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
The variable name of the pricing rate plan |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
chargeCount |
The count of charges directly associated with this price model item |
|
charges |
An array of the prices (currency code and value) |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the rate plan |
|
|
dateModified |
Last modified date of the rate plan |
|
|
description |
Description of the pricing rate plan | |
|
endDate |
The date at which the charge will end |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing rate plan | |
|
orderNumber |
The position in a ordered list of rate plan |
|
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
Unique variable name of the pricing rate plan |
|
|
startDate |
The date from which the rate plan will be applicable |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/3022952781/ratePlans/ratePlan2
{ "dateAdded": "2023-05-05T09:15:56Z", "dateModified": "2023-05-05T09:15:56Z", "description": "Rate Plan used for Customer Specific Pricing 02", "endDate": "2023-09-18T05:18:59Z", "integrationId": "qpIntegrationId1", "name": "Rate Plan 1", "ratePlanNumber": "ratePlan2", "startDate": "2023-02-18T10:02:14Z", "priceModelItemId": "3022952781" }
|
Description |
Use this endpoint to retrieve all rate plans for the specified price model item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of rate plans for the specified price model item. |
|
|
chargeCount |
The count of charges directly associated with this price model item | |
|
charges |
An array of the prices (currency code and value) |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the rate plan |
|
|
dateModified |
Last modified date of the rate plan |
|
|
description |
Description of the pricing rate plan | |
|
endDate |
The date at which the charge will end |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing rate plan | |
|
orderNumber |
The position in a ordered list of rate plan |
|
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
Unique variable name of the pricing rate plan |
|
|
startDate |
The date from which the rate plan will be applicable |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/3022984792/ratePlans
{ "items": [{ "id": 3022984798, "priceModelItemId": 3022984792, "ratePlanNumber": "ratePlan1", "description": "", "name": "Rate Plan 1", "integrationId": "qpIntegrationId1", "startDate": "2023-02-18T10:02:14Z", "endDate": "2023-09-18T05:18:59Z", "dateModified": "2023-04-18T10:02:14Z", "dateAdded": "2023-04-18T05:18:59Z" }, { "id": 3022984298, "priceModelItemId": 3022984292, "ratePlanNumber": "ratePlan2", "description": "", "name": "Rate Plan 2", "integrationId": "qpIntegrationId1", "startDate": "2023-02-18T10:02:14Z", "endDate": "2023-09-18T05:18:59Z", "dateModified": "2023-04-18T10:02:14Z", "dateAdded": "2023-04-18T05:18:59Z" } ] }
|
Description |
Use this endpoint to retrieve the specified the specified price model item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
The variable name of the pricing rate plan |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
chargeCount |
The count of charges directly associated with this price model item |
|
charges |
An array of the prices (currency code and value) |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the rate plan |
|
|
dateModified |
Last modified date of the rate plan |
|
|
description |
Description of the pricing rate plan | |
|
endDate |
The date at which the charge will end |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing rate plan | |
|
orderNumber |
The position in a ordered list of rate plan |
|
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
Unique variable name of the pricing rate plan |
|
|
startDate |
The date from which the rate plan will be applicable |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/3022952781/ratePlans/ratePlan2
{ "dateAdded": "2023-05-05T09:15:56Z", "dateModified": "2023-05-05T09:15:56Z", "description": "Rate Plan used for Customer Specific Pricing 02", "endDate": "2023-09-18T05:18:59Z", "integrationId": "qpIntegrationId1", "name": "Rate Plan 1", "ratePlanNumber": "ratePlan2", "startDate": "2023-02-18T10:02:14Z", "priceModelItemId": "3022952781" }
|
Description |
Use this endpoint to update the specified price model item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
The variable name of the pricing rate plan |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
charges |
An array of the prices (currency code and value) |
|
description |
Description of the pricing rate plan | |
|
endDate |
The date at which the charge will end |
|
|
integrationId |
Integration ID |
|
|
name |
Name of the pricing rate plan | |
|
orderNumber |
The position in a ordered list of rate plan |
|
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
Unique variable name of the pricing rate plan |
|
|
startDate |
The date from which the rate plan will be applicable |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/3022952781/ratePlans/ratePlan3
{ "description": "Rate Plan 03 for Customer Specific Pricing", "startDate": "2023-12-01", "endDate": "2024-12-01" }
|
Description |
Use this endpoint to update the specified price model item rate plans. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17//pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
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 Rate Plan for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/3022984792/ratePlans
[{ "op": "add", "path": "/", "value": { "ratePlanNumber": "ratePlan3", "description": "Rate Plan used for Customer Specific Pricing 03", "name": "Rate Plan 3", "integrationId": "qpIntegrationId1", "startDate": "2023-02-18T10:02:14Z", "endDate": "2023-09-18T05:18:59Z", } }, { "op": "replace", "path": "/3022985793", "value": { "description": "New description" } }, { "op": "remove", "path": "/30229857934" } ]
Price Model Rate Plan Charges
Add Price Model Rate Plan Charge
|
Description |
Use this endpoint to add a charge to a price model item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
The variable name of the pricing rate plan |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
Display label of charge type |
|
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
Display label of price type |
|
|
pricingMatrixVariableName |
Pricing matrix variable name (Preview only. Not available for use.) |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
templateVariableName |
The pricing matrix template variable name |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
| Response Body Parameters |
JSON data for the newly added rate plan charge. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36947090/ratePlans/ratePlan1/charges
{ "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "primaryCharge": false, "dynamicPricingType": "static", "priceType": "One Time", "prices": [{ "currencyCode": "USD", "value": 59.99 } ] }
{ "id": 36988774, "dateModified": "2023-09-22T15:01:38Z", "dateAdded": "2023-09-22T15:01:38Z", "prices": [{ "currencyCode": "USD", "value": 59.99 } ], "chargeDefinition": "One-time Price", "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "chargeDefinitionId": 36895950, "primaryCharge": false, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static", "globalMarkets_c": "northAmerica_c" }
Delete Price Model Rate Plan Charge
|
Description |
Use this endpoint to delete the specified price model item rate plan charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges/{id} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
The variable name of the pricing rate plan |
|
|
id |
The unique identifier of the charge |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
Get Price Model Rate Plan Charge
|
Description |
Use this endpoint to retrieve the specified price model item price model item rate plan charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17//pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges/{id} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
The variable name of the pricing rate plan |
|
|
id |
The unique identifier of the charge |
|
|
(Optional) This endpoint supports the For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
Display label of charge type |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the charge definition |
|
|
dateModified |
Last modified date of the charge definition |
|
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
Display label of price type |
|
|
pricingMatrixVariableName |
Pricing matrix variable name (Preview only. Not available for use.) |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
templateVariableName |
The pricing matrix template variable name |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36947090/ratePlans/ratePlan1/charges/3022960005
{ "id": 3022960005, "dateModified": "2023-05-16T14:57:50Z", "dateAdded": "2023-05-16T14:50:19Z", "prices": [{ "currencyCode": "JPY", "value": 50 }, { "currencyCode": "GBP", "value": 40 }, { "currencyCode": "USD", "value": 30 } ], "primaryCharge": false, "priceType": "One Time", "dynamicPricingType": "static" }
Get Price Model Rate Plan Charges
|
Description |
Use this endpoint to retrieve all charges for the specified price model item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of charges for the specified price model item rate plan. |
|
|
blockPrices |
The block price |
|
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
Display label of charge type |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the charge definition |
|
|
dateModified |
Last modified date of the charge definition |
|
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
Display label of price type |
|
|
pricingMatrixVariableName |
Pricing matrix variable name (Preview only. Not available for use.) |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
templateVariableName |
The pricing matrix template variable name |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/3022952781/ratePlans/ratePlan1/charges
{ "items": [{ "id": 3022984798, "chargeCode": "USAGE_SALE_PRICE", "priceType": "Usage", "pricePeriod": "Per Month", "prices": [{ "currencyCode": "USD", "value": 3002 } ], "dateModified": "2023-04-18T10:02:14Z", "dateAdded": "2023-04-18T05:18:59Z" }, { "id": 3022985793, "chargeCode": "RECURRING_SALE_PRICE", "chargeType": "ORA_SALE", "priceType": "Recurring", "pricePeriod": "Per Month", "prices": [{ "currencyCode": "USD", "value": 2 } ], "dateModified": "2023-04-18T16:12:51Z", "dateAdded": "2023-04-18T08:40:25Z" } ] }
Sample Response Body with Dynamic Charge
{ "items": [{ "id": 3022984798, "chargeCode": "USAGE_SALE_PRICE", "priceType": "Usage", "pricePeriod": "Per Month", "tiers": [{ "id": 3022984798, "rangeFrom": 0, "rangeTo": 10, "prices": [{ "currencyCode": "USD", "value": 3002 } ] }, { "id": 3022984799, "rangeFrom": 10, "prices": [{ "currencyCode": "USD", "value": 3002 } ] } ] } ] }
Update Price Model Rate Plan Charge
|
Description |
Use this endpoint to update the specified price model item rate plan charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17//pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges/{id} |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
The variable name of the pricing rate plan |
|
|
id |
The unique identifier of the charge |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
Display label of charge type |
|
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
Display label of price type |
|
|
pricingMatrixVariableName |
Pricing matrix variable name (Preview only. Not available for use.) |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
templateVariableName |
The pricing matrix template variable name |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36947090/ratePlans/ratePlan1/charges/3022960005
{ "prices": [{ "currencyCode": "USD", "value": 30 }, { "currencyCode": "GBP", "value": 40 }, { "currencyCode": "JPY", "value": 50 } ] }
Update Price Model Rate Plan Charges
|
Description |
Use this endpoint to update charges for the specified price model item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/models/{modelVariableName}/priceModelItems/{priceModelItemId}/ratePlans/{ratePlanNumber}/charges |
|
|
Endpoint Parameters |
modelVariableName |
The variable name of the price model |
|
priceModelItemId |
The unique identifier of the price model item | |
|
ratePlanNumber |
The variable name of the pricing rate plan |
|
|
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 Rate Plan Charge for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36947090/ratePlans/ratePlan1/charges
[{ "op": "replace", "path": "/3022960005", "value": { "prices": [{ "currencyCode": "USD", "value": 10 }, { "currencyCode": "GBP", "value": 20 }, { "currencyCode": "JPY", "value": 30 } ] } } ]
