1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Price Lists
  5. Price List Items
  6. Price List Charges

Update one item charge in a price list

patch

/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/charges/{PriceListChargeId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Flexfields for Price List Charges
Type: array
Title: Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
Show Source
Nested Schema : Matrix Headers
Type: array
Title: Matrix Headers
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts and other entities.
Show Source
Nested Schema : Tier Headers
Type: array
Title: Tier Headers
The Tier Headers resource manages tier headers for pricing charges and discounts.
Show Source
Nested Schema : priceLists-items-charges-chargesDFF-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-items-charges-pricingMatrixes-item-patch-request
Type: object
Show Source
Nested Schema : Matrix Dimensions
Type: array
Title: Matrix Dimensions
A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
Show Source
Nested Schema : Matrix Rules
Type: array
Title: Matrix Rules
A matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Show Source
Nested Schema : priceLists-items-charges-pricingMatrixes-dimensions-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-items-charges-pricingMatrixes-rules-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-item-patch-request
Type: object
Show Source
  • Name of the adjustment basis.
  • Title: Adjustment Basis
    Value that identifies the adjustment basis.
  • Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
  • Title: Adjustment Type
    Maximum Length: 30
    Abbreviation that identifies the type of adjustment.
  • Name of the tier aggregation method. Valid values include On line and On document. A list of accepted values is defined in the lookup type ORA_QP_AGGREGATION_METHODS.
  • Title: Aggregation Method
    Maximum Length: 30
    Default Value: ORA_ON_DOCUMENT
    Abbreviation that identifies the method of the tier aggregation.
  • Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
  • Title: Application Method
    Maximum Length: 30
    Default Value: PER_UNIT
    Abbreviation that identifies the method of tier application.
  • Name of the tier applicability. Valid values include Highest tier and All tiers. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES.
  • Title: Apply To
    Maximum Length: 30
    Default Value: HIGHEST_TIER
    Abbreviation that identifies the tier applicability.
  • Flexfields for Price List Header
    Title: Flexfields for Price List Header
    The Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list.
  • Tier Lines
    Title: Tier Lines
    The Tier Lines resource manages tier line details for pricing charges and discounts.
  • Name of the tier partial block action. Valid values include Partial blocks and Satisfied blocks. A list of accepted values is defined in the lookup type ORA_QP_PARTIAL_BLOCK_ACTIONS.
  • Title: Partial Block Action
    Maximum Length: 30
    Abbreviation that identifies the tier partial block action.
  • Name of the tier basis.
  • Title: Tier Basis
    Value that uniquely identifies the tier basis.
  • Type of the tier basis. Valid values include Extended amount and Item quantity. A list of accepted values is defined in the lookup type ORA_QP_TIER_BASIS_TYPES.
  • Title: Tier Basis Type
    Maximum Length: 30
    Abbreviation that identifies the type of the tier basis.
Nested Schema : Flexfields for Price List Header
Type: array
Title: Flexfields for Price List Header
The Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list.
Show Source
Nested Schema : Tier Lines
Type: array
Title: Tier Lines
The Tier Lines resource manages tier line details for pricing charges and discounts.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-lines-item-patch-request
Type: object
Show Source
Nested Schema : Flexfields for Tier Lines
Type: array
Title: Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.
Show Source
Nested Schema : schema
Type: object
Show Source
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 : priceLists-items-charges-item-response
Type: object
Show Source
Nested Schema : Flexfields for Price List Charges
Type: array
Title: Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
Show Source
Nested Schema : Matrix Headers
Type: array
Title: Matrix Headers
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts and other entities.
Show Source
Nested Schema : Tier Headers
Type: array
Title: Tier Headers
The Tier Headers resource manages tier headers for pricing charges and discounts.
Show Source
Nested Schema : priceLists-items-charges-chargesDFF-item-response
Type: object
Show Source
Nested Schema : priceLists-items-charges-pricingMatrixes-item-response
Type: object
Show Source
Nested Schema : Matrix Dimensions
Type: array
Title: Matrix Dimensions
The Matrix Dimensions resource associates dimensions or conditions with a matrix header.
Show Source
Nested Schema : Matrix Rules
Type: array
Title: Matrix Rules
The Matrix Rules resource manages matrix rules for pricing charges, discounts, and other entities.
Show Source
Nested Schema : priceLists-items-charges-pricingMatrixes-dimensions-item-response
Type: object
Show Source
  • Title: Compare to Attribute
    Read Only: true
    Maximum Length: 80
    Represents the pricing entity attribute to which the dimension is mapped against.
  • Title: Comparison
    Read Only: true
    Maximum Length: 30
    Default Value: E
    Represents the comparison operator. Valid values include =, <,>, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_OPERATORS.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the record was created.
  • Title: Data Type
    Read Only: true
    Maximum Length: 30
    Default Value: STRING
    Type of the dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.
  • Title: Default Is Fixed Value
    Read Only: true
    Maximum Length: 1
    Default Value: N
    Contains one of the following values: Y or N. If Y, then the default value for the dimension is fixed. If N, then the default value for the dimension is not fixed. The default value is N.
  • Title: Default Value
    Read Only: true
    Default value for a dimension with a date data type.
  • Title: Default Value
    Read Only: true
    Default value for a dimension with a number data type.
  • Title: Default Value
    Read Only: true
    Maximum Length: 100
    Default value for a dimension with a string data type.
  • Title: Default Value
    Read Only: true
    Default value for a dimension with a time stamp data type.
  • Value that uniquely identifies the dimension.
  • Name of the matrix dimension.
  • Title: ColumnType
    Read Only: true
    Maximum Length: 50
    Type of the dimension.
  • Title: Display Sequence
    Read Only: true
    Sequence in which the dimensions get displayed.
  • Title: Domain Type
    Read Only: true
    Maximum Length: 30
    Default Value: NONE
    Type of the domain. Valid values include lookup, view object query, custom, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.
  • Title: Allow Null
    Read Only: true
    Maximum Length: 1
    Default Value: N
    Contains one of the following values: Y or N. If Y, then the dimension can be null. If N, then the dimension cannot be null. The default value is Y.
  • Read Only: true
    Date and time when the record was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Read Only: true
    Value that uniquely identifies the dimension for a pricing matrix.
  • Value that uniquely identifies the pricing matrix header.
  • Title: Null Is Wildcard
    Read Only: true
    Maximum Length: 1
    Default Value: N
    Contains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension cannot be null for search. The default value is Y.
  • Title: Required
    Read Only: true
    Maximum Length: 240
    Default Value: N
    Contains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension is not required. The default value is N.
  • Title: Fixed Column Is Displayed
    Read Only: true
    Maximum Length: 1
    Default Value: N
    Indicates whether the dimension with a fixed default value needs to be displayed in the matrix rules user interface. The default value is N.
  • Title: Source Code Name
    Read Only: true
    Maximum Length: 100
    Name of the source code for the matrix dimension.
Nested Schema : priceLists-items-charges-pricingMatrixes-rules-item-response
Type: object
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-item-response
Type: object
Show Source
Nested Schema : Flexfields for Price List Header
Type: array
Title: Flexfields for Price List Header
The Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list.
Show Source
Nested Schema : Tier Lines
Type: array
Title: Tier Lines
The Tier Lines resource manages tier line details for pricing charges and discounts.
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-headerDFF-item-response
Type: object
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-lines-item-response
Type: object
Show Source
Nested Schema : Flexfields for Tier Lines
Type: array
Title: Flexfields for Tier Lines
The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-lines-linesDFF-item-response
Type: object
Show Source
Links
ChargeDefinitionsVVO
The following properties are defined on the LOV link relation:
  • Source Attribute: PricingChargeDefinitionId; Target Attribute: PricingChargeDefinitionId
  • Display Attribute: PricingChargeDefintion
chargesDFF
Parameters:
  • PriceListChargeId: $request.path.PriceListChargeId
  • PriceListId: $request.path.PriceListId
  • PriceListItemId: $request.path.PriceListItemId
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
pricingMatrixes
Parameters:
  • PriceListChargeId: $request.path.PriceListChargeId
  • PriceListId: $request.path.PriceListId
  • PriceListItemId: $request.path.PriceListItemId
The Pricing Matrixes resource manages matrix headers for pricing charges, discounts and other entities.
pricingTiers
Parameters:
  • PriceListChargeId: $request.path.PriceListChargeId
  • PriceListId: $request.path.PriceListId
  • PriceListItemId: $request.path.PriceListItemId
The Tier Headers resource manages tier headers for pricing charges and discounts.
validateDateOverlap
Parameters:
  • PriceListChargeId: $request.path.PriceListChargeId
  • PriceListId: $request.path.PriceListId
  • PriceListItemId: $request.path.PriceListItemId
Validates a price list charge to ensure there are no conflicting dates between charges.
Back to Top

Examples

This example describes how to update one item charge in a price list.

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/priceLists/PriceListId/child/items/PriceListItemId/child/charges/PriceListChargeId"

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. 

{
 "BasePrice" : 35 
}

Example Response Body

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

{
    "PriceListChargeId": 300100149278710,
    "ParentEntityId": 300100149278281,
    "PriceListId": 300100149278040,
    "PricingChargeDefinition": "Sale Price",
    "PricingChargeDefinitionCode": "QP_SALE_PRICE",
    "PricingChargeDefinitionId": 300100070841552,
    "PricePeriodicity": null,
    "PricePeriodicityCode": null,
    "CalculationMethod": "Price",
    "CalculationMethodCode": "PRICE",
    "CalculationType": null,
    "CalculationTypeCode": null,
    "AllowManualAdjustment": null,
    "BasePrice": 35,
    "CostCalculationAmount": null,
    "StartDate": "2017-04-30T09:37:00+00:00",
    "EndDate": "2018-06-14T18:30:00+00:00",
    "ChargeLineNumber": 1,
    "MatrixId": null,
    "TierHeaderId": null,
    "CreationDate": "2018-05-18T11:13:06.001+00:00",
    "CreatedBy": "PRICING_MGR_OPERATIONS",
    "LastUpdateDate": "2018-05-18T11:20:38+00:00",
    "LastUpdatedBy": "PRICING_MGR_OPERATIONS"
}
Back to Top