Get all pricing strategies
get
/fscmRestApi/resources/11.13.18.05/pricingStrategies
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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.
- PrimaryKey: Finds pricing strategies according to the primary key.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
-
totalResults: boolean
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
-
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.
There's no request body for this operation.
Back to TopResponse
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 : pricingStrategies
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-item-response
Type:
Show Source
object-
AllowCurrencyOverride: string
Title:
Allow currency overrideMaximum Length:1Default Value:NContains 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. -
allowedOverrideCurrencies: array
Allowed Override Currencies
Title:
Allowed Override CurrenciesThe Allowed Override Currencies resource associates the currencies that are allowed to override the default currency of the pricing strategy. -
AllowPriceListOverride: string
Title:
Allow price list overrideMaximum Length:1Default Value:NContains 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. -
associatedDiscountLists: array
Associated Discount Lists
Title:
Associated Discount ListsThe Associated Discount Lists resource associates discount lists with pricing strategies. -
associatedSegmentPriceLists: array
Associated Segment Price Lists
Title:
Associated Segment Price ListsThe Associated Segment Price Lists resource associates segment price lists with pricing strategies. -
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId: integer
(int64)
Title:
Business UnitValue that uniquely identifies the business unit. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
DefaultCurrency: string
Default currency of the pricing strategy.
-
DefaultCurrencyCode: string
Title:
Default CurrencyMaximum Length:30Abbreviation that identifies the default currency of the pricing strategy. -
DFF: array
Flexfields for Pricing Strategy Headers
Title:
Flexfields for Pricing Strategy HeadersThe Flexfields for Pricing Strategy Headers resource associates descriptive flexfield segments and their values with a pricing strategy. -
GLConversionType: string
Type of general ledger conversion for the pricing strategy.
-
GLConversionTypeCode: string
Title:
Default GL Conversion TypeMaximum Length:30Abbreviation that identifies the general ledger conversion type for the pricing strategy. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Objective: string
Objective for the pricing strategy.
-
ObjectiveCode: string
Title:
ObjectiveMaximum Length:30Abbreviation that identifies the objective for the pricing strategy. -
PricingStrategyId: integer
(int64)
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
Title:
StatusMaximum Length:30Default Value:IN_PROGRESSAbbreviation that identifies the approval status of the price list. -
StrategyDescription: string
Title:
DescriptionMaximum Length:1000Description of the pricing strategy. -
StrategyEndDate: string
(date-time)
Title:
End DateDate when the pricing strategy becomes inactive. -
StrategyName: string
Title:
NameMaximum Length:80Name of the pricing strategy. -
StrategyStartDate: string
(date-time)
Title:
Start DateDate when the pricing strategy becomes active.
Nested Schema : Allowed Override Currencies
Type:
arrayTitle:
Allowed Override CurrenciesThe 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:
arrayTitle:
Associated Discount ListsThe Associated Discount Lists resource associates discount lists with pricing strategies.
Show Source
Nested Schema : Associated Segment Price Lists
Type:
arrayTitle:
Associated Segment Price ListsThe Associated Segment Price Lists resource associates segment price lists with pricing strategies.
Show Source
Nested Schema : Flexfields for Pricing Strategy Headers
Type:
arrayTitle:
Flexfields for Pricing Strategy HeadersThe Flexfields for Pricing Strategy Headers resource associates descriptive flexfield segments and their values with a pricing strategy.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-allowedOverrideCurrencies-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
Currency: string
Maximum Length:
255Currency allowed to override the default currency in the pricing strategy. -
CurrencyCode: string
Title:
CurrencyMaximum Length:30Abbreviation that identifies the currency allowed to override the default currency in the pricing strategy. -
EndDate: string
(date-time)
Title:
End DateDate when the currency allowed to override the default currency becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OverrideCurrencyId: integer
(int64)
Value that uniquely identifies the allowed override currency.
-
PricingStrategyId: integer
(int64)
Value that uniquely identifies the pricing strategy.
-
StartDate: string
(date-time)
Title:
Start DateDate when the currency allowed to override the default currency becomes active.
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 : pricingStrategies-associatedDiscountLists-item-response
Type:
Show Source
object-
AssociationEndDate: string
(date-time)
Title:
End DateDate when the association of the discount list to the pricing strategy becomes inactive. -
AssociationPrecedence: integer
Precedence of the association of the discount list to the pricing strategy.
-
AssociationStartDate: string
(date-time)
Title:
Start DateDate when the association of the discount list to the pricing strategy becomes active. -
BusinessUnit: string
Read Only:
trueName of the business unit. -
BusinessUnitId: integer
(int64)
Read Only:
trueValue that uniquely identifies the business unit. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
Currency: string
Read Only:
trueCurrency that the price list uses. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the currency of the discount list. -
Description: string
Read Only:
trueMaximum Length:1000Description of the discount list. -
DFF: array
Flexfields for Associated Discount Lists
Title:
Flexfields for Associated Discount ListsThe Flexfields for Associated Discount Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail. -
DiscountListId: integer
(int64)
Value that uniquely identifies the discount list.
-
DiscountListName: string
Name of the discount list.
-
discountLists: array
Discount Lists
Title:
Discount ListsThe Discount Lists resource manages discounts of products and services. -
EndDate: string
(date-time)
Read Only:
trueDate when the discount list becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail.
-
PricingStrategyId: integer
(int64)
Read Only:
trueValue that uniquely identifies the pricing strategy. -
StartDate: string
(date-time)
Read Only:
trueDate when the discount list becomes active. -
Status: string
Read Only:
trueStatus that indicates whether this discount list is approved. -
StatusCode: string
Title:
StatusRead Only:trueMaximum Length:30Abbreviation that identifies the approval status of the discount list.
Nested Schema : Flexfields for Associated Discount Lists
Type:
arrayTitle:
Flexfields for Associated Discount ListsThe 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:
arrayTitle:
Discount ListsThe Discount Lists resource manages discounts of products and services.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-associatedDiscountLists-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Descriptive flexfield context name for the pricing strategy header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail to which the descriptive flexfields belong.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-associatedDiscountLists-discountLists-item-response
Type:
Show Source
object-
DiscountListId: integer
(int64)
Value that uniquely identifies the discount list.
-
DiscountListName: string
Maximum Length:
80Name of the discount list. -
EndDate: string
(date-time)
Date when the discount list becomes inactive.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
StartDate: string
(date-time)
Date when the discount list becomes active.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-associatedSegmentPriceLists-item-response
Type:
Show Source
object-
AssociationEndDate: string
(date-time)
Title:
End DateDate when the association of the price list to the pricing strategy becomes inactive. -
AssociationPrecedence: integer
Precedence of the association of the price list to the pricing strategy.
-
AssociationStartDate: string
(date-time)
Title:
Start DateDate when the association of the price list to the pricing strategy becomes active. -
BusinessUnit: string
Read Only:
trueName of the business unit. -
BusinessUnitId: integer
(int64)
Read Only:
trueValue that uniquely identifies the business unit. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
Currency: string
Read Only:
trueCurrency that the price list uses. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the currency of the price list. -
Description: string
Read Only:
trueMaximum Length:1000Description of the price list. -
DFF: array
Flexfields for Associated Segment Price Lists
Title:
Flexfields for Associated Segment Price ListsThe Flexfields for Associated Segment Price Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail. -
EndDate: string
(date-time)
Title:
End DateRead Only:trueDate when the price list becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PriceListName: string
Name of the price list.
-
priceLists: array
Price Lists
Title:
Price ListsThe Price Lists resource manages price lists of products and services. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail.
-
PricingStrategyId: integer
(int64)
Read Only:
trueValue that uniquely identifies the pricing strategy. -
StartDate: string
(date-time)
Title:
Start DateRead Only:trueDate when the price list becomes active. -
Status: string
Read Only:
trueStatus that indicates whether this price list is approved. -
StatusCode: string
Title:
StatusRead Only:trueMaximum Length:30Abbreviation that identifies the approval status of the price list.
Nested Schema : Flexfields for Associated Segment Price Lists
Type:
arrayTitle:
Flexfields for Associated Segment Price ListsThe Flexfields for Associated Segment Price Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Price Lists
Type:
arrayTitle:
Price ListsThe Price Lists resource manages price lists of products and services.
Show Source
Nested Schema : pricingStrategies-associatedSegmentPriceLists-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Descriptive flexfield context name for the pricing strategy header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail to which the descriptive flexfields belong.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-associatedSegmentPriceLists-priceLists-item-response
Type:
Show Source
object-
EndDate: string
(date-time)
Title:
End DateDate when the price list becomes inactive. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PriceListName: string
Title:
NameMaximum Length:80Name of the price list. -
StartDate: string
(date-time)
Title:
Start DateDate when the price list becomes active.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pricingStrategies-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Descriptive flexfield context name for the pricing strategy header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PricingStrategyId: integer
(int64)
Value that uniquely identifies the pricing strategy to which the descriptive flexfields belong.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
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",
}
{
...
}
]
}