Jump to

• Request
• Response
• Examples

Add Customer Specific Condition

post

/rest/v16/pricingSetup/rules/{ruleVarName}/customerSpecificConditions

Use this endpoint to add a customer specific condition.

Request

Supported Media Types

• application/json

Path Parameters

• ruleVarName(required): string

Body ()

Root 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

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

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 : 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

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

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 to add a customer-specific condition for the specified 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 - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/rules/newCSPPricingRule/customerSpecificConditions

Request Body Sample

{
  "active": true,
  "customerId": "1001",
  "customerName": "ABC Solutions, Inc.",
  "startDate": "2023-01-01T06:00:00Z",
  "endDate": "2023-01-31T06:00:00Z"
}

Response Body Sample

{
  "id": 38824940,
  "active": true,
  "customerId": "1001",
  "customerName": "ABC Solutions, Inc.",
  "startDate": "2023-01-01T06:00:00Z",
  "endDate": "2023-01-31T06:00:00Z",
  "dateModified": "2022-12-02T17:43:22Z",
  "dateAdded": "2022-12-02T17:43:22Z"
}

Back to Top