1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Sales Orders for Order Hub
  5. Order Lines
  6. Manual Price Adjustments

Create one adjustment

post

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/manualPriceAdjustments

Request

Path Parameters
  • Value that uniquely identifies the sales order. It can have the following formats.

    - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
    Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".

    - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
    Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.

    When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
  • This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.
Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Amount of the manual price adjustment for a charge or total. The value is an amount or a percent.
  • Maximum Length: 30
    Basis that pricing uses to calculate the manual pricing adjustment.
  • Maximum Length: 255
    Name of the basis that pricing uses to calculate the manual pricing adjustment.
  • Maximum Length: 255
    Method that pricing uses to calculate manual price adjustment for the item.
  • Maximum Length: 30
    Abbreviation that identifies the type of manual price adjustment.
  • Maximum Length: 255
    Definition of the charge that pricing uses to apply a manual price adjustment.
  • Maximum Length: 30
    Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then pricing rolls up the charge for the manual price adjustment. If false, then pricing does not do this roll up. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, there is no default value.
  • Maximum Length: 1000
    Comments that describe the manual price adjustment.
  • Number of periods to use for the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Number that identifies the period when the price adjustment starts. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Number that identifies the period when the price adjustment ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Maximum Length: 80
    Type of effectivity of the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Maximum Length: 30
    Abbreviation that identifies the type of effectivity to use for the price adjustment. A list of accepted values is defined in the lookup type ORA_OSS_PRICE_ADJ_EFFECTIVITY. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Maximum Length: 255
    Price periodicity of the charge where pricing applies the manual price adjustment.
  • Maximum Length: 30
    Abbreviation that identifies the price periodicity of the charge where pricing applies the manual price adjustment.
  • Maximum Length: 255
    Reason for the manual price adjustment.
  • Maximum Length: 30
    Abbreviation that identifies the reason for the manual price adjustment.
  • Sequence that pricing uses to apply the manual price adjustment in relation to other manual price adjustments.
  • Maximum Length: 50
    Value that uniquely identifies the manual price adjustment. The source application assigns this value.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : salesOrdersForOrderHub-lines-manualPriceAdjustments-item-response
Type: object
Show Source
  • Amount of the manual price adjustment for a charge or total. The value is an amount or a percent.
  • Maximum Length: 30
    Basis that pricing uses to calculate the manual pricing adjustment.
  • Maximum Length: 255
    Name of the basis that pricing uses to calculate the manual pricing adjustment.
  • Maximum Length: 255
    Method that pricing uses to calculate manual price adjustment for the item.
  • Maximum Length: 30
    Abbreviation that identifies the type of manual price adjustment.
  • Maximum Length: 255
    Definition of the charge that pricing uses to apply a manual price adjustment.
  • Maximum Length: 30
    Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then pricing rolls up the charge for the manual price adjustment. If false, then pricing does not do this roll up. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, there is no default value.
  • Maximum Length: 1000
    Comments that describe the manual price adjustment.
  • Number of periods to use for the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Number that identifies the period when the price adjustment starts. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Number that identifies the period when the price adjustment ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Maximum Length: 80
    Type of effectivity of the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Maximum Length: 30
    Abbreviation that identifies the type of effectivity to use for the price adjustment. A list of accepted values is defined in the lookup type ORA_OSS_PRICE_ADJ_EFFECTIVITY. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Links
  • Read Only: true
    Value that identifies the manual price adjustment.
  • Read Only: true
    Value that identifies the parent entity where pricing applies the manual price adjustment.
  • Maximum Length: 255
    Price periodicity of the charge where pricing applies the manual price adjustment.
  • Maximum Length: 30
    Abbreviation that identifies the price periodicity of the charge where pricing applies the manual price adjustment.
  • Maximum Length: 255
    Reason for the manual price adjustment.
  • Maximum Length: 30
    Abbreviation that identifies the reason for the manual price adjustment.
  • Sequence that pricing uses to apply the manual price adjustment in relation to other manual price adjustments.
  • Maximum Length: 50
    Value that uniquely identifies the manual price adjustment. The source application assigns this value.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the validation status of the manual price adjustment.
Back to Top

Examples

This example describes how to add an adjustment.

Example cURL Command

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

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID/child/manualPriceAdjustments"

For example, use the following command:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Prepriced_Std_01/child/lines/00020000000EACED00057708000110F09BD2F2E60000000EACED00057708000110F09BD2F2E7/child/manualPriceAdjustment"

Example Request Body

The following example includes the contents of the request body in JSON format to add a new manual price adjustment to an order line in the existing order.

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.

You can achieve the same result with Create sales orders using the upsert-mode header parameter. Refer to the examples in the Create sales orders section to see how to update child resource in the existing order.

{  
    "AdjustmentAmount":60,
    "AdjustmentType":"Discount amount",
    "ChargeDefinition":"Sale Price",
    "ChargeRollupFlag":true,
    "Reason":"Price match",
    "SequenceNumber":1,
    "SourceManualPriceAdjustmentId":"SMPA2"
}

Example Response Body

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

{
}
Back to Top