Jump to

• Request
• Response
• Examples

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.
• 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".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_PricingRule

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates 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 By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures 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.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingRule"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures 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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates 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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingRule

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingRule"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : PricingRule

Type: object

Show Source

• active: boolean()
  Title: Active

  Indicates if the rule is active.
• anyProductCount: integer()
  Title: Linked Any Product Count

  Read Only: true

  The count of Any Product items linked to this rule.
• bomCount: integer()
  Title: Linked BOM Count

  Read Only: true

  The count of BOM items linked to this rule.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• customerSpecificConditions: Customer Specific Conditions
  Title: Customer Specific Conditions

  Read Only: true

  The 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 Added

  Read Only: true

  Creation date of the Pricing Rule.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Pricing Rule.
• description: string()
  Title: Description

  The description of the Pricing Rule.
• editRestriction: string()
  Title: Edit Restriction

  Read Only: true

  Allowed Values: [ "UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" ]

  Pricing Edit Restriction.
• endDate: string()
  Title: End Date

  The date after which the Pricing Rule will no longer be applicable.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• name: string()
  Title: Name

  The name of the Pricing Rule.
• orderNumber: integer()
  Title: Order Number

  The position(starting from 1) in a ordered list of Pricing Rules.
• productCount: integer()
  Title: Linked Products Count

  Read Only: true

  The count of products linked to this rule.
• ruleConditionType: string()
  Title: Rule Condition Type

  Allowed Values: [ "alwaysTrue", "customerSpecific", "simple", "advanced" ]

  The condition type of the Pricing Rule.
• ruleModelCount: integer()
  Title: Linked Price Models Count

  Read Only: true

  The count of price models linked to this rule.
• ruleModels: Linked Pricing Models
  Title: Linked Pricing Models

  Read Only: true

  The collection of linked Price Models. Note this is a child resource.
• simpleConditions: Simple Conditions
  Title: Simple Conditions

  The collection of simple conditions for the Pricing Rule of simple type. This is optional for other condition type.
• startDate: string()
  Title: Start Date

  The date from which the Pricing Rule will be applicable.
