1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Pricing Tiers

Get all tier headers

get

/fscmRestApi/resources/11.13.18.05/pricingTiers

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find tier headers according to the primary key.
      Finder Variables:
      • TierHeaderId; integer; Value that uniquely identifies the tier header.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AdjustmentBasis; string; Name of the adjustment basis.
    • AdjustmentBasisId; integer; Value 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; Abbreviation 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; Abbreviation 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; Abbreviation 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; Abbreviation that identifies the tier applicability.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the record was created.
    • EnforceAdjustmentCalculation; string; Contains one of the following values. Y: enforce adjustment calculation. N: do not enforce calculation. The default value is N.
    • LastUpdateDate; string; Most recent date and time when the application updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • ParentEntityId; integer; 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; Abbreviation 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; Abbreviation that identifies the tier partial block action.
    • TierBasis; string; Name of the tier basis.
    • TierBasisId; integer; Value 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; Abbreviation that identifies the type of the tier basis.
    • TierHeaderId; integer; Value that uniquely identifies the tier header.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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 : pricingTiers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : pricingTiers-item-response
Type: object
Show Source
Nested Schema : Flexfields for Pricing Tiers
Type: array
Title: Flexfields for Pricing Tiers
The Flexfields for Pricing Tiers resource associates descriptive flexfield segments and its values to a tier header.
Show Source
Nested Schema : Tier Lines
Type: array
Title: Tier Lines
The Tier Lines resource manages the tier line details for pricing charges and discounts.
Show Source
Nested Schema : pricingTiers-headerDFF-item-response
Type: object
Show Source
Nested Schema : 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 to a tier line.
Show Source
Nested Schema : pricingTiers-lines-linesDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all tier headers.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/pricingTiers"

Example Response Body

The following shows an example of the response body in JSON format.

{
 "items": [
 {
    "TierHeaderId" : 300100132320156,
  "ParentEntityId" : 300100132320153,
  "ParentEntityType" : "Price list charge",
  "ParentEntityTypeCode" : "PRICE_LIST_CHARGE",
  "TierBasisType" : "Item quantity",
  "TierBasisTypeCode" : "ORA_ITEM_QUANTITY",
  "TierBasis" : null,
  "TierBasisId" : null,
  "AppliesTo" : "All tiers",
  "AppliesToCode" : "ALL_APPLICABLE_TIERS",
  "ApplicationMethod" : "As block",
  "ApplicationMethodCode" : "AS_BLOCK",
  "PartialBlockAction" : "Include partial block",
  "PartialBlockActionCode" : "PARTIAL_BLOCK",
  "AggregationMethod" : "On document",
  "AggregationMethodCode" : "ORA_ON_DOCUMENT",
  "AdjustmentType" : null,
  "AdjustmentTypeCode" : null,
  "AdjustmentBasis" : null,
  "AdjustmentBasisId" : null,
  "EnforceAdjustmentCalculation" : "N",
  "CreationDate" : "2018-05-11T10:50:55+00:00",
  "CreatedBy" : "PRICING_MGR_OPERATIONS",
  "LastUpdateDate" : "2018-05-11T10:50:55.405+00:00",
  "LastUpdatedBy" : "PRICING_MGR_OPERATIONS"
 },
 {
    ...
 } 
 ]
}
Back to Top