updatePricingSettings
put
/ccadmin/v1/priceSettings
Updates Price Settings. This operation is used to configure external systems like CPQ as Pricing System.
Request
Supported Media Types
- application/json
Root Schema : updatePricingSettings_request
Type:
Show Source
object
-
enabled:
boolean
A flag to indicate whether an external system like CPQ acts as a Pricing Source. This flag acts as a feature flag.
-
partNumberPropertyInCommerceItem:
string
This is a mappable property with external system like CPQ where partNumber is mapped with catalogRefId of CommerceItem in OCCS.
-
partNumberPropertyInSku:
string
This is a mappable property with external system like CPQ where partNumber is mapped with which attribute of sku id in OCCS.
-
pricingContextProperties:
object pricingContextProperties
This is for specifying the price context properties that Commerce needs to pass to external system like CPQ while fetching the price.
-
pricingSource:
string
Name of the Pricing System.
-
requiredResponseProperties:
array requiredResponseProperties
This is a customized way to fetch additional properties from external system if OOTB properties of OCCS are not sufficient. This list will be used exclusively in Store's fetchPrice api.
Example:
{
"requiredResponseProperties":[
"dynamicPricingType"
],
"partNumberPropertyInCommerceItem":"catalogRefId",
"pricingContextProperties":{
"orderProperties":{
"partyNumber":"_buyerAccountId",
"partyId":"_customerId"
},
"lineProperties":{
}
},
"pricingSource":"CPQ",
"enabled":true
}
Nested Schema : pricingContextProperties
Type:
object
This is for specifying the price context properties that Commerce needs to pass to external system like CPQ while fetching the price.
Show Source
-
lineProperties:
object lineProperties
Line/Item level properties which needs to be passed to external system. Key will be CommerceItem level property. Value will be external system's property.
-
orderProperties:
object orderProperties
Order level properties which needs to be passed to external system. Key will be Commerce Order level property. Value will be external system's property.
Nested Schema : requiredResponseProperties
Type:
array
This is a customized way to fetch additional properties from external system if OOTB properties of OCCS are not sufficient. This list will be used exclusively in Store's fetchPrice api.
Show Source
Nested Schema : lineProperties
Type:
object
Line/Item level properties which needs to be passed to external system. Key will be CommerceItem level property. Value will be external system's property.
Show Source
Nested Schema : orderProperties
Type:
object
Order level properties which needs to be passed to external system. Key will be Commerce Order level property. Value will be external system's property.
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updatePricingSettings_response
Type:
Show Source
object
-
enabled:
boolean
A flag to indicate whether an external system like CPQ acts as a Pricing Source. This flag acts as a feature flag.
-
partNumberPropertyInCommerceItem:
string
This is a mappable property with external system like CPQ where its partNumber is mapped with which attribute of commerceItem in OCCS.
-
partNumberPropertyInSku:
string
This is a mappable property with external system like CPQ where its partNumber is mapped with which attribute of sku id in OCCS.
-
pricingContextProperties:
object pricingContextProperties
This is for specifying the pricing context properties that Commerce needs to pass to external system like CPQ while fetching the price.
-
pricingSource:
string
Name of the Pricing System.
-
requiredResponseProperties:
array requiredResponseProperties
This is a customized way to fetch additional properties from external system if OOTB properties of OCCS are not sufficient. This list will be used exclusively in Store's fetchPrice api.
Nested Schema : pricingContextProperties
Type:
object
This is for specifying the pricing context properties that Commerce needs to pass to external system like CPQ while fetching the price.
Show Source
-
lineProperties:
object lineProperties
Line/Item level properties which needs to be passed to external system. Key will be CommerceItem level property. Value will be external system's property.
-
orderProperties:
object orderProperties
Order level properties which needs to be passed to external system. Key will be Commerce Order level property. Value will be external system's property.
Nested Schema : requiredResponseProperties
Type:
array
This is a customized way to fetch additional properties from external system if OOTB properties of OCCS are not sufficient. This list will be used exclusively in Store's fetchPrice api.
Show Source
Nested Schema : lineProperties
Type:
object
Line/Item level properties which needs to be passed to external system. Key will be CommerceItem level property. Value will be external system's property.
Show Source
Nested Schema : orderProperties
Type:
object
Order level properties which needs to be passed to external system. Key will be Commerce Order level property. Value will be external system's property.
Show Source
-
partyId:
string
Party id of organization
-
partyNumber:
string
Party number of organization
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code