Get All Pricing Rules
get
                    /rest/v19/pricingSetup/rules
Use this endpoint to retrieve all pricing rules.
                
                Request
Query Parameters
                - 
                        expand: string
                        
                        When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=ruleModels,customerSpecificConditions. To include all the children and grandchildren, specify the value of this query parameter to be "all".
- 
                        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 rules using name,variableName and description.  
 Finder Variable:- keyword;string:The search text.
 
 - findRelatedRulesForModel: Find pricing rules using pricing model variable name.This excludes any models that are already linked to the pricing rule.  
 Finder Variable:- modelVariableName;string:The variableName of the model.
 
 
- findByKeyword: Find pricing rules using name,variableName and description.  
- 
                        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.
- 
                        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_PricingRule
    
      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 : 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 : PricingRule
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        object- 
            active: 
            boolean()
            Title:ActiveIndicates if the rule is active.
- 
            anyProductCount: 
            integer()
            Title:Linked Any Product CountRead Only:trueThe count of Any Product items linked to this rule.
- 
            bomCount: 
            integer()
            Title:Linked BOM CountRead Only:trueThe count of BOM items linked to this rule.
- 
            createdBy: 
             Created By
            
            Title:Created ByRead Only:trueThe details of the user who created the record.
- 
            customerSpecificConditions: 
             Customer Specific Conditions
            
            Title:Customer Specific ConditionsRead Only:trueThe collection of Customer specific conditions for the Pricing Rule.Note this is a child resource.
- 
            dateAdded: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Date AddedRead Only:trueCreation date of the Pricing Rule.
- 
            dateModified: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Date ModifiedRead Only:trueLast modified date of the Pricing Rule.
- 
            description: 
            string()
            Title:DescriptionThe description of the Pricing Rule.
- 
            editRestriction: 
            string()
            Title:Edit RestrictionRead Only:trueAllowed Values:[ "UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" ]Pricing Edit Restriction.
- 
            endDate: 
            string()
            Title:End DateThe date after which the Pricing Rule will no longer be applicable.
- 
            groupAccessEnabled: 
            boolean()
            Title:Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment
- 
            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:NameThe name of the Pricing Rule.
- 
            orderNumber: 
            integer()
            Title:Order NumberThe position(starting from 1) in a ordered list of Pricing Rules.
- 
            productCount: 
            integer()
            Title:Linked Products CountRead Only:trueThe count of products linked to this rule.
- 
            ruleConditionType: 
            string()
            Title:Rule Condition TypeAllowed Values:[ "alwaysTrue", "customerSpecific", "simple", "advanced" ]The condition type of the Pricing Rule.
- 
            ruleModelCount: 
            integer()
            Title:Linked Price Models CountRead Only:trueThe count of price models linked to this rule.
- 
            ruleModels: 
             Linked Pricing Models
            
            Title:Linked Pricing ModelsRead Only:trueThe collection of linked Price Models. Note this is a child resource.
- 
            segmentLevelAccessType: 
            string()
            Title:Segment-level Access TypeRead Only:trueSegment-level Access Type
- 
            simpleConditions: 
             Simple Conditions
            
            Title:Simple ConditionsThe collection of simple conditions for the Pricing Rule of simple type. This is optional for other condition type.
- 
            startDate: 
            string()
            Title:Start DateThe date from which the Pricing Rule will be applicable.
- 
            variableName: 
            string()
            Title:Variable NameThe Unique Variable Name of the Pricing Rule.
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 : Customer Specific Conditions
    
      
      
    
    
    
    Title: 
    
    
    
    
    Customer Specific ConditionsRead Only: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    trueThe collection of Customer specific conditions for the Pricing Rule.Note this is a child resource.
    
    
    
    
    
    
    Match All
    
        
            The collection of Customer specific conditions for the Pricing Rule.Note this is a child resource.
        
    
    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 : Linked Pricing Models
    
      
      
    
    
    
    Title: 
    
    
    
    
    Linked Pricing ModelsRead Only: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    trueThe collection of linked Price Models. Note this is a child resource.
    
    
    
    
    
    
    Match All
    
        
            The collection of linked Price Models. Note this is a child resource.
        
    
    Show Source
    
    
    
    
    
    
    
Nested Schema : Simple Conditions
    
      
      
    
    
    
    Title: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Simple ConditionsThe collection of simple conditions for the Pricing Rule of simple type. This is optional for other condition type.
    
    
    
    
    
    
    Match All
    
        
            The collection of simple conditions for the Pricing Rule of simple type. This is optional for other condition type.
        
    
    Show Source
    
    
    
    
    
    
    
Nested Schema : PricingResourceCollection_PricingCustomerSpecificCondition
    
      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 : PricingCustomerSpecificCondition
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        object- 
            active: 
            boolean()
            Title:ActiveIndicates whether the condition is active.
- 
            createdBy: 
             Created By
            
            Title:Created ByRead Only:trueThe details of the user who created the record.
- 
            customerId: 
            string()
            Title:Customer IDThe unique identifier of the customer.This should match the Account Lookup's Id field.
- 
            customerName: 
            string()
            Title:Customer NameRead Only:trueThe name of the customer.This should match the value from Account Lookup's lookupCode
- 
            dateAdded: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Date AddedRead Only:trueCreation date of the Pricing Rule.
- 
            dateModified: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Date ModifiedRead Only:trueLast modified date of the Pricing Rule.
