1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Channel Program Types

Get all program types

get

/fscmRestApi/resources/11.13.18.05/channelProgramTypes

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 channel program types according to the primary key.
      Finder Variables:
      • ProgramTypeId; integer; Value that uniquely identifies the channel program type.
    • ProgramTypeCodeAltKey: Finds channel program types according to the program type code.
      Finder Variables:
      • ProgramTypeCode; string; Abbreviation that identifies the channel program type during import and export.
  • 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:
    • AccrualNewCostBasis; string; Value that identifies the pricing basis that Oracle Pricing Cloud uses to calculate accruals when DISCOUNT TYPE in a program is NEW COST.
    • AccrualNewCostBasisId; integer; Value that identifies the pricing basis that Oracle Pricing Cloud uses to calculate accruals when DISCOUNT TYPE in the program is NEW COST.
    • AccrualPercentBasis; string; Name of the pricing basis that Oracle Pricing Cloud uses to calculate accruals when DISCOUNT TYPE in the program is PERCENTAGE.
    • AccrualPercentBasisId; integer; Value that identifies the pricing basis that Oracle Pricing Cloud uses to calculate accruals when DISCOUNT TYPE in the program is PERCENTAGE.
    • AccrualPercentBasisOnImportedTrx; string; Name that identifies the basis for pricing that's used to calculate accruals when the DISCOUNT TYPE in the program is PERCENTAGE. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REB_PERCENT_BASIS.
    • AccrualPercentBasisOnImportedTrxCode; string; Abbreviation that identifies the basis for pricing that's used to calculate accruals when the DISCOUNT TYPE in the program is PERCENTAGE.
    • ChargeSubtype; string; Subtype of charge for the pricing charge definition. Valid values include Price, Fee, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_SUBTYPES.
    • ChargeSubtypeCode; string; Abbreviation that identifies the charge subtype in the channel program.
    • ChargeType; string; Type of charge for the pricing charge definition. Valid values include Sale, Service, Restocking, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_TYPES.
    • ChargeTypeCode; string; Abbreviation that identifies the type of charge in the channel program.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • CustomerProgramFlag; boolean; Contains one of the following values: true or false. If true, then the channel program created based on this program type tracks sell-side accruals. If false, then the channel program tracks buy-side accruals. The default value for this attribute is from program template.
    • DefaultCalculationMethodCode; string; Abbreviation that identifies the default calculation method that's used when creating a channel program.
    • DefaultProductDistributionType; string; Default distributon type used when creating a channel lump sum program. A list of accepted values is defined in the lookup type ORA_CJM_DISTRIBUTION_TYPE.
    • DefaultProductDistributionTypeCode; string; Abbreviation that identifies the default distribution type that's used when creating a channel lump sum program.
    • DefaultTierTypeCode; string; Abbreviation that identifies the default tier type that's used when creating a channel program.
    • EffectiveDateType; string; Name of the sales order date type used for evaluating channel program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_PRICING_APP_DATE_TYPE. This attribute is not currently used.
    • EffectiveDateTypeCode; string; Abbreviation that identifies the sales order date type used for evaluating channel program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_PRICING_APP_DATE_TYPE. This attribute is not currently used.
    • EnableApprovalFlag; boolean; Contains one of the following values: true or false. If true, then approval rule is enabled for channel program. If false, then approval rule isn't enabled. The default value for this attribute is from program template.
    • EnableProgramBeneficiaryFlag; boolean; Contains one of the following values: true or false. If true, then a beneficiary can be added to the channel program. If false, then a beneficiary can't be added to the channel program. The default value for this attribute is taken from the predefined program template.???
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • ProgramTemplate; string; Name of the predefined channel program type on which the program type is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.
    • ProgramTemplateCode; string; Abbreviation that identifies the predefined channel program type.
    • ProgramTemplateId; integer; Value that uniquely identifies the predefined channel program type.
    • ProgramTypeCode; string; Abbreviation that identifies the channel program type.
    • ProgramTypeId; integer; Value that uniquely identifies the channel program type. It's a primary key that the application generates when it creates the program type.
    • ProgramTypeName; string; Name of the channel program type.
    • SourceOfSales; string; Name that indicates whether the channel program is applicable to direct orders, indirect orders, or both. A list of accepted values is defined in the lookup type ORA_CJM_SALES_METHOD.
    • SourceOfSalesCode; string; Abbreviation that indicates whether the channel program is applicable to direct orders, indirect orders, or both.
    • Status; string; Status of the channel program type.
    • StatusCode; string; Abbreviation that identifies the status of the type of program.
    • StatusId; integer; Value that uniquely identifies the status of the channel program type.
  • 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 : channelProgramTypes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : channelProgramTypes-item-response
