Update one price list

patch

/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : Price List Access Sets
Type: array
Title: Price List Access Sets
The Price List Access Sets resource associates access sets with a price list.
Show Source
Nested Schema : headerDFF
Type: array
Show Source
Nested Schema : Price List Items
Type: array
Title: Price List Items
The Price List Items resource manages the items in a price list. This resource doesn't manage the components and covered items.
Show Source
Nested Schema : priceLists-accessSets-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-headerDFF-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-items-item-patch-request
Type: object
Show Source
Nested Schema : Price List Charges
Type: array
Title: Price List Charges
The Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : Price List Component Items
Type: array
Title: Price List Component Items
The Price List Component Items resource manages the component items in a price list.
Show Source
Nested Schema : Price List Covered Items
Type: array
Title: Price List Covered Items
The Price List Covered Items resource manages the covered items in a price list.
Show Source
Nested Schema : itemsDFF
Type: array
Show Source
Nested Schema : Rate Plans
Type: array
Title: Rate Plans
The Rate Plans resource manages the rate plans. This resource isn't currently used.
Show Source
Nested Schema : priceLists-items-charges-item-patch-request
Type: object
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : Pricing Matrixes
Type: array
Title: Pricing Matrixes
A pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Tier Headers
Type: array
Title: Tier Headers
A tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation.
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
  • Maximum Length: 30
    Code that designates the type of change for the pricing matrixes for the approval flow.
  • Matrix Dimensions
    Title: Matrix Dimensions
    A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
  • Maximum Length: 30
    Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
  • Matrix Rules
    Title: Matrix Rules
    A matrix rule represents a condition based price adjustment, discount, rate table, and other features.
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
  • Maximum Length: 30
    Code that designates the type of change for the dimensions for the approval flow.
  • Maximum Length: 30
    Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
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
Nested Schema : headerDFF
Type: array
Show Source
Nested Schema : Tier Lines
Type: array
Title: Tier Lines
A tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments.
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 : linesDFF
Type: array
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-lines-linesDFF-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-items-componentItems-item-patch-request
Type: object
Show Source
Nested Schema : Price List Charges
Type: array
Title: Price List Charges
The Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-item-patch-request
Type: object
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-chargesDFF-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Price List Charges
Type: array
Title: Price List Charges
The Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-item-patch-request
Type: object
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-chargesDFF-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-item-patch-request
Type: object
Show Source
Nested Schema : Rate Plan Charges
Type: array
Title: Rate Plan Charges
A rate plan charge represents usage rate against which consumption would be rated. It also represents one time and recurring charges.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Pricing Matrixes
Type: array
Title: Pricing Matrixes
A pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : Pricing Matrixes
Type: array
Title: Pricing Matrixes
A pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Tier Headers
Type: array
Title: Tier Headers
A tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-item-patch-request
Type: object
Show Source
  • Maximum Length: 30
    Code that designates the type of change for the pricing matrixes for the approval flow.
  • Matrix Dimensions
    Title: Matrix Dimensions
    A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
  • Maximum Length: 30
    Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
  • Matrix Rules
    Title: Matrix Rules
    A matrix rule represents a condition based price adjustment, discount, rate table, and other features.
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-ratePlans-ratePlanCharges-basePriceMatrixes-dimensions-item-patch-request
Type: object
Show Source
  • Maximum Length: 30
    Code that designates the type of change for the dimensions for the approval flow.
  • Maximum Length: 30
    Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-rules-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-chargesDFF-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-item-patch-request
Type: object
Show Source
  • Maximum Length: 30
    Code that designates the type of change for the pricing matrixes for the approval flow.
  • Matrix Dimensions
    Title: Matrix Dimensions
    A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
  • Maximum Length: 30
    Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
  • Matrix Rules
    Title: Matrix Rules
    A matrix rule represents a condition based price adjustment, discount, rate table, and other features.
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-ratePlans-ratePlanCharges-pricingMatrixes-dimensions-item-patch-request
Type: object
Show Source
  • Maximum Length: 30
    Code that designates the type of change for the dimensions for the approval flow.
  • Maximum Length: 30
    Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-rules-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-item-patch-request
