Jump to

• Request
• Response
• Examples

Create customer pricing profiles

post

/fscmRestApi/resources/11.13.18.05/customerPricingProfiles

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CostToServe: string
  Maximum Length: 255

  Value representing the cost to serve.
• CostToServeCode: string
  Title: Cost to Serve

  Maximum Length: 30

  Abbreviation representing the cost-to-serve value.
• CustomerPartyId(required): integer (int64)
  Value that uniquely identifies the customer party.
• CustomerPricingProfileId: integer (int64)
  Value that uniquely identifies the customer pricing profile.
• CustomerRating: string
  Maximum Length: 255

  Value representing the customer rating attribute.
• CustomerRatingCode: string
  Title: Customer Rating

  Maximum Length: 30

  Abbreviation representing the customer rating value.
• CustomerSize: string
  Maximum Length: 255

  Value representing the customer size.
• CustomerSizeCode: string
  Title: Customer Size

  Maximum Length: 30

  Abbreviation representing the customer size value.
• CustomerValue: string
  Maximum Length: 255

  Value representing the customer value.
• CustomerValueCode: string
  Title: Customer Value

  Maximum Length: 30

  Abbreviation representing the customer value.
• DFF: array DFF
• EndDate: string (date-time)
  Title: End Date

  Date when the record becomes inactive.
• Name: string
  Name of the customer pricing profile.
• RevenuePotential: string
  Maximum Length: 255

  Value representing the revenue potential.
• RevenuePotentialCode: string
  Title: Revenue Potential

  Maximum Length: 30

  Abbreviation representing the revenue potential value.
• StartDate(required): string (date-time)
  Title: Start Date

  Date when the record becomes effective.

