Jump to

• Request
• Response
• Examples

Link a Pricing Model to Pricing Rule

post

/rest/v19/pricingSetup/rules/{ruleVariableName}/ruleModels

Use this endpoint to link a price model to a pricing rule. Note, this does not add a new pricing model.

Request

Supported Media Types

• application/json

Path Parameters

• ruleVariableName(required): string

Body ()

Root 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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• 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":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "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 : 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 : Link

Type: object

Show Source

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root 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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• 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":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "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 : 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 : Link

Type: object

Show Source

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

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

Back to Top

Examples

The following example shows how link a price model to a pricing rule in Pricing Engine by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/pricingSetup/rules/basePricingRule/ruleModels

Request Body Sample

{
  "variableName": "tierDiscountPricing"
}

Response Body Sample

{
  "variableName": "tierDiscountPricing",
  "orderNumber": 2,
  "dateModified": "2022-12-02T21:02:13Z",
  "dateAdded": "2022-12-02T21:02:13Z",
  "name": "Tier Discount Pricing",
  "valueType": "discountAmount",
  "dynamicPricingType": "tiered"
}

Back to Top