Create tier headers
post
/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/ratePlans/{RatePlanId}/child/ratePlanCharges/{RatePlanChargeId}/child/pricingTiers
Request
Path Parameters
-
PriceListId(required): integer(int64)
Value that uniquely identifies the price list.
-
PriceListItemId(required): integer(int64)
Value that uniquely identifies the price list item.
-
RatePlanChargeId(required): integer(int64)
Value that uniquely identifies the charge of the rate plan.
-
RatePlanId(required): integer(int64)
Value that uniquely identifies the rate plan.
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
Root Schema : schema
Type:
Show Source
object-
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment TypeMaximum Length:30Abbreviation that identifies the type of adjustment. -
AggregationMethod: string
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.
-
AggregationMethodCode: string
Title:
Aggregation MethodMaximum Length:30Default Value:ORA_ON_DOCUMENTAbbreviation that identifies the method of the tier aggregation. -
ApplicationMethod: string
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.
-
ApplicationMethodCode: string
Title:
Application MethodMaximum Length:30Default Value:PER_UNITAbbreviation that identifies the method of tier application. -
AppliesTo: string
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.
-
AppliesToCode: string
Title:
Apply ToMaximum Length:30Default Value:HIGHEST_TIERAbbreviation that identifies the tier applicability. -
headerDFF: array
Flexfields for Price List Header
Title:
Flexfields for Price List HeaderThe Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list. -
lines: array
Tier Lines
Title:
Tier LinesThe Tier Lines resource manages tier line details for pricing charges and discounts. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity.
-
ParentEntityType: string
Type of the parent entity. Valid values include Pricing charge and Pricing term. A list of accepted values is defined in the lookup type ORA_QP_PARENT_ENTITY_TYPES.
-
ParentEntityTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of the parent entity. -
PartialBlockAction: string
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.
-
PartialBlockActionCode: string
Title:
Partial Block ActionMaximum Length:30Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier BasisValue that uniquely identifies the tier basis. -
TierBasisType: string
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.
-
TierBasisTypeCode(required): string
Title:
Tier Basis TypeMaximum Length:30Abbreviation that identifies the type of the tier basis. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Flexfields for Price List Header
Type:
arrayTitle:
Flexfields for Price List HeaderThe Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list.
Show Source
Nested Schema : Tier Lines
Type:
arrayTitle:
Tier LinesThe Tier Lines resource manages tier line details for pricing charges and discounts.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-headerDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Descriptive flexfield context name for tier headers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
TieredPricingHeaderId: integer
(int64)
Value that uniquely identifies the tier header of a pricing charge or discount to which the descriptive flexfields belong.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-item-post-request
Type:
Show Source
object-
AdjustmentAmount(required): number
Title:
Adjustment AmountValue of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment TypeMaximum Length:30Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
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.
-
ApplicationMethodCode: string
Title:
Application MethodMaximum Length:30Abbreviation that identifies the method of tier application. -
IncrementValue: integer
Title:
Increment ValueIncrement value number. -
linesDFF: array
Flexfields for Tier Lines
Title:
Flexfields for Tier LinesThe Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line. -
Maximum: number
Title:
MaximumMaximum value for the tier line. -
Minimum(required): number
Title:
MinimumMinimum value for the tier line. -
TierHeaderId(required): integer
(int64)
Value that uniquely identifies the tier header.
-
TierLineId: integer
(int64)
Value that uniquely identifies the tier line.
-
TierLineNumber(required): integer
(int32)
Line number of the tier.
Nested Schema : Flexfields for Tier Lines
Type:
arrayTitle:
Flexfields for Tier LinesThe Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Descriptive flexfield context name for tier lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
TieredPricingLineId: integer
(int64)
Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.
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.
Root Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-item-response
Type:
Show Source
object-
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment TypeMaximum Length:30Abbreviation that identifies the type of adjustment. -
AggregationMethod: string
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.
-
AggregationMethodCode: string
Title:
Aggregation MethodMaximum Length:30Default Value:ORA_ON_DOCUMENTAbbreviation that identifies the method of the tier aggregation. -
ApplicationMethod: string
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.
-
ApplicationMethodCode: string
Title:
Application MethodMaximum Length:30Default Value:PER_UNITAbbreviation that identifies the method of tier application. -
AppliesTo: string
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.
-
AppliesToCode: string
Title:
Apply ToMaximum Length:30Default Value:HIGHEST_TIERAbbreviation that identifies the tier applicability. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EnforceAdjustmentCalculation: string
Title:
Enforce adjustment calculation on each tierRead Only:trueMaximum Length:30Default Value:NContains one of the following values: Y or N. If Y, then enforce adjustment calculation. If N, then do not enforce calculation. The default value is N. -
headerDFF: array
Flexfields for Price List Header
Title:
Flexfields for Price List HeaderThe Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
lines: array
Tier Lines
Title:
Tier LinesThe Tier Lines resource manages tier line details for pricing charges and discounts. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity.
-
ParentEntityType: string
Type of the parent entity. Valid values include Pricing charge and Pricing term. A list of accepted values is defined in the lookup type ORA_QP_PARENT_ENTITY_TYPES.
-
ParentEntityTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of the parent entity. -
PartialBlockAction: string
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.
-
PartialBlockActionCode: string
Title:
Partial Block ActionMaximum Length:30Abbreviation that identifies the tier partial block action. -
TierBasis: string
Name of the tier basis.
-
TierBasisId: integer
(int64)
Title:
Tier BasisValue that uniquely identifies the tier basis. -
TierBasisType: string
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.
-
TierBasisTypeCode: string
Title:
Tier Basis TypeMaximum Length:30Abbreviation that identifies the type of the tier basis. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
Nested Schema : Flexfields for Price List Header
Type:
arrayTitle:
Flexfields for Price List HeaderThe Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list.
Show Source
Nested Schema : Tier Lines
Type:
arrayTitle:
Tier LinesThe Tier Lines resource manages tier line details for pricing charges and discounts.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-headerDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Descriptive flexfield context name for tier headers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TieredPricingHeaderId: integer
(int64)
Value that uniquely identifies the tier header of a pricing charge or discount to which the descriptive flexfields belong.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-item-response
Type:
Show Source
object-
AdjustmentAmount: number
Title:
Adjustment AmountValue of the adjustment amount. -
AdjustmentBasis: string
Name of the adjustment basis.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment BasisValue that identifies the adjustment basis. -
AdjustmentType: string
Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
-
AdjustmentTypeCode: string
Title:
Adjustment TypeMaximum Length:30Abbreviation that identifies the type of adjustment. -
ApplicationMethod: string
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.
-
ApplicationMethodCode: string
Title:
Application MethodMaximum Length:30Abbreviation that identifies the method of tier application. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
IncrementValue: integer
Title:
Increment ValueIncrement value number. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
linesDFF: array
Flexfields for Tier Lines
Title:
Flexfields for Tier LinesThe Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Maximum: number
Title:
MaximumMaximum value for the tier line. -
Minimum: number
Title:
MinimumMinimum value for the tier line. -
TierHeaderId: integer
(int64)
Value that uniquely identifies the tier header.
-
TierLineId: integer
(int64)
Value that uniquely identifies the tier line.
-
TierLineNumber: integer
(int32)
Line number of the tier.
Nested Schema : Flexfields for Tier Lines
Type:
arrayTitle:
Flexfields for Tier LinesThe Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Descriptive flexfield context name for tier lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TieredPricingLineId: integer
(int64)
Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- headerDFF
-
Parameters:
- PriceListId:
$request.path.PriceListId - PriceListItemId:
$request.path.PriceListItemId - RatePlanChargeId:
$request.path.RatePlanChargeId - RatePlanId:
$request.path.RatePlanId - TierHeaderId2:
$request.path.TierHeaderId2
The Flexfields for Price List Header resource associates descriptive flexfield segments and its values with a price list. - PriceListId:
- lines
-
Parameters:
- PriceListId:
$request.path.PriceListId - PriceListItemId:
$request.path.PriceListItemId - RatePlanChargeId:
$request.path.RatePlanChargeId - RatePlanId:
$request.path.RatePlanId - TierHeaderId2:
$request.path.TierHeaderId2
The Tier Lines resource manages tier line details for pricing charges and discounts. - PriceListId: