Get All Price Model Pricing Data
get
/rest/v19/pricingSetup/models/{modelVariableName}/data
Use this endpoint to retrieve pricing data items for the specified price model.
Request
Path Parameters
Query Parameters
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
-
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>
The following are the available finder names and corresponding finder variables:
- findByKeyword: Find pricing model data using part number, BOM Item Name, BOM Item Variable Name, rangeFrom and rangeTo.
Finder Variable:- keyword;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
- findModelDataByPartNumber: Find pricing model data using partNumber.
Finder Variable:- partNumber;string: The part number to find using an exact match
- findModelDataByProduct: Find pricing model data using part number.
Finder Variable:- product;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
- findModelDataByBomItem: Find pricing model data using bomItemVariableName,bomItemName,rootBomItemVariable,rootBomItemName
Finder Variable:- item;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
- findModelDataByBomItemVariableName: Find pricing model data using bomItemVariableName
Finder Variable:- bomItemVariableName;string: The bom item variable name to find using an exact match
- findByKeyword: Find pricing model data using part number, BOM Item Name, BOM Item Variable Name, rangeFrom and rangeTo.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderby: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
-
q: string
Filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : PricingResourceCollection_PricingModelData
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
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:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
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.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object
-
emailId:
string()
Title:
Email Id
Email Id of the user -
firstName:
string()
Title:
First Name
First Name of the user -
lastName:
string()
Title:
Last Name
Last Name of the user
Nested Schema : PricingModelData
Type:
Show Source
object
-
blockPrices:
array Block Prices
Title:
Block Prices
The block price. -
blockSize:
number()
Title:
Block Size
The block size. -
bomItemName:
string()
Title:
BOM Item Name
Read Only:true
The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request. -
bomItemVariableName:
string()
Title:
BOM Item Variable Name
Read Only:true
The BOM Item's variable name. -
chargeDefinition:
string()
Title:
Charge Definition
Read Only:true
Display Name of the Charge Definition. -
chargeDefinitionCode:
string()
Title:
Charge Definition Code
Read Only:true
The unique code of the Charge Definition. -
chargeDefinitionId:
integer()
Title:
Charge Definition ID
Read Only:true
ID of the Charge Definition. -
chargeType:
string()
Title:
Charge Type
Read Only:true
The category of charge. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the Price Model Data. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Price Model Data. -
description:
string()
Title:
Description
Read Only:true
The description of the Price Model Data -
dynamicPricingType:
string()
Title:
Dynamic Pricing Type
Read Only:true
Allowed Values:[ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]
The dynamic pricing type of the charge. -
endDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
End Date
Read Only:true
The date at which the Charge will end. -
id:
integer()
Title:
Id
Read Only:true
The Unique Identifier of the Price Model Data. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
partNumber:
string()
Title:
Part Number
Read Only:true
The part Number of the Price Model Data.This should match the Part Lookup's lookupCode. -
pricePeriod:
string()
Title:
Price Period
Read Only:true
The billing period. -
prices:
array Prices
Title:
Prices
The item prices. -
priceType:
string()
Title:
Price Type
Read Only:true
The type of charge. -
primaryCharge:
boolean()
Title:
Primary Charge
Read Only:true
Indicates whether this is the primary charge. -
quantityAggregation:
boolean()
Title:
Quantity Aggregation
Indicates whether to use aggregated quantity when calculating unit price for tiered-pricing. -
rangeFrom:
number()
Title:
Range From
Read Only:true
The starting range of the Price Model Data. -
rangeTo:
number()
Title:
Range To
Read Only:true
The ending range of the Price Model Data. -
rateCardName:
string()
Title:
Rate Card Name
Read Only:true
Rate Card name (Preview only. Not available for use.) -
rateCardVariableName:
string()
Title:
Rate Card Variable Name
Read Only:true
Rate Card variable name (Preview only. Not available for use.) -
ratePlanName:
string()
Title:
Rate Plan Name
Read Only:true
Rate Plan name. -
rootBomItemName:
string()
Title:
Root BOM Item Name
Read Only:true
The root BOM item's display name. -
rootBomItemVariableName:
string()
Title:
Root BOM Item Variable Name
Read Only:true
The root BOM item's variable name. -
serviceDuration:
integer()
Title:
Service Duration
Read Only:true
Service duration. -
serviceDurationPeriod:
string()
Title:
Service Duration Period
Read Only:true
Service duration period code. -
serviceDurationType:
string()
Title:
Service Duration Type
Read Only:true
Service duration type. -
startDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Start Date
Read Only:true
The date from which the Charge will be applicable. -
usageUOM:
string()
Title:
Usage UOM
Read Only:true
The unit of measure for the charge.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingCurrencyValues
Type:
Show Source
object
-
currencyCode:
string()
Title:
Currency Code
The currency code. -
value:
number()
Title:
Value
The currency value.
Examples
q and chargeq query parameters support to the following resources. The query expression should follow the MongoDB syntax.
- Supported comparison operators: $eq, $ne, $gt, $gte, $lt, $lte, $exists, $like, $in
- Supported logical operators: $and, $or
- When using the "%" wildcard with the $like operator, the wildcard must be encoded as "%25"
q Parameter Support
Supported Query Fields
- partNumber, bomItemVariableName, rootBomItemVariableName, chargeType, priceType, pricePeriod, primaryCharge, dynamicPricingType
- System fields, like chargeDateAdded, chargeDateModified
Not Supported Query Fields
- Inactive charge attribute and the charge attributes
- Currency data type attributes
- Parameters with joined fields, like createdBy, lastModifiedBy, description, salesProductType, bomItemName, rootBomItemName, serviceDurationType, ratePlanName, etc.
- The $like operator is not supported for "dynamicPricingType"
Examples
q={dateAdded: { $lte: "2025-02-01"}}
q={dateModified: { $gte: "2025-02-01"}}
q={_matrix_inputDateCol: { $eq: "2025-02-01"}}
q={_matrix_inputBooleanCol: true}
q={_matrix_inputBooleanCol: {$eq: true}}
q={_matrix_inputDecimalCol: 1.5}
q={_matrix_inputStringCol: { $in: ['test1', 'test3'] }, _matrix_outputStringCol: { $in: ['test2'] }}
q={$and: [{_matrix_inputIntegerCol: {$lt: 100}}, {_matrix_outputIntegerCol: {$exists: true}}]}
q={$or: [{_matrix_inputBooleanCol: {$eq: true}}, {_matrix_outputBooleanCol: {$eq: false}}]}
q={_matrix_inputStringCol: {$like: "%25test%25"}}
q={_matrix_inputStringCol: {$like: "test%25"}}
q={_matrix_inputStringCol: {$like:"test%25", $options: "I"}}
q={_matrix_inputStringCol: {$like: "%25test"}}
q={_matrix_inputStringCol: {$like: "test"}}
Endpoint Sample
The following examples show how to retrieve pricing data for the specified price model in Pricing Engine by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
Multiple Profiles Example
curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/models/multipleProfiles2/data
Sample Response Body
{ "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/models/multipleProfiles2" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/models/multipleProfiles2/data" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v19/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 }
Tiered Model Example
curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/models/tierDiscountPricing/data
Sample Response Body
{ "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/models/tPAOCommerce" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/models/tPAOCommerce/data" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v19/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 }