Update a Price Model
patch
/rest/v19/pricingSetup/models/{modelVariableName}
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.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : PricingModel
Type:
Show Source
object-
accessType:
string()
Title:
Access TypeRead Only:trueAccess Type -
adjustmentType:
string()
Title:
The Adjustment Type of pricing modelAllowed Values:[ "discountPercent", "discountAmount", "markupPercent", "markupAmount" ]Adjustment Type. -
conditionType:
string()
Title:
Condition TypeAllowed Values:[ "alwaysTrue", "simple" ]The condition type of the Pricing Model. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
data:
Model Data
Title:
Model DataRead Only:trueList of data for the Pricing Model. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date AddedRead Only:trueCreation Date of the Pricing Model. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date ModifiedRead Only:trueLast Modified date of the Pricing Model. -
description:
string()
Title:
DescriptionDescription of the pricing Model. -
dynamicPricingType:
string()
Title:
Dynamic Pricing TypeAllowed Values:[ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]The type of dynamic pricing applied by the Pricing Model. -
editRestriction:
string()
Title:
Edit RestrictionRead Only:trueAllowed Values:[ "UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" ]Pricing Edit Restriction. -
endDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
End DateEffective End Date. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
hasBomItem:
boolean()
Title:
Has BOM ItemRead Only:trueIndicates whether this model has prices defined for BOM Items. -
hasCharges:
boolean()
Title:
Has ChargesRead Only:trueIndicates whether this Price Model has any charges. -
hasRateCards:
boolean()
Title:
Has Rate CardsRead Only:trueIndicates whether this model has any pricing model data that has linked rate cards. (Preview only) -
hasRatePlans:
boolean()
Title:
Has Rate PlansRead Only:trueIndicates whether this model has any pricing model data that has rate plans. -
hasTiers:
boolean()
Title:
Has TiersRead Only:trueIndicates whether this model has any pricing model data that has tiers. -
integrationId:
string()
Title:
Integration IdPrice List ID from SCM. -
lastModifiedBy:
Last Modified By
Title:
Last Modified ByRead Only:trueThe details of the user who modified the record. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
listType:
string()
Title:
The List Type for the pricing modelAllowed Values:[ "priceList", "discountList", "advanced", "markupList", "advancedByTemplate" ]List Type. -
matrixTemplateName:
string()
Title:
Dynamic Matrix Template NameRead Only:trueThe dynamic matrix template name of the Price Model. -
matrixTemplateVariableName:
string()
Title:
Dynamic Matrix Template Variable NameThe dynamic matrix template variable name of the Price Model. -
name:
string()
Title:
NameName of the Pricing Model. -
priceModelItems:
Model Items
Title:
Model ItemsRead Only:trueList of model items for the Price Model. -
ruleCount:
integer()
Title:
Linked Pricing Rules CountRead Only:trueThe count of pricing rules linked to this model. -
scriptingMatrixVariableName:
string()
Title:
Scripting Matrix Variable NameScripting Matrix variable name. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
settings:
Model Settings
Title:
Model SettingsRead Only:trueList of model settings for the Price Model. - shared: boolean()
-
simpleConditions:
Simple Conditions
Title:
Simple ConditionsA collection of simple Type conditions applied by the Pricing Model. This is optional for other condition type. -
startDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Start DateEffective Start Date. -
supportedMatrixTemplateVariableName:
string()
Title:
Supported Dynamic Matrix Pricing TemplateRead Only:trueThe supported dynamic matrix pricing template of the Price Model. -
valueType:
string()
Title:
Value TypeAllowed Values:[ "absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent", "advancedByTemplate" ]The value type of Pricing Model. -
variableName:
string()
Title:
Variable NameUnique Variable Name of the Pricing Model.
Nested Schema : Created By
Title:
Created ByRead Only:
trueThe details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Model Data
Title:
Model DataRead Only:
trueList of data for the Pricing Model.
Match All
List of data for the Pricing Model.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : Model Items
Title:
Model ItemsRead Only:
trueList of model items for the Price Model.
Match All
List of model items for the Price Model.
Show Source
Nested Schema : Model Settings
Title:
Model SettingsRead Only:
trueList of model settings for the Price Model.
Match All
List of model settings for the Price Model.
Show Source
Nested Schema : Simple Conditions
Title:
Simple ConditionsA collection of simple Type conditions applied by the Pricing Model. This is optional for other condition type.
Match All
A collection of simple Type conditions applied by the Pricing Model. This is optional for other condition type.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object-
emailId:
string()
Title:
Email IdEmail Id of the user -
firstName:
string()
Title:
First NameFirst Name of the user -
lastName:
string()
Title:
Last NameLast Name of the user
Nested Schema : PricingResourceCollection_PricingModelData
Type:
Show Source
object-
count:
integer()
Title:
CountRead Only:trueThe number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
hasMore:
boolean()
Title:
HasMoreRead Only:trueIndicates 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 ByRead Only:trueThe details of the user who modified the record. -
limit:
integer()
Title:
LimitRead Only:trueThe actual paging size used by the server. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
offset:
integer()
Title:
OffSetRead Only:trueThe offset value used in the current page. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
totalResults:
integer()
Title:
Total ResultsRead Only:trueCaptures 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 ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : PricingModelData
Type:
Show Source
object-
blockPrices:
array Block Prices
Title:
Block PricesThe block price. -
blockSize:
number()
Title:
Block SizeThe block size. -
bomItemName:
string()
Title:
BOM Item NameRead Only:trueThe 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 NameRead Only:trueThe BOM Item's variable name. -
chargeDefinition:
string()
Title:
Charge DefinitionRead Only:trueDisplay Name of the Charge Definition. -
chargeDefinitionCode:
string()
Title:
Charge Definition CodeRead Only:trueThe unique code of the Charge Definition. -
chargeDefinitionId:
integer()
Title:
Charge Definition IDRead Only:trueID of the Charge Definition. -
chargeType:
string()
Title:
Charge TypeRead Only:trueThe category of charge. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date AddedRead Only:trueCreation date of the Price Model Data. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date ModifiedRead Only:trueLast modified date of the Price Model Data. -
description:
string()
Title:
DescriptionRead Only:trueThe description of the Price Model Data -
dynamicPricingType:
string()
Title:
Dynamic Pricing TypeRead Only:trueAllowed 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 DateRead Only:trueThe date at which the Charge will end. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
id:
integer()
Title:
IdRead Only:trueThe Unique Identifier of the Price Model Data. -
lastModifiedBy:
Last Modified By
Title:
Last Modified ByRead Only:trueThe details of the user who modified the record. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
partNumber:
string()
Title:
Part NumberRead Only:trueThe part Number of the Price Model Data.This should match the Part Lookup's lookupCode. -
pricePeriod:
string()
Title:
Price PeriodRead Only:trueThe billing period. -
prices:
array Prices
Title:
PricesThe item prices. -
priceType:
string()
Title:
Price TypeRead Only:trueThe type of charge. -
primaryCharge:
boolean()
Title:
Primary ChargeRead Only:trueIndicates whether this is the primary charge. -
quantityAggregation:
boolean()
Title:
Quantity AggregationIndicates whether to use aggregated quantity when calculating unit price for tiered-pricing. -
rangeFrom:
number()
Title:
Range FromRead Only:trueThe starting range of the Price Model Data. -
rangeTo:
number()
Title:
Range ToRead Only:trueThe ending range of the Price Model Data. -
rateCardName:
string()
Title:
Rate Card NameRead Only:trueRate Card name (Preview only. Not available for use.) -
rateCardVariableName:
string()
Title:
Rate Card Variable NameRead Only:trueRate Card variable name (Preview only. Not available for use.) -
ratePlanName:
string()
Title:
Rate Plan NameRead Only:trueRate Plan name. -
rootBomItemName:
string()
Title:
Root BOM Item NameRead Only:trueThe root BOM item's display name. -
rootBomItemVariableName:
string()
Title:
Root BOM Item Variable NameRead Only:trueThe root BOM item's variable name. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
serviceDuration:
integer()
Title:
Service DurationRead Only:trueService duration. -
serviceDurationPeriod:
string()
Title:
Service Duration PeriodRead Only:trueService duration period code. -
serviceDurationType:
string()
Title:
Service Duration TypeRead Only:trueService duration type. -
startDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Start DateRead Only:trueThe date from which the Charge will be applicable. -
usageUOM:
string()
Title:
Usage UOMRead Only:trueThe unit of measure for the charge.
Nested Schema : Created By
Title:
Created ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : PricingCurrencyValues
Type:
Show Source
object-
currencyCode:
string()
Title:
Currency CodeThe currency code. -
value:
number()
Title:
ValueThe currency value.
Nested Schema : PricingResourceCollection_PriceModelItem
Type:
Show Source
object-
count:
integer()
Title:
CountRead Only:trueThe number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
hasMore:
boolean()
Title:
HasMoreRead Only:trueIndicates 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 ByRead Only:trueThe details of the user who modified the record. -
limit:
integer()
Title:
LimitRead Only:trueThe actual paging size used by the server. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
offset:
integer()
Title:
OffSetRead Only:trueThe offset value used in the current page. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
totalResults:
integer()
Title:
Total ResultsRead Only:trueCaptures 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 ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : PriceModelItem
Type:
Show Source
object-
bomItemName:
string()
Title:
BOM Item NameThe 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 NameThe BOM Item's variable name. -
chargeCount:
integer()
Title:
Associated Charges CountRead Only:trueThe count of charges directly associated with this price model item. -
charges:
Associated Charges
Title:
Associated ChargesRead Only:trueThe standalone charges associated with this price model item. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date AddedRead Only:trueCreation date of the Price Model Item. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date ModifiedRead Only:trueLast modified date of the Price Model Item. -
description:
string()
Title:
Part DescriptionRead Only:trueThe description of the Price Model Item. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
hasRatePlanSupport:
boolean()
Title:
Has Rate Plan SupportRead Only:trueIndicates if the Price Model Item supports rate plans. -
id:
integer()
Title:
IdRead Only:trueThe Unique Identifier of the Price Model Data. -
integrationId:
string()
Title:
Integration IdPrice List Item ID from SCM. -
lastModifiedBy:
Last Modified By
Title:
Last Modified ByRead Only:trueThe details of the user who modified the record. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
partNumber:
string()
Title:
Part NumberThe part Number of the Price Model Item.This should match the Part Lookup's lookupCode. -
priceModelIntegrationId:
string()
Title:
Price Model Integration IdThe parent Price Model Integration ID. -
ratePlanCount:
integer()
Title:
Associated Rate Plans CountRead Only:trueThe count of rate plans linked to this price model item. -
ratePlans:
Associated Rate Plans
Title:
Associated Rate PlansRead Only:trueThe rate plans linked to this price model item. -
rootBomItemName:
string()
Title:
Root BOM Item NameThe root BOM item's display name. -
rootBomItemVariableName:
string()
Title:
Root BOM Item Variable NameThe root BOM item's variable name. -
salesProductType:
string()
Title:
Sales Product TypeRead Only:trueThe sales product type of the Price Model Item. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
serviceDuration:
integer()
Title:
Service DurationThe 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:
string()
Title:
Service Duration PeriodThe 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:
string()
Title:
Service Duration TypeService duration type.
Nested Schema : Associated Charges
Title:
Associated ChargesRead Only:
trueThe standalone charges associated with this price model item.
Match All
The standalone charges associated with this price model item.
Show Source
Nested Schema : Created By
Title:
Created ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : Associated Rate Plans
Title:
Associated Rate PlansRead Only:
trueThe rate plans linked to this price model item.
Match All
The rate plans linked to this price model item.
Show Source
Nested Schema : PricingResourceCollection_PricingCharge
Type:
Show Source
object-
count:
integer()
Title:
CountRead Only:trueThe number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
hasMore:
boolean()
Title:
HasMoreRead Only:trueIndicates 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 ByRead Only:trueThe details of the user who modified the record. -
limit:
integer()
Title:
LimitRead Only:trueThe actual paging size used by the server. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
offset:
integer()
Title:
OffSetRead Only:trueThe offset value used in the current page. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
totalResults:
integer()
Title:
Total ResultsRead Only:trueCaptures 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 ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : PricingCharge
Type:
Show Source
object-
blockPrices:
array Block Prices
Title:
Block PricesThe block price. -
blockSize:
number()
Title:
Block SizeThe block size. -
chargeDefinition:
string()
Title:
Charge DefinitionRead Only:trueDisplay Name of the Charge Definition. -
chargeDefinitionCode:
string()
Title:
Charge Definition CodeThe unique code of the Charge Definition. -
chargeDefinitionId:
integer()
Title:
Charge Definition IDRead Only:trueID of the Charge Definition. -
chargeType:
string()
Title:
Charge TypeThe category of charge. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date AddedRead Only:trueCreation date. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date ModifiedRead Only:trueLast modified date. -
dynamicPricingType:
string()
Title:
Dynamic Pricing TypeAllowed 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 DateThe date at which the Charge will end. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
id:
integer()
Title:
IdRead Only:trueThe Unique Identifier of the Charge. -
integrationId:
string()
Title:
Integration IdRate Plan Charge ID from SCM. -
lastModifiedBy:
Last Modified By
Title:
Last Modified ByRead Only:trueThe details of the user who modified the record. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
pricePeriod:
string()
Title:
Price PeriodThe billing period. -
prices:
array Prices
Title:
PricesThe item prices. -
priceType:
string()
Title:
Price TypeThe type of charge. -
pricingMatrixVariableName:
string()
Title:
Pricing Matrix Variable NamePricing Matrix variable name (Preview only. Not available for use.) -
primaryCharge:
boolean()
Title:
Primary ChargeIndicates whether this is the primary charge. -
quantityAggregation:
boolean()
Title:
Quantity AggregationIndicates whether to use aggregated quantity when calculating unit price for tiered-pricing. -
rateCardName:
string()
Title:
Rate Card NameRead Only:trueRate Card name (Preview only. Not available for use.) -
rateCardVariableName:
string()
Title:
Rate Card Variable NameRate Card variable name (Preview only. Not available for use.) -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
startDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Start DateThe date from which the Charge will be applicable. -
templateVariableName:
string()
Title:
Pricing Matrix Template Variable NameThe pricing matrix emplate variable name. -
tiers:
array Tiers
Title:
TiersThe charge tiers. -
usageUOM:
string()
Title:
Usage UOMThe unit of measure for the charge.
Nested Schema : Created By
Title:
Created ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : ChargeTier
Type:
Show Source
object-
blockPrices:
array Block Prices
Title:
Block PricesThe block price for the corresponding tier. -
blockSize:
number()
Title:
Block SizeThe block size for the corresponding tier. -
prices:
array Prices
Title:
PricesThe prices. -
rangeFrom:
number()
Title:
Range FromThe starting range of the Charge. -
rangeTo:
number()
Title:
Range ToRead Only:trueThe ending range of the Charge.
Nested Schema : Block Prices
Type:
arrayTitle:
Block PricesThe block price for the corresponding tier.
Show Source
Nested Schema : PricingResourceCollection_PricingRatePlan
Type:
Show Source
object-
count:
integer()
Title:
CountRead Only:trueThe number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
hasMore:
boolean()
Title:
HasMoreRead Only:trueIndicates 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 ByRead Only:trueThe details of the user who modified the record. -
limit:
integer()
Title:
LimitRead Only:trueThe actual paging size used by the server. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
offset:
integer()
Title:
OffSetRead Only:trueThe offset value used in the current page. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
totalResults:
integer()
Title:
Total ResultsRead Only:trueCaptures 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 ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : PricingRatePlan
Type:
Show Source
object-
chargeCount:
integer()
Title:
Associated Charges CountRead Only:trueThe count of charges directly associated with this price model item. -
charges:
Charges
Title:
ChargesRead Only:trueRate Plan charges -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date AddedRead Only:trueCreation Date of the Pricing Rate Plan. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date ModifiedRead Only:trueLast Modified date of the Pricing Rate Plan. -
description:
string()
Title:
DescriptionDescription of the Pricing Rate Plan. -
endDate:
string()
Title:
End DateThe date after which the Pricing Rate Plan will no longer be applicable. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
integrationId:
string()
Title:
Integration IDThe integration ID of the Pricing rate plan. -
lastModifiedBy:
Last Modified By
Title:
Last Modified ByRead Only:trueThe details of the user who modified the record. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
name:
string()
Title:
NameName of the Pricing Rate Plan. -
orderNumber:
integer()
Title:
Order NumberThe position in a ordered list of Rate Plan. -
priceModelItemId:
integer()
Title:
Price ModelItem IdRead Only:trueThe Price ModelItem Id. -
priceModelItemIntegrationId:
string()
Title:
Price Model Item Integration IDThe integration ID of the parent Price Model Item. -
ratePlanNumber:
string()
Title:
Rate Plan NumberUnique Variable Name of the Pricing Rate Plan. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
startDate:
string()
Title:
Start DateThe date from which the Pricing Rate Plan will be applicable.
Nested Schema : Charges
Title:
ChargesRead Only:
trueRate Plan charges
Match All
Rate Plan charges
Show Source
Nested Schema : Created By
Title:
Created ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : PricingResourceCollection_PriceModelSetting
Type:
Show Source
object-
count:
integer()
Title:
CountRead Only:trueThe number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
hasMore:
boolean()
Title:
HasMoreRead Only:trueIndicates 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 ByRead Only:trueThe details of the user who modified the record. -
limit:
integer()
Title:
LimitRead Only:trueThe actual paging size used by the server. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
offset:
integer()
Title:
OffSetRead Only:trueThe offset value used in the current page. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
totalResults:
integer()
Title:
Total ResultsRead Only:trueCaptures 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 ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : PriceModelSetting
Type:
Show Source
object-
columnName:
string()
Title:
Column NameThe column name. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date AddedRead Only:trueCreation date of the Price Model Setting. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date ModifiedRead Only:trueLast modified date of the Price Model Setting. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
id:
integer()
Title:
IdRead Only:trueThe Unique Identifier of the Price Model Setting. -
lastModifiedBy:
Last Modified By
Title:
Last Modified ByRead Only:trueThe details of the user who modified the record. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type
Nested Schema : Created By
Title:
Created ByRead Only:
trueThe 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 ByRead Only:
trueThe 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:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : SimpleConditions
Type:
Show Source
object-
ruleExpression:
string()
Title:
Rule ExpressionThe rule expression that will be evaluated. -
simpleConditionRows:
array Simple Condition Rows
Title:
Simple Condition RowsA list of Simple Condition Rows.
Nested Schema : Simple Condition Rows
Type:
arrayTitle:
Simple Condition RowsA list of Simple Condition Rows.
Show Source
Nested Schema : SimpleConditionRow
Type:
Show Source
object-
displayName:
string()
Title:
Display NameThe display name of the Simple Condition Row. -
index:
integer()
Title:
IndexThe index (starting from 1) of the Simple Condition Row. -
operator:
string()
Title:
OperatorAllowed Values:[ "NONE", "EQUAL_TO", "NOT_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL_TO", "LESS_THAN", "LESS_THAN_EQUAL_TO", "CONTAINS", "NOT_CONTAINS", "STARTS_WITH", "NOT_STARTS_WITH", "ENDS_WITH", "NOT_ENDS_WITH" ]The operation of the Simple Condition Row. -
value:
string()
Title:
Target ValueThe value to match. -
variableName:
string()
Title:
Simple Condition RowThe variable name of the Simple Condition Row.
Response
204 Response
Success
Examples
The following examples show how to update the specified price model in Pricing Engine by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X PATCH -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/models/volumeDiscountPricing
Request Body Sample
{
"conditionType": "simple",
"simpleConditions": {
"ruleExpression": "1",
"simpleConditionRows": [{
"index": 1,
"variableName": "oRCL_pRC_quantity",
"displayName": "Quantity",
"operator": "GREATER_THAN",
"value": "10"
}
]
}
}