Jump to

• Request
• Response

getPriceSettings

get

/ccadmin/v1/priceSettings

Gets the Price Settings.

Request

Supported Media Types

• application/json

Header Parameters

• x-ccsite(required): string
  The site id corresponding to which price setting should be fetched.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updatePricingSettings_response

Type: object

Show Source

• additionalFields: array additionalFields
  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.
• cartPricingContextProperties: object cartPricingContextProperties
  This is for specifying the price context properties that Commerce needs to pass to external system like CPQ while pricing the cart.
• 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.

{
    "properties":{
        "partNumberPropertyInCommerceItem":{
            "description":"This is a mappable property with external system like CPQ where its partNumber is mapped with which attribute of commerceItem in OCCS.",
            "type":"string"
        },
        "additionalFields":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "cartPricingContextProperties":{
            "description":"This is for specifying the price context properties that Commerce needs to pass to external system like CPQ while pricing the cart.",
            "type":"object",
            "properties":{
                "orderProperties":{
                    "description":"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.",
                    "type":"object",
                    "properties":{
                    }
                },
                "lineProperties":{
                    "description":"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.",
                    "type":"object",
                    "properties":{
                    }
                }
            }
        },
        "pricingContextProperties":{
            "description":"This is for specifying the pricing context properties that Commerce needs to pass to external system like CPQ while fetching the price.",
            "type":"object",
            "properties":{
                "orderProperties":{
                    "description":"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.",
                    "type":"object",
                    "properties":{
                    }
                },
                "organizationProperties":{
                    "description":"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.",
                    "type":"object",
                    "properties":{
                        "partyId":{
                            "description":"Party id of organization",
                            "type":"string"
                        }
                    }
                },
                "lineProperties":{
                    "description":"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.",
                    "type":"object",
                    "properties":{
                    }
                }
            }
        },
        "pricingSource":{
            "description":"Name of the Pricing System.",
            "type":"string"
        },
        "partNumberPropertyInSku":{
            "description":"This is a mappable property with external system like CPQ where its partNumber is mapped with which attribute of sku id in OCCS.",
            "type":"string"
        },
        "enabled":{
            "description":"A flag to indicate whether an external system like CPQ acts as a Pricing Source. This flag acts as a feature flag.",
            "type":"boolean"
        }
    }
}

Nested Schema : additionalFields

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

• Array of: string

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : cartPricingContextProperties

Type: object

This is for specifying the price context properties that Commerce needs to pass to external system like CPQ while pricing the cart.

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.

{
    "description":"This is for specifying the price context properties that Commerce needs to pass to external system like CPQ while pricing the cart.",
    "type":"object",
    "properties":{
        "orderProperties":{
            "description":"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.",
            "type":"object",
            "properties":{
            }
        },
        "lineProperties":{
            "description":"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.",
            "type":"object",
            "properties":{
            }
        }
    }
}

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.
• organizationProperties: object organizationProperties
  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.

{
    "description":"This is for specifying the pricing context properties that Commerce needs to pass to external system like CPQ while fetching the price.",
    "type":"object",
    "properties":{
        "orderProperties":{
            "description":"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.",
            "type":"object",
            "properties":{
            }
        },
        "organizationProperties":{
            "description":"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.",
            "type":"object",
            "properties":{
                "partyId":{
                    "description":"Party id of organization",
                    "type":"string"
                }
            }
        },
        "lineProperties":{
            "description":"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.",
            "type":"object",
            "properties":{
            }
        }
    }
}

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

{
    "description":"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.",
    "type":"object",
    "properties":{
    }
}

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

{
    "description":"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.",
    "type":"object",
    "properties":{
    }
}

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

{
    "description":"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.",
    "type":"object",
    "properties":{
    }
}

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

{
    "description":"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.",
    "type":"object",
    "properties":{
    }
}

Nested Schema : organizationProperties

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

• partyId: string
  Party id of organization

{
    "description":"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.",
    "type":"object",
    "properties":{
        "partyId":{
            "description":"Party id of organization",
            "type":"string"
        }
    }
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top