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
Body ()
Root Schema : updatePricingSettings_request
Type: object
Show Source
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
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
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updatePricingSettings_response
Type: object
Show Source
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
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

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top