• variableName: string()
  Title: Variable Name

  The Unique Variable Name of the Pricing Rule.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Rule.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Rule.",
            "title":"Date Added",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"The name of the Pricing Rule.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The Unique Variable Name of the Pricing Rule.",
            "title":"Variable Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the Pricing Rule.",
            "title":"Description"
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position(starting from 1) in a ordered list of Pricing Rules.",
            "title":"Order Number"
        },
        "ruleConditionType":{
            "type":"string",
            "format":"",
            "description":"The condition type of the Pricing Rule.",
            "title":"Rule Condition Type",
            "enum":[
                "alwaysTrue",
                "customerSpecific",
                "simple",
                "advanced"
            ]
        },
        "startDate":{
            "type":"string",
            "format":"",
            "description":"The date from which the Pricing Rule will be applicable.",
            "title":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"",
            "description":"The date after which the Pricing Rule will no longer be applicable.",
            "title":"End Date"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the rule is active.",
            "title":"Active"
        },
        "simpleConditions":{
            "format":"",
            "description":"The collection of simple conditions for the Pricing Rule of simple type. This is optional for other condition type.",
            "title":"Simple Conditions",
            "allOf":[
                {
                    "$ref":"#/definitions/SimpleConditions"
                }
            ]
        },
        "customerSpecificConditions":{
            "format":"",
            "description":"The collection of Customer specific conditions for the Pricing Rule.Note this is a child resource.",
            "title":"Customer Specific Conditions",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingCustomerSpecificCondition"
                }
            ]
        },
        "ruleModels":{
            "format":"",
            "description":"The collection of linked Price Models. Note this is a child resource.",
            "title":"Linked Pricing Models",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingRuleModel"
                }
            ]
        },
        "ruleModelCount":{
            "type":"integer",
            "format":"",
            "description":"The count of price models linked to this rule.",
            "title":"Linked Price Models Count",
            "readOnly":true
        },
        "productCount":{
            "type":"integer",
            "format":"",
            "description":"The count of products linked to this rule.",
            "title":"Linked Products Count",
            "readOnly":true
        },
        "bomCount":{
            "type":"integer",
            "format":"",
            "description":"The count of BOM items linked to this rule.",
            "title":"Linked BOM Count",
            "readOnly":true
        },
        "anyProductCount":{
            "type":"integer",
            "format":"",
            "description":"The count of Any Product items linked to this rule.",
            "title":"Linked Any Product Count",
            "readOnly":true
        },
        "editRestriction":{
            "type":"string",
            "format":"",
            "description":"Pricing Edit Restriction.",
            "title":"Edit Restriction",
            "readOnly":true,
            "enum":[
                "UNRESTRICTED",
                "ONLY_REORDERABLE",
                "RESTRICTED"
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Customer Specific Conditions

Title: Customer Specific Conditions

Read Only: true

The 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

• object PricingResourceCollection_PricingCustomerSpecificCondition

{
    "format":"",
    "description":"The collection of Customer specific conditions for the Pricing Rule.Note this is a child resource.",
    "title":"Customer Specific Conditions",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingCustomerSpecificCondition"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Linked Pricing Models

Title: Linked Pricing Models

Read Only: true

The 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

• object PricingResourceCollection_PricingRuleModel

{
    "format":"",
    "description":"The collection of linked Price Models. Note this is a child resource.",
    "title":"Linked Pricing Models",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingRuleModel"
        }
    ]
}

Nested Schema : Simple Conditions

Title: Simple Conditions

The 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

• object SimpleConditions

{
    "format":"",
    "description":"The collection of simple conditions for the Pricing Rule of simple type. This is optional for other condition type.",
    "title":"Simple Conditions",
    "allOf":[
        {
            "$ref":"#/definitions/SimpleConditions"
        }
    ]
}

Nested Schema : PricingResourceCollection_PricingCustomerSpecificCondition

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates 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 By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures 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.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingCustomerSpecificCondition"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures 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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates 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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingCustomerSpecificCondition

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingCustomerSpecificCondition"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PricingCustomerSpecificCondition

Type: object

Show Source

• active: boolean()
  Title: Active

  Indicates whether the condition is active.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• customerId: string()
  Title: Customer ID

  The unique identifier of the customer.This should match the Account Lookup's Id field.
• customerName: string()
  Title: Customer Name

  Read Only: true

  The 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 Added

  Read Only: true

  Creation date of the Pricing Rule.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Pricing Rule.
• endDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: End Date

  The date after which the condition will become inactive.
• id: integer()
  Title: Id

  Read Only: true

  The unique identifier of the customer specific condition.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• startDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Start Date

  The date after which the condition will become active.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The unique identifier of the customer specific condition.",
            "title":"Id",
            "readOnly":true
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the condition is active.",
            "title":"Active"
        },
        "customerId":{
            "type":"string",
            "format":"",
            "description":"The unique identifier of the customer.This should match the Account Lookup's Id field.",
            "title":"Customer ID"
        },
        "customerName":{
            "type":"string",
            "format":"",
            "description":"The name of the customer.This should match the value from Account Lookup's lookupCode",
            "title":"Customer Name",
            "readOnly":true
        },
        "startDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date after which the condition will become active.",
            "title":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date after which the condition will become inactive.",
            "title":"End Date"
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Rule.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Rule.",
            "title":"Date Added",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : PricingResourceCollection_PricingRuleModel

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates 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 By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures 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.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingRuleModel"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures 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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates 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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingRuleModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingRuleModel"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PricingRuleModel

Type: object

Show Source

• adjustmentType: string()
  Title: The Adjustment Type of pricing model

  Read Only: true

  Allowed Values: [ "discountPercent", "discountAmount", "markupPercent", "markupAmount" ]

  Adjustment Type.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Pricing Model to Pricing Rule link.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Pricing Model to Pricing Rule link.
• description: string()
  Title: Description

  Read Only: true

  The description of the linked Pricing Model.
• dynamicPricingType: string()
  Title: Dynamic Pricing Type

  Read Only: true

  Allowed Values: [ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]

  The type of dynamic pricing applied by the linked Pricing Model.
• editRestriction: string()
  Title: Edit Restriction

  Read Only: true

  Allowed Values: [ "UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" ]

  Pricing Edit Restriction.
• hasBomItem: boolean()
  Title: Has BOM Item

  Read Only: true

  Indicates whether this model has prices defined for BOM Items.
• hasChargeSupport: boolean()
  Title: Has Charge Support

  Read Only: true

  Indicates whether this model has charge support.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• listType: string()
  Title: The List Type for the pricing model

  Read Only: true

  Allowed Values: [ "priceList", "discountList", "advanced", "markupList", "advancedByTemplate" ]

  List Type.
• name: string()
  Title: Name

  Read Only: true

  The name of the linked Pricing Model.
• orderNumber: integer()
  Title: Order Number

  The position(starting from 1) of the linked Pricing Model within the Pricing Rule.
• ruleCount: integer()
  Title: Linked Pricing Rules Count

  Read Only: true

  The count of pricing rules linked to this model.
• valueType: string()
  Title: Value Type

  Read Only: true

  Allowed Values: [ "absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent", "advancedByTemplate" ]

  The type of discount applied by the linked Pricing Model.
