1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Order Management
  4. Pricing Strategies

Get all pricing strategies

get

/fscmRestApi/resources/11.13.18.05/pricingStrategies

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: Finds pricing strategies according to the primary key.
      Finder Variables:
      • PricingStrategyId; integer; Value that uniquely identifies the pricing strategy.
  • 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:
    • AllowCurrencyOverride; string; Contains one of the following values: Y or N. If Y, then allow overriding the currency. If N, then don't allow overriding the currency. The default value is N.
    • AllowPriceListOverride; string; Contains one of the following values: Y or N. If Y, then allow overriding the price list. If N, then don't allow overriding the price list. The default value is N.
    • BusinessUnit; string; Name of the business unit.
    • BusinessUnitId; integer; Value that uniquely identifies the business unit.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • DefaultCurrency; string; Default currency of the pricing strategy.
    • DefaultCurrencyCode; string; Abbreviation that identifies the default currency of the pricing strategy.
    • GLConversionType; string; Type of general ledger conversion for the pricing strategy.
    • GLConversionTypeCode; string; Abbreviation that identifies the general ledger conversion type for the pricing strategy.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • Objective; string; Objective for the pricing strategy.
    • ObjectiveCode; string; Abbreviation that identifies the objective for the pricing strategy.
    • PricingStrategyId; integer; Value that uniquely identifies the pricing strategy.
    • Status; string; Status that indicates whether this pricing strategy is approved or not. Valid values include Approved or In Progress.
    • StatusCode; string; Abbreviation that identifies the approval status of the price list.
    • StrategyDescription; string; Description of the pricing strategy.
    • StrategyEndDate; string; Date when the pricing strategy becomes inactive.
    • StrategyName; string; Name of the pricing strategy.
    • StrategyStartDate; string; Date when the pricing strategy becomes active.
  • 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 : pricingStrategies
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : pricingStrategies-item-response
Type: object
Show Source
Nested Schema : Allowed Override Currencies
Type: array
Title: Allowed Override Currencies
The Allowed Override Currencies resource associates the currencies that are allowed to override the default currency of the pricing strategy.
Show Source
Nested Schema : Associated Discount Lists
Type: array
Title: Associated Discount Lists
The Associated Discount Lists resource associates discount lists with pricing strategies.
Show Source
Nested Schema : Associated Segment Price Lists
Type: array
Title: Associated Segment Price Lists
The Associated Segment Price Lists resource associates segment price lists with pricing strategies.
Show Source
Nested Schema : Flexfields for Pricing Strategy Headers
Type: array
Title: Flexfields for Pricing Strategy Headers
The Flexfields for Pricing Strategy Headers resource associates descriptive flexfield segments and their values with a pricing strategy.
Show Source
Nested Schema : pricingStrategies-allowedOverrideCurrencies-item-response
Type: object
Show Source
Nested Schema : pricingStrategies-associatedDiscountLists-item-response
Type: object
Show Source
Nested Schema : Flexfields for Associated Discount Lists
Type: array
Title: Flexfields for Associated Discount Lists
The Flexfields for Associated Discount Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail.
Show Source
Nested Schema : Discount Lists
Type: array
Title: Discount Lists
The Discount Lists resource manages discounts of products and services.
Show Source
Nested Schema : pricingStrategies-associatedDiscountLists-DFF-item-response
Type: object
Show Source
Nested Schema : pricingStrategies-associatedDiscountLists-discountLists-item-response
Type: object
Show Source
Nested Schema : pricingStrategies-associatedSegmentPriceLists-item-response
Type: object
Show Source
Nested Schema : Flexfields for Associated Segment Price Lists
Type: array
Title: Flexfields for Associated Segment Price Lists
The Flexfields for Associated Segment Price Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail.
Show Source
Nested Schema : Price Lists
Type: array
Title: Price Lists
The Price Lists resource manages price lists of products and services.
Show Source
Nested Schema : pricingStrategies-associatedSegmentPriceLists-DFF-item-response
Type: object
Show Source
Nested Schema : pricingStrategies-associatedSegmentPriceLists-priceLists-item-response
Type: object
Show Source
Nested Schema : pricingStrategies-DFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all pricing strategies.

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/pricingStrategies"

Example Response Body

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

{
	"items": [
	{
		"PricingStrategyId": 300100073349802,
		"StrategyName": "Commercial strategy",
		"StrategyDescription": "Commercial pricing strategy",
		"Objective": null,
		"ObjectiveCode": null,
		"BusinessUnit": "Vision Operations",
		"BusinessUnitId": 204,
		"Status": "Approved",
		"StatusCode": "APPROVED",
		"DefaultCurrency": "US Dollar",
		"DefaultCurrencyCode": "USD",
		"GLConversionType": null,
		"GLConversionTypeCode": null,
		"StrategyStartDate": "2015-12-03T02:53:00+00:00",
		"StrategyEndDate": null,
		"AllowPriceListOverride": "N",
		"AllowCurrencyOverride": "N",
		"CreationDate": "2015-12-03T10:53:08+00:00",
		"CreatedBy": "PRICING_MGR_OPERATIONS",
		"LastUpdateDate": "2015-12-03T11:07:04.853+00:00",
		"LastUpdatedBy": "PRICING_MGR_OPERATIONS",
	}
	{
		...
	}
	]
}
Back to Top