- 
            endDate: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:End DateThe date after which the condition will become inactive.
- 
            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 customer specific condition.
- 
            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
- 
            startDate: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Start DateThe date after which the condition will become active.
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_PricingRuleModel
    
      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 : PricingRuleModel
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        object- 
            adjustmentType: 
            string()
            Title:The Adjustment Type of pricing modelRead Only:trueAllowed Values:[ "discountPercent", "discountAmount", "markupPercent", "markupAmount" ]Adjustment Type.
- 
            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 Model to Pricing Rule link.
- 
            dateModified: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Date ModifiedRead Only:trueLast modified date of the Pricing Model to Pricing Rule link.
- 
            description: 
            string()
            Title:DescriptionRead Only:trueThe description of the linked Pricing Model.
- 
            dynamicPricingType: 
            string()
            Title:Dynamic Pricing TypeRead Only:trueAllowed Values:[ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]The type of dynamic pricing applied by the linked Pricing Model.
- 
            editRestriction: 
            string()
            Title:Edit RestrictionRead Only:trueAllowed Values:[ "UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" ]Pricing Edit Restriction.
- 
            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.
- 
            hasChargeSupport: 
            boolean()
            Title:Has Charge SupportRead Only:trueIndicates whether this model has charge support.
- 
            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 modelRead Only:trueAllowed Values:[ "priceList", "discountList", "advanced", "markupList", "advancedByTemplate" ]List Type.
- 
            name: 
            string()
            Title:NameRead Only:trueThe name of the linked Pricing Model.
- 
            orderNumber: 
            integer()
            Title:Order NumberThe position(starting from 1) of the linked Pricing Model within the Pricing Rule.
- 
            ruleCount: 
            integer()
            Title:Linked Pricing Rules CountRead Only:trueThe count of pricing rules linked to this model.
- 
            segmentLevelAccessType: 
            string()
            Title:Segment-level Access TypeRead Only:trueSegment-level Access Type
- 
            valueType: 
            string()
            Title:Value TypeRead Only:trueAllowed Values:[ "absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent", "advancedByTemplate" ]The type of discount applied by the linked Pricing Model.
- 
            variableName: 
            string()
            Title:Variable NameThe Unique Variable Name of the linked 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 : 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.
Examples
The following examples show how to retrieve all pricing rules in Pricing Engine by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
The following example includes the 'limit' query specification to limit the pricing rules in the results to five per page, and the 'orderby' query specification to order the results by order number in ascending order.
curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/rules/?limit=5&orderby=orderNumber:ASC
Response Body Sample
{
  "items": [{
      "dateModified": "2022-06-27T23:17:09Z",
      "dateAdded": "2022-06-27T23:16:44Z",
      "name": "Base Pricing Rule",
      "variableName": "basePricingRule",
      "orderNumber": 1,
      "ruleConditionType": "advanced",
      "active": true,
      "ruleModelCount": 2,
      "productCount": 3,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/basePricingRule"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/basePricingRule/ruleModels"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/basePricingRule/customerSpecificConditions"
        }
      ]
    }, {
      "dateModified": "2022-06-27T23:16:51Z",
      "dateAdded": "2022-06-22T20:37:40Z",
      "name": "Tier and Volume Pricing",
      "variableName": "tierAndVolumePricing",
      "orderNumber": 2,
      "ruleConditionType": "customerSpecific",
      "active": true,
      "ruleModelCount": 0,
      "productCount": 0,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/tierAndVolumePricing"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/tierAndVolumePricing/ruleModels"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/tierAndVolumePricing/customerSpecificConditions"
        }
      ]
    }, {
      "dateModified": "2022-06-27T23:16:51Z",
      "dateAdded": "2019-05-02T13:37:28Z",
      "name": "oRCL_pRC_runAllProfiles",
      "variableName": "oRCLpRCrunAllProfiles",
      "orderNumber": 3,
      "ruleConditionType": "advanced",
      "active": true,
      "ruleModelCount": 2,
      "productCount": 0,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/oRCLpRCrunAllProfiles"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/oRCLpRCrunAllProfiles/customerSpecificConditions"
        }
      ]
    }, {
      "dateModified": "2022-12-01T15:54:29Z",
      "dateAdded": "2019-11-04T14:56:12Z",
      "name": "CSP ABC Corp",
      "variableName": "cSPABCCorp",
      "orderNumber": 4,
      "ruleConditionType": "advanced",
      "active": true,
      "ruleModelCount": 1,
      "productCount": 0,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/cSPABCCorp"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/cSPABCCorp/ruleModels"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/cSPABCCorp/customerSpecificConditions"
        }
      ]
    }, {
      "dateModified": "2022-12-01T15:54:29Z",
      "dateAdded": "2021-06-22T12:03:11Z",
      "name": "Banking Rule",
      "variableName": "bankingRule",
      "orderNumber": 5,
      "ruleConditionType": "customerSpecific",
      "active": true,
      "ruleModelCount": 1,
      "productCount": 3,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/bankingRule"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/bankingRule/ruleModels"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules/bankingRule/customerSpecificConditions"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 5,
  "count": 5,
  "hasMore": true,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules?offset=0&limit=5&orderby=orderNumber:ASC"
    }, {
      "rel": "next",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rules?offset=5&limit=5&orderby=orderNumber:ASC"
    }
  ]
}