Type: object
Show Source
Nested Schema : headerDFF
Type: array
Show Source
Nested Schema : Tier Lines
Type: array
Title: Tier Lines
A tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-headerDFF-item-patch-request
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-item-patch-request
Type: object
Show Source
Nested Schema : linesDFF
Type: array
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-patch-request
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-item-response
Type: object
Show Source
Nested Schema : Price List Access Sets
Type: array
Title: Price List Access Sets
The Price List Access Sets resource associates access sets with a price list.
Show Source
Nested Schema : headerDFF
Type: array
Show Source
Nested Schema : Price List Items
Type: array
Title: Price List Items
The Price List Items resource manages the items in a price list. This resource doesn't manage the components and covered items.
Show Source
Nested Schema : priceLists-accessSets-item-response
Type: object
Show Source
Nested Schema : priceLists-headerDFF-item-response
Type: object
Show Source
Nested Schema : priceLists-items-item-response
Type: object
Show Source
Nested Schema : Price List Charges
Type: array
Title: Price List Charges
The Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : Price List Component Items
Type: array
Title: Price List Component Items
The Price List Component Items resource manages the component items in a price list.
Show Source
Nested Schema : Price List Covered Items
Type: array
Title: Price List Covered Items
The Price List Covered Items resource manages the covered items in a price list.
Show Source
Nested Schema : itemsDFF
Type: array
Show Source
Nested Schema : Rate Plans
Type: array
Title: Rate Plans
The Rate Plans resource manages the rate plans. This resource isn't currently used.
Show Source
Nested Schema : priceLists-items-charges-item-response
Type: object
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : Pricing Matrixes
Type: array
Title: Pricing Matrixes
A pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Tier Headers
Type: array
Title: Tier Headers
A tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation.
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
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-response
Type: object
Show Source
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 : headerDFF
Type: array
Show Source
Nested Schema : Tier Lines
Type: array
Title: Tier Lines
A tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments.
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 : linesDFF
Type: array
Show Source
Nested Schema : priceLists-items-charges-pricingTiers-lines-linesDFF-item-response
Type: object
Show Source
Nested Schema : priceLists-items-componentItems-item-response
Type: object
Show Source
Nested Schema : Price List Charges
Type: array
Title: Price List Charges
The Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-item-response
Type: object
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-chargesDFF-item-response
Type: object
Show Source
Nested Schema : priceLists-items-coveredItems-item-response
Type: object
Show Source
Nested Schema : Price List Charges
Type: array
Title: Price List Charges
The Price List Charges resource manages the charges of items in a price list.
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-item-response
Type: object
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-chargesDFF-item-response
Type: object
Show Source
Nested Schema : priceLists-items-itemsDFF-item-response
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-item-response
Type: object
Show Source
Nested Schema : Rate Plan Charges
Type: array
Title: Rate Plan Charges
A rate plan charge represents usage rate against which consumption would be rated. It also represents one time and recurring charges.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-item-response
Type: object
Show Source
Nested Schema : Pricing Matrixes
Type: array
Title: Pricing Matrixes
A pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : Pricing Matrixes
Type: array
Title: Pricing Matrixes
A pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : Tier Headers
Type: array
Title: Tier Headers
A tier header captures information about tier adjustments against usage rates. For example, tier basis, application and aggregation.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-item-response
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-ratePlans-ratePlanCharges-basePriceMatrixes-dimensions-item-response
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-rules-item-response
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-chargesDFF-item-response
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-item-response
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-ratePlans-ratePlanCharges-pricingMatrixes-dimensions-item-response
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingMatrixes-rules-item-response
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-item-response
Type: object
Show Source
Nested Schema : headerDFF
Type: array
Show Source
Nested Schema : Tier Lines
Type: array
Title: Tier Lines
A tier line captures information about tier adjustments against usage rates. For example, minimum, maximum and adjustments.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-headerDFF-item-response
Type: object
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-item-response
Type: object
Show Source
Nested Schema : linesDFF
Type: array
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to update one 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"

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.

{
  "PriceListDescription": "DESCRIPTIONUPDATE"
}

Example Response Body

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

{
"PriceListName": "PRICELISTNAME",
"PriceListId": 300100145312348,
"PriceListDescription": "DESCRIPTIONUPDATE",
"PriceListType": "Segment price list",
"PriceListTypeCode": "SEGMENT",
"BusinessUnit": "Vision Corporation",
"BusinessUnitId": 204,
"Currency": "US Dollar",
"CurrencyCode": "USD",
"Status": "In progress",
"StatusCode": "IN_PROGRESS",
"StartDate": "2009-05-08T03:30:00+00:00",
"EndDate": null,
"PricingChargeDefinition": null,
"PricingChargeDefinitionCode": null,
"PricingChargeDefinitionId": null,
"LineType": "Buy",
"LineTypeCode": "ORA_BUY",
"CalculationMethod": "Price",
"CalculationMethodCode": "PRICE"
}
Back to Top