• variableName: string()
  Title: Variable Name

  The Unique Variable Name of the linked Pricing Model.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The Unique Variable Name of the linked Pricing Model.",
            "title":"Variable Name"
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position(starting from 1) of the linked Pricing Model within the Pricing Rule.",
            "title":"Order Number"
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Model to Pricing Rule link.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Model to Pricing Rule link.",
            "title":"Date Added",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"The name of the linked Pricing Model.",
            "title":"Name",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the linked Pricing Model.",
            "title":"Description",
            "readOnly":true
        },
        "ruleCount":{
            "type":"integer",
            "format":"",
            "description":"The count of pricing rules linked to this model.",
            "title":"Linked Pricing Rules Count",
            "readOnly":true
        },
        "editRestriction":{
            "type":"string",
            "format":"",
            "description":"Pricing Edit Restriction.",
            "title":"Edit Restriction",
            "readOnly":true,
            "enum":[
                "UNRESTRICTED",
                "ONLY_REORDERABLE",
                "RESTRICTED"
            ]
        },
        "hasBomItem":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this model has prices defined for BOM Items.",
            "title":"Has BOM Item",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "valueType":{
            "type":"string",
            "format":"",
            "description":"The type of discount applied by the linked Pricing Model.",
            "title":"Value Type",
            "readOnly":true,
            "enum":[
                "absolutePrice",
                "discountAmount",
                "discountPercent",
                "markupAmount",
                "markupPercent",
                "advancedByTemplate"
            ]
        },
        "dynamicPricingType":{
            "type":"string",
            "format":"",
            "description":"The type of dynamic pricing applied by the linked Pricing Model.",
            "title":"Dynamic Pricing Type",
            "readOnly":true,
            "enum":[
                "static",
                "advanced",
                "volume",
                "tiered",
                "rateCard",
                "attributeBasedCharge"
            ]
        },
        "listType":{
            "type":"string",
            "format":"",
            "description":"List Type.",
            "title":"The List Type for the pricing model",
            "readOnly":true,
            "enum":[
                "priceList",
                "discountList",
                "advanced",
                "markupList",
                "advancedByTemplate"
            ]
        },
        "adjustmentType":{
            "type":"string",
            "format":"",
            "description":"Adjustment Type.",
            "title":"The Adjustment Type of pricing model",
            "readOnly":true,
            "enum":[
                "discountPercent",
                "discountAmount",
                "markupPercent",
                "markupAmount"
            ]
        },
        "hasChargeSupport":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this model has charge support.",
            "title":"Has Charge Support",
            "readOnly":true
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : SimpleConditions

Type: object

Show Source

• ruleExpression: string()
  Title: Rule Expression

  The rule expression that will be evaluated.
• simpleConditionRows: array Simple Condition Rows
  Title: Simple Condition Rows

  A list of Simple Condition Rows.

{
    "properties":{
        "ruleExpression":{
            "type":"string",
            "format":"",
            "description":"The rule expression that will be evaluated.",
            "title":"Rule Expression"
        },
        "simpleConditionRows":{
            "type":"array",
            "format":"",
            "description":"A list of Simple Condition Rows.",
            "title":"Simple Condition Rows",
            "items":{
                "$ref":"#/definitions/SimpleConditionRow"
            }
        }
    }
}

Nested Schema : Simple Condition Rows

Type: array

Title: Simple Condition Rows

A list of Simple Condition Rows.

Show Source

• Array of: object SimpleConditionRow

{
    "type":"array",
    "format":"",
    "description":"A list of Simple Condition Rows.",
    "title":"Simple Condition Rows",
    "items":{
        "$ref":"#/definitions/SimpleConditionRow"
    }
}

Nested Schema : SimpleConditionRow

Type: object

Show Source

• displayName: string()
  Title: Display Name

  The display name of the Simple Condition Row.
• index: integer()
  Title: Index

  The index (starting from 1) of the Simple Condition Row.
• operator: string()
  Title: Operator

  Allowed 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 Value

  The value to match.
• variableName: string()
  Title: Simple Condition Row

  The variable name of the Simple Condition Row.

{
    "properties":{
        "index":{
            "type":"integer",
            "format":"",
            "description":"The index (starting from 1) of the Simple Condition Row.",
            "title":"Index"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the Simple Condition Row.",
            "title":"Simple Condition Row"
        },
        "displayName":{
            "type":"string",
            "format":"",
            "description":"The display name of the Simple Condition Row.",
            "title":"Display Name"
        },
        "operator":{
            "type":"string",
            "format":"",
            "description":"The operation of the Simple Condition Row.",
            "title":"Operator",
            "enum":[
                "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"
            ]
        },
        "value":{
            "type":"string",
            "format":"",
            "description":"The value to match.",
            "title":"Target Value"
        }
    }
}

Back to Top

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"
    }
  ]
}

Back to Top