{
    "required":[
        "CustomerPartyId",
        "StartDate"
    ],
    "type":"object",
    "properties":{
        "CostToServe":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the cost to serve.",
            "nullable":true
        },
        "CostToServeCode":{
            "title":"Cost to Serve",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the cost-to-serve value.",
            "nullable":true
        },
        "CustomerPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "CustomerPricingProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer pricing profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CustomerRating":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the customer rating attribute.",
            "nullable":true
        },
        "CustomerRatingCode":{
            "title":"Customer Rating",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the customer rating value.",
            "nullable":true
        },
        "CustomerSize":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the customer size.",
            "nullable":true
        },
        "CustomerSizeCode":{
            "title":"Customer Size",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the customer size value.",
            "nullable":true
        },
        "CustomerValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the customer value.",
            "nullable":true
        },
        "CustomerValueCode":{
            "title":"Customer Value",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the customer value.",
            "nullable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customerPricingProfiles-DFF-item-post-request"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the record becomes inactive.",
            "format":"date-time",
            "nullable":true
        },
        "Name":{
            "type":"string",
            "description":"Name of the customer pricing profile.",
            "nullable":true,
            "x-queryable":false
        },
        "RevenuePotential":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the revenue potential.",
            "nullable":true
        },
        "RevenuePotentialCode":{
            "title":"Revenue Potential",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the revenue potential value.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the record becomes effective.",
            "format":"date-time",
            "nullable":false
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/customerPricingProfiles-DFF-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CustomerPricingProfileId: integer (int64)

{
    "type":"object",
    "properties":{
        "CustomerPricingProfileId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : customerPricingProfiles-item-response

Type: object

Show Source

• CostToServe: string
  Maximum Length: 255

  Value representing the cost to serve.
• CostToServeCode: string
  Title: Cost to Serve

  Maximum Length: 30

  Abbreviation representing the cost-to-serve value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the record was created.
• CustomerPartyId: integer (int64)
  Value that uniquely identifies the customer party.
• CustomerPartyName: string
  Read Only: true

  Maximum Length: 255

  Name of the customer party.
• CustomerPartyNumber: string
  Read Only: true

  Maximum Length: 255

  Number of the customer party.
• CustomerPricingProfileId: integer (int64)
  Value that uniquely identifies the customer pricing profile.
• CustomerRating: string
  Maximum Length: 255

  Value representing the customer rating attribute.
• CustomerRatingCode: string
  Title: Customer Rating

  Maximum Length: 30

  Abbreviation representing the customer rating value.
• CustomerSize: string
  Maximum Length: 255

  Value representing the customer size.
• CustomerSizeCode: string
  Title: Customer Size

  Maximum Length: 30

  Abbreviation representing the customer size value.
• CustomerValue: string
  Maximum Length: 255

  Value representing the customer value.
• CustomerValueCode: string
  Title: Customer Value

  Maximum Length: 30

  Abbreviation representing the customer value.
• DFF: array DFF
• EndDate: string (date-time)
  Title: End Date

  Date when the record becomes inactive.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time of the last update.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Indicates the session sign-in associated with the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the customer pricing profile.
• RevenuePotential: string
  Maximum Length: 255

  Value representing the revenue potential.
• RevenuePotentialCode: string
  Title: Revenue Potential

  Maximum Length: 30

  Abbreviation representing the revenue potential value.
• StartDate: string (date-time)
  Title: Start Date

  Date when the record becomes effective.

{
    "type":"object",
    "properties":{
        "CostToServe":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the cost to serve.",
            "nullable":true,
            "x-queryable":true
        },
        "CostToServeCode":{
            "title":"Cost to Serve",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the cost-to-serve value.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CustomerPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerPartyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerPartyNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the customer party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerPricingProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer pricing profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CustomerRating":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the customer rating attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerRatingCode":{
            "title":"Customer Rating",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the customer rating value.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSize":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the customer size.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSizeCode":{
            "title":"Customer Size",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the customer size value.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the customer value.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerValueCode":{
            "title":"Customer Value",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the customer value.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customerPricingProfiles-DFF-item-response"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the record becomes inactive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time of the last update.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates the session sign-in associated with the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"Name of the customer pricing profile.",
            "nullable":true,
            "x-queryable":false
        },
        "RevenuePotential":{
            "maxLength":255,
            "type":"string",
            "description":"Value representing the revenue potential.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenuePotentialCode":{
            "title":"Revenue Potential",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation representing the revenue potential value.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the record becomes effective.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object customerPricingProfiles-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/customerPricingProfiles-DFF-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : customerPricingProfiles-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CustomerPricingProfileId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CustomerPricingProfileId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/customerPricingProfiles/{CustomerPricingProfileId}/child/DFF

Parameters:

• CustomerPricingProfileId: $request.path.CustomerPricingProfileId

Back to Top

Examples

This example describes how to create customer pricing profiles.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/customerPricingProfiles"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "CustomerPartyId": 764966,
    "RevenuePotential": "High",
    "CostToServe": "High",
    "CustomerRating": "High",
    "CustomerSize": "Small",
    "CustomerValue": "High",
    "StartDate": "2001-04-01T09:00:00+00:00",
    "EndDate": "2001-05-01T09:00:00+00:00"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "CustomerPricingProfileId": 300100657444608,
    "CustomerPartyId": 764966,
    "CustomerPartyNumber": null,
    "CustomerPartyName": null,
    "RevenuePotential": "High",
    "RevenuePotentialCode": "ORA_HIGH",
    "CostToServe": "High",
    "CostToServeCode": "ORA_HIGH",
    "CustomerRating": "High",
    "CustomerRatingCode": "ORA_HIGH",
    "CustomerSize": "Small",
    "CustomerSizeCode": "ORA_SMALL",
    "CustomerValue": "High",
    "CustomerValueCode": "ORA_HIGH",
    "StartDate": "2001-04-01T09:00:00+00:00",
    "EndDate": "2001-05-01T09:00:00+00:00",
    "LastUpdateDate": "2026-05-07T17:02:05.138+00:00",
    "LastUpdateLogin": "513B9EF5C12D1E68E06369DD000A67D8",
    "LastUpdatedBy": "SCMOPERATIONS",
    "CreationDate": "2026-05-07T17:02:05+00:00",
    "CreatedBy": "SCMOPERATIONS",
    "Name": null}

Back to Top