Type: object
Show Source
  • Value that identifies the pricing basis that Oracle Pricing Cloud uses to calculate accruals when DISCOUNT TYPE in a program is NEW COST.
  • Value that identifies the pricing basis that Oracle Pricing Cloud uses to calculate accruals when DISCOUNT TYPE in the program is NEW COST.
  • Name of the pricing basis that Oracle Pricing Cloud uses to calculate accruals when DISCOUNT TYPE in the program is PERCENTAGE.
  • Value that identifies the pricing basis that Oracle Pricing Cloud uses to calculate accruals when DISCOUNT TYPE in the program is PERCENTAGE.
  • Name that identifies the basis for pricing that's used to calculate accruals when the DISCOUNT TYPE in the program is PERCENTAGE. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REB_PERCENT_BASIS.
  • Maximum Length: 30
    Abbreviation that identifies the basis for pricing that's used to calculate accruals when the DISCOUNT TYPE in the program is PERCENTAGE.
  • Subtype of charge for the pricing charge definition. Valid values include Price, Fee, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_SUBTYPES.
  • Maximum Length: 30
    Abbreviation that identifies the charge subtype in the channel program.
  • Type of charge for the pricing charge definition. Valid values include Sale, Service, Restocking, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_TYPES.
  • Maximum Length: 30
    Abbreviation that identifies the type of charge in the channel program.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the channel program created based on this program type tracks sell-side accruals. If false, then the channel program tracks buy-side accruals. The default value for this attribute is from program template.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the channel program will not get automatically applied on sales orders, even if the eligibility criteria is met. If false, then the channel program will get automatically applied on sales orders upon eligibility evaluation. The default value for this attribute is from predefined program template.
  • Default calculation method used when creating a channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_CALC_METHOD.
  • Maximum Length: 30
    Abbreviation that identifies the default calculation method that's used when creating a channel program.
  • Name of the default currency used when creating a channel program.
  • Maximum Length: 15
    Abbreviation that identifies the default currency used when creating a channel program.
  • Default type of discount that's used when creating a channel program.
  • Maximum Length: 30
    Abbreviation that identifies the default discount type that's used when creating a channel program.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the channel programs that are automatically applied on sales orders can be overridden. If false, then the channel programs applied on sales orders cannot be overridden. The default value for this attribute is from predefined program template.
  • Default distributon type used when creating a channel lump sum program. A list of accepted values is defined in the lookup type ORA_CJM_DISTRIBUTION_TYPE.
  • Maximum Length: 30
    Abbreviation that identifies the default distribution type that's used when creating a channel lump sum program.
  • Default tier type used when creating a channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_TYPE.
  • Maximum Length: 30
    Abbreviation that identifies the default tier type that's used when creating a channel program.
  • Name of the sales order date type used for evaluating channel program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_PRICING_APP_DATE_TYPE. This attribute is not currently used.
  • Maximum Length: 30
    Abbreviation that identifies the sales order date type used for evaluating channel program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_PRICING_APP_DATE_TYPE. This attribute is not currently used.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then approval rule is enabled for channel program. If false, then approval rule isn't enabled. The default value for this attribute is from program template.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then a beneficiary can be added to the channel program. If false, then a beneficiary can't be added to the channel program. The default value for this attribute is taken from the predefined program template.???
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Maximum Length: 5
    Prefix of the channel program code when creating the channel program.
  • Name of the predefined channel program type on which the program type is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.
  • Maximum Length: 30
    Abbreviation that identifies the predefined channel program type.
  • Value that uniquely identifies the predefined channel program type.
  • Maximum Length: 30
    Abbreviation that identifies the channel program type.
  • Value that uniquely identifies the channel program type. It's a primary key that the application generates when it creates the program type.
  • Maximum Length: 240
    Name of the channel program type.
  • Qualifiers
    Title: Qualifiers
    The Qualifiers resource manages the list of qualifiers applicable for a program type.
  • Name that indicates whether the channel program is applicable to direct orders, indirect orders, or both. A list of accepted values is defined in the lookup type ORA_CJM_SALES_METHOD.
  • Maximum Length: 1
    Default Value: D
    Abbreviation that indicates whether the channel program is applicable to direct orders, indirect orders, or both.
  • Status of the channel program type.
  • Maximum Length: 30
    Abbreviation that identifies the status of the type of program.
  • Value that uniquely identifies the status of the channel program type.
