Jump to

• Request
• Response

Create one adjustment

post

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

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
• linesUniqID(required): string
  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

• 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.
• Upsert-Mode:
  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

• AdjustmentAmount: number
  Amount of the manual price adjustment for a charge or total. The value is an amount or a percent.
• AdjustmentElementBasis: string
  Maximum Length: 1000

  Basis that pricing uses to calculate the manual pricing adjustment.
• AdjustmentElementBasisName: string
  Maximum Length: 30

  Name of the basis that pricing uses to calculate the manual pricing adjustment.
• AdjustmentType: string
  Maximum Length: 1000

  Method that pricing uses to calculate manual price adjustment for the item.
• AdjustmentTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of manual price adjustment.
• ChargeDefinition: string
  Maximum Length: 1000

  Definition of the charge that pricing uses to apply a manual price adjustment.
• ChargeDefinitionCode: string
  Maximum Length: 30

  Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.
• ChargeRollupFlag: boolean
  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.
• Comments: string
  Maximum Length: 1000

  Comments that describe the manual price adjustment.
• EffectiveNumberOfPeriods: number
  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.
• EffectivePeriodFrom: number
  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.
• EffectivePeriodUntil: number
  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.
• EffectivityType: string
  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.
• EffectivityTypeCode: string
  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.
• PricePeriodicity: string
  Maximum Length: 1000

  Price periodicity of the charge where pricing applies the manual price adjustment.
• PricePeriodicityCode: string
  Maximum Length: 30

  Abbreviation that identifies the price periodicity of the charge where pricing applies the manual price adjustment.
• Reason: string
  Maximum Length: 1000

  Reason for the manual price adjustment.
• ReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the reason for the manual price adjustment.
• SequenceNumber: integer (int32)
  Sequence that pricing uses to apply the manual price adjustment in relation to other manual price adjustments.
• SourceManualPriceAdjustmentId: string
  Maximum Length: 50

  Value that uniquely identifies the manual price adjustment. The source application assigns this value.
• ValidationStatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the validation status of the manual price adjustment.

{
    "type":"object",
    "properties":{
        "AdjustmentElementBasis":{
            "maxLength":"1000",
            "type":"string",
            "description":"Basis that pricing uses to calculate the manual pricing adjustment.",
            "nullable":true
        },
        "PricePeriodicityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity of the charge where pricing applies the manual price adjustment.",
            "nullable":true
        },
        "AdjustmentElementBasisName":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the basis that pricing uses to calculate the manual pricing adjustment.",
            "nullable":true
        },
        "ValidationStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the validation status of the manual price adjustment.",
            "nullable":true
        },
        "ChargeDefinition":{
            "maxLength":"1000",
            "type":"string",
            "description":"Definition of the charge that pricing uses to apply a manual price adjustment.",
            "nullable":true
        },
        "Comments":{
            "maxLength":"1000",
            "type":"string",
            "description":"Comments that describe the manual price adjustment.",
            "nullable":true
        },
        "EffectivityTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.",
            "nullable":true
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the reason for the manual price adjustment.",
            "nullable":true
        },
        "Reason":{
            "maxLength":"1000",
            "type":"string",
            "description":"Reason for the manual price adjustment.",
            "nullable":true
        },
        "AdjustmentType":{
            "maxLength":"1000",
            "type":"string",
            "description":"Method that pricing uses to calculate manual price adjustment for the item.",
            "nullable":true
        },
        "AdjustmentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of manual price adjustment.",
            "nullable":true
        },
        "PricePeriodicity":{
            "maxLength":"1000",
            "type":"string",
            "description":"Price periodicity of the charge where pricing applies the manual price adjustment.",
            "nullable":true
        },
        "ChargeRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "SourceManualPriceAdjustmentId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the manual price adjustment. The source application assigns this value.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence that pricing uses to apply the manual price adjustment in relation to other manual price adjustments.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "EffectivityType":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "EffectivePeriodUntil":{
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"Amount of the manual price adjustment for a charge or total. The value is an amount or a percent.",
            "nullable":true
        },
        "EffectivePeriodFrom":{
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "EffectiveNumberOfPeriods":{
            "type":"number",
            "description":"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.",
            "nullable":true
        }
    }
}

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 : salesOrdersForOrderHubRequests-lines-manualPriceAdjustments-item-response

Type: object

Show Source

• AdjustmentAmount: number
  Amount of the manual price adjustment for a charge or total. The value is an amount or a percent.
• AdjustmentElementBasis: string
  Maximum Length: 1000

  Basis that pricing uses to calculate the manual pricing adjustment.
• AdjustmentElementBasisName: string
  Maximum Length: 30

  Name of the basis that pricing uses to calculate the manual pricing adjustment.
• AdjustmentType: string
  Maximum Length: 1000

  Method that pricing uses to calculate manual price adjustment for the item.
• AdjustmentTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of manual price adjustment.
• ChargeDefinition: string
  Maximum Length: 1000

  Definition of the charge that pricing uses to apply a manual price adjustment.
• ChargeDefinitionCode: string
  Maximum Length: 30

  Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.
• ChargeRollupFlag: boolean
  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.
• Comments: string
  Maximum Length: 1000

  Comments that describe the manual price adjustment.
• EffectiveNumberOfPeriods: number
  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.
• EffectivePeriodFrom: number
  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.
• EffectivePeriodUntil: number
  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.
• EffectivityType: string
  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.
• EffectivityTypeCode: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• PricePeriodicity: string
  Maximum Length: 1000

  Price periodicity of the charge where pricing applies the manual price adjustment.
• PricePeriodicityCode: string
  Maximum Length: 30

  Abbreviation that identifies the price periodicity of the charge where pricing applies the manual price adjustment.
• Reason: string
  Maximum Length: 1000

  Reason for the manual price adjustment.
• ReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the reason for the manual price adjustment.
• SequenceNumber: integer (int32)
  Sequence that pricing uses to apply the manual price adjustment in relation to other manual price adjustments.
• SourceManualPriceAdjustmentId: string
  Maximum Length: 50

  Value that uniquely identifies the manual price adjustment. The source application assigns this value.
• ValidationStatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the validation status of the manual price adjustment.

{
    "type":"object",
    "properties":{
        "AdjustmentElementBasis":{
            "maxLength":"1000",
            "type":"string",
            "description":"Basis that pricing uses to calculate the manual pricing adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity of the charge where pricing applies the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentElementBasisName":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the basis that pricing uses to calculate the manual pricing adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the validation status of the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":"1000",
            "type":"string",
            "description":"Definition of the charge that pricing uses to apply a manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":"1000",
            "type":"string",
            "description":"Comments that describe the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectivityTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the reason for the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "Reason":{
            "maxLength":"1000",
            "type":"string",
            "description":"Reason for the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "maxLength":"1000",
            "type":"string",
            "description":"Method that pricing uses to calculate manual price adjustment for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicity":{
            "maxLength":"1000",
            "type":"string",
            "description":"Price periodicity of the charge where pricing applies the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceManualPriceAdjustmentId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the manual price adjustment. The source application assigns this value.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence that pricing uses to apply the manual price adjustment in relation to other manual price adjustments.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "EffectivityType":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectivePeriodUntil":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"Amount of the manual price adjustment for a charge or total. The value is an amount or a percent.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectivePeriodFrom":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveNumberOfPeriods":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

Back to Top