Nested Schema : Qualifiers
Type: array
Title: Qualifiers
The Qualifiers resource manages the list of qualifiers applicable for a program type.
Show Source
Nested Schema : channelProgramTypes-qualifiers-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the qualifier is a date qualifier. If false, then the qualifier is not a date qualifier. The default value for this attribute is false.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the date qualifier will be set to the default while creating a channel program. If false, then the date qualifier will not be set to the default while creating a channel program. This attribute doesn't not have a default value.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Value that uniquely identifies the channel program type.
  • Value that uniquely identifies the channel program type qualifier. It's a primary key that the application generates when it creates the qualifier.
  • Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.
  • Maximum Length: 30
    Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.
Back to Top

Examples

This example describes how to get all program types.

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

Example Response Body

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

{
	"items": [
	{
		"ProgramTypeId": 300100185189373,
		"ProgramTemplateCode": "SUPPLIER_SHIP_AND_DEBIT",
		"ProgramTemplate": "Supplier Ship and Debit",
		"ProgramTemplateId": 100100121026530,
		"CustomerProgramFlag": false,
		"StatusId": 300100184190120,
		"Status": "Active",
		"ProgramTypeCode": "SSD_PROGRAM",
		"ProgramTypeName": "Ship and Debit Program",
		"ProgramCodePrefix": "SSD",
		"SourceOfSalesCode": "B",
		"SourceOfSales": "Both",
		"DefaultCurrencyCode": "USD",
		"DefaultCurrency": "US Dollar",
		"EnableApprovalFlag": true,
		"EffectiveDateTypeCode": "REQ_SHIP_DATE",
		"EffectiveDateType": "Requested Ship Date",
		"AccrualPercentBasisId": null,
		"AccrualPercentBasis": null,
		"AccrualNewCostBasisId": null,
		"AccrualNewCostBasis": null,
		"DefaultDiscountTypeCode": "DISCOUNT_AMOUNT",
		"DefaultDiscountType": "Amount",
		"ChargeTypeCode": "ALL",
		"ChargeType": "All",
		"ChargeSubtypeCode": "ALL",
		"ChargeSubtype": "All",
		"DefaultApplyManuallyToOrderFlag": false,
		"DefaultOverrideProgramFlag": false,
		"CreatedBy": "channel_user",
		"CreationDate": "2020-05-30T13:19:09+00:00",
		"LastUpdatedBy": "channel_user",
		"LastUpdateDate": "2020-05-30T13:19:15+00:00",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/channelProgramTypes/300100185189373",
			"name": "channelProgramTypes",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/channelProgramTypes/300100185189373",
			"name": "channelProgramTypes",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/channelProgramTypes/300100185189373/child/qualifiers",
			"name": "qualifiers",
			"kind": "collection"
		}
		]
	},
	{
		"ProgramTypeId": 300100185735482,
		"ProgramTemplateCode": "SUPPLIER_SHIP_AND_DEBIT",
		"ProgramTemplate": "Supplier Ship and Debit",
		"ProgramTemplateId": 100100121026530,
		"CustomerProgramFlag": false,
		"StatusId": 300100183528740,
		"Status": "Draft",
		"ProgramTypeCode": "SALES_INITIATED",
		"ProgramTypeName": "Sales Initiated",
		"ProgramCodePrefix": "SSD",
		"SourceOfSalesCode": "B",
		"SourceOfSales": "Both",
		"DefaultCurrencyCode": "USD",
		"DefaultCurrency": "US Dollar",
		"EnableApprovalFlag": false,
		"EffectiveDateTypeCode": "REQ_SHIP_DATE",
		"EffectiveDateType": "Requested Ship Date",
		"AccrualPercentBasisId": null,
		"AccrualPercentBasis": null,
		"AccrualNewCostBasisId": null,
		"AccrualNewCostBasis": null,
		"DefaultDiscountTypeCode": null,
		"DefaultDiscountType": null,
		"ChargeTypeCode": "ALL",
		"ChargeType": "All",
		"ChargeSubtypeCode": "ALL",
		"ChargeSubtype": "All",
		"DefaultApplyManuallyToOrderFlag": false,
		"DefaultOverrideProgramFlag": true,
		"CreatedBy": "channel_user",
		"CreationDate": "2020-06-02T17:58:39+00:00",
		"LastUpdatedBy": "channel_user",
		"LastUpdateDate": "2020-06-02T17:58:39.650+00:00",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/channelProgramTypes/300100185735482",
			"name": "channelProgramTypes",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/channelProgramTypes/300100185735482",
			"name": "channelProgramTypes",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/channelProgramTypes/300100185735482/child/qualifiers",
			"name": "qualifiers",
			"kind": "collection"
		}
		]
	}
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/channelProgramTypes",
		"name": "channelProgramTypes",
		"kind": "collection"
	}
	]
}
Back to Top