Get one program
get
/fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}
Request
Path Parameters
-
ProgramId(required): integer(int64)
Value that uniquely identifies the channel program. It is a primary key that the application generates when it creates the program.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : channelPrograms-item-response
Type:
Show Source
object
-
alternateSupplierSites: array
Alternate Supplier Sites
Title:
Alternate Supplier Sites
The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program. -
ApplyManuallyToOrderFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the channel program is not automatically applied on sales orders even if the eligibility criteria is met. If false, then the channel program is automatically applied on sales orders upon eligibility evaluation. The value is defaulted from program type. -
AvailableAmount: number
Read Only:
true
Available amount in the channel program. -
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
CalculationMethod: string
Method used for calculating accruals in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_CALC_METHOD.
-
CalculationMethodCode: string
Maximum Length:
30
Abbreviation that identifies the calculation method used for calculating accruals in the channel program. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
Currency: string
Name of the currency used for the channel program.
-
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency used for the channel program. -
Description: string
Maximum Length:
1000
Description of the channel program. -
DFF: array
Descriptive Flexfields for Channel Programs
Title:
Descriptive Flexfields for Channel Programs
The Descriptive Flexfields for Channel Programs resource manages additional details for a program. -
EarnedAmount: number
Read Only:
true
Earned amount in the channel program. -
EffectiveDateTypeCode: string
Maximum Length:
30
Default Value:FROM
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. -
FromDate: string
(date)
Date from when the program is applicable.
-
InitiatedBy: string
Value that identifies if the program was created by the supplier contact or the internal distributor user.
-
InitiatedByCode: string
Maximum Length:
20
Abbreviation that identifies if the program was created by the supplier contact or the internal distributor user. -
InProgressAmount: number
Read Only:
true
In-progress amount in the channel program. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
marketRules: array
Market Rules
Title:
Market Rules
The Market Rules resource manages rules for identifying eligible customers for a program. -
OpenAmount: number
Read Only:
true
Open amount in the channel program. -
OverrideProgramFlag: boolean
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 value is defaulted from program type. -
Owner: string
Name of the person who owns the channel program. This attribute defaults to the name of the person who creates the program.
-
OwnerId: integer
(int64)
Value that uniquely identifies the person who owns the channel program.
-
OwnerPersonNumber: string
Maximum Length:
255
Number that uniquely identifies the person who owns the channel program. -
PaidAmount: number
Read Only:
true
Paid amount in the channel program. -
productRules: array
Product Rules
Title:
Product Rules
The Product Rules resource manages rules for identifying eligible products for a program. -
ProgramCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the channel program. -
ProgramId: integer
(int64)
Value that uniquely identifies the channel program. It is a primary key that the application generates when it creates the program.
-
ProgramName: string
Title:
Name
Maximum Length:240
Name of the channel program. -
programRules: array
Program Rules
Title:
Program Rules
The Program Rules resource manages mandatory market rules for a program. -
ProgramTemplate: string
Name of the predefined program template on which the channel program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.
-
ProgramTemplateCode: string
Maximum Length:
30
Abbreviation that identifies the predefined program template on which the channel program is based. -
ProgramType: string
Type of program on which the channel program is based.
-
ProgramTypeId: integer
(int64)
Value that uniquely identifies the type of program on which the channel program is based.
-
PurchasedAmount: number
Read Only:
true
Purchase amount in the channel program. -
Status: string
Status of the channel program.
-
StatusId: integer
(int64)
Value that uniquely identifies the status of the channel program.
-
Supplier: string
Name of the supplier supporting the channel program.
-
SupplierAuthorizationNumber: string
Maximum Length:
30
Number that identifies the authorization provided by supplier. -
SupplierContact: string
Person who represents the supplier when communicating with the buyer.
-
SupplierContactId: integer
(int64)
Value that uniquely identifies the supplier contact.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierNumber: string
Number that identifies the supplier.
-
SupplierQuoteNumber: string
Maximum Length:
30
Number that indicates the quote provided by supplier. -
SupplierSite: string
Value that identifies the supplier site.
-
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
ToDate: string
(date)
Date until when the program is applicable.
-
volumeRules: array
Volume Rules
Title:
Volume Rules
The Volume Rules resource manages volume rules of a volume program.
Nested Schema : Alternate Supplier Sites
Type:
array
Title:
Alternate Supplier Sites
The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.
Show Source
Nested Schema : Descriptive Flexfields for Channel Programs
Type:
array
Title:
Descriptive Flexfields for Channel Programs
The Descriptive Flexfields for Channel Programs resource manages additional details for a program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Market Rules
Type:
array
Title:
Market Rules
The Market Rules resource manages rules for identifying eligible customers for a program.
Show Source
Nested Schema : Product Rules
Type:
array
Title:
Product Rules
The Product Rules resource manages rules for identifying eligible products for a program.
Show Source
Nested Schema : Program Rules
Type:
array
Title:
Program Rules
The Program Rules resource manages mandatory market rules for a program.
Show Source
Nested Schema : Volume Rules
Type:
array
Title:
Volume Rules
The Volume Rules resource manages volume rules of a volume program.
Show Source
Nested Schema : channelPrograms-alternateSupplierSites-item-response
Type:
Show Source
object
-
AlternateSupplierSiteId: integer
(int64)
Value that uniquely identifies the alternate supplier site.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcurementBusinessUnit: string
Name of the procurement business unit.
-
ProcurementBusinessUnitId: integer
Value that uniquely identifies the procurement business unit.
-
Supplier: string
Name of the alternate supplier supporting the channel program.
-
SupplierId: integer
Value that uniquely identifies the alternate supplier.
-
SupplierNumber: string
Number that identifies the alternate supplier.
-
SupplierSite: string
Maximum Length:
240
Name of the alternate supplier site. -
SupplierSiteAddress: string
Maximum Length:
4000
Address of the alternate supplier site. -
SupplierSiteId: integer
(int64)
Value that identifies the alternate supplier site.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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 : channelPrograms-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for product rule. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for product rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramHeaderId: integer
(int64)
Value that uniquely identifies the channel program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-marketRules-item-response
Type:
Show Source
object
-
ComparisonOperatorCode: string
Maximum Length:
30
Abbreviation that identifies the comparison operator used in market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR. -
conditions: array
Conditions
Title:
Conditions
The Conditions resource manages additional conditions for a market rule of a program. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
FromDate: string
(date)
Date when the qualifier becomes applicable.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramId: integer
(int64)
Value that uniquely identifies the channel program.
-
QualifierId: integer
(int64)
Value that uniquely identifies the market rule. It is a primary key that the application generates when it creates the market rule.
-
QualifierType: string
Maximum Length:
255
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. -
QualifierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program. -
QualifierValue: string
Read Only:
true
Maximum Length:255
Name of the qualifier used in channel program qualification. -
QualifierValueCode: string
Maximum Length:
240
Abbreviation that identifies the qualifier used in channel program qualification. -
ToDate: string
(date)
Date when the qualifier is no longer applicable.
Nested Schema : Conditions
Type:
array
Title:
Conditions
The Conditions resource manages additional conditions for a market rule of a program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-marketRules-conditions-item-response
Type:
Show Source
object
-
ComparisonOperatorCode: string
Maximum Length:
30
Abbreviation that identifies the comparison operator used in market rule condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QualifierConditionId: integer
(int64)
Value that uniquely identifies the market rule condition. It is a primary key that the application generates when it creates the market rule condition.
-
QualifierId: integer
(int64)
Value that uniquely identifies the market rule.
-
QualifierType: string
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.
-
QualifierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of qualifier used to define channel program eligibility. -
QualifierValue: string
Read Only:
true
Maximum Length:255
Type of qualifier used in channel program qualification. -
QualifierValueCode: string
Maximum Length:
240
Abbreviation that identifies the qualifier used in channel program qualification.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-productRules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DFF: array
Descriptive Flexfields for Product Rules
Title:
Descriptive Flexfields for Product Rules
The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program. -
DiscountType: string
Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.
-
DiscountTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of discount. -
DiscountValue: number
Value of the discount.
-
FromDate: string
(date)
Date when the product rule becomes applicable.
-
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Description of the item in the inventory.
-
ItemId: string
Maximum Length:
240
Value that uniquely identifies the item in the inventory. -
ItemLevel: string
Level at which discounts are defined. Valid values include Item and All Items. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.
-
ItemLevelCode: string
Maximum Length:
30
Abbreviation that identifies the level at which discounts are defined. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumQuantity: number
Maximum quantity allowed for each product rule.
-
ProgramId: integer
(int64)
Name that identifies the qualifier used in channel program qualification.
-
ProgramLineId: integer
Value that uniquely identifies the product rule. It is a primary key that the application generates when it creates the product rule.
-
SupplierItem: string
Maximum Length:
255
Name of the supplier item. -
SupplierItemDescription: string
Maximum Length:
255
Description of the supplier item. -
SupplierItemId: integer
(int64)
Value that uniquely identifies the supplier item.
-
ToDate: string
(date)
Date when the product rule is no longer applicable.
-
UnitOfMeasure: string
Unit of measure of the item for pricing.
-
UOMCode: string
Maximum Length:
30
Abbreviation that identifies the unit of measure for pricing.
Nested Schema : Descriptive Flexfields for Product Rules
Type:
array
Title:
Descriptive Flexfields for Product Rules
The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-productRules-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for product rule. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for product rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramLineId: integer
Value that uniquely identifies the product rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-programRules-item-response
Type:
Show Source
object
-
ComparisonOperatorCode: string
Maximum Length:
30
Abbreviation that identifies the comparison operator used in program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login that the user used when updating the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramId: integer
(int64)
Value that uniquely identifies the channel program.
-
QualifierId: integer
(int64)
Value that uniquely identifies the program rule.
-
QualifierType: string
Type of qualifier used to define eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.
-
QualifierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of qualifier used to define channel program eligibility. -
QualifierValue: string
Read Only:
true
Maximum Length:255
Name of the qualifier used in channel program qualification. -
QualifierValueCode: string
Maximum Length:
240
Abbreviation that identifies the qualifier used in channel program qualification.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-volumeRules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DiscountType: string
Read Only:
true
Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE. -
DiscountTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of discount. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login credentials that the user used to update the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
products: array
Products
Title:
Products
The Products resource manages the eligible products for a volume program. -
ProgramId: integer
(int64)
Read Only:
true
Value that uniquely identifies the channel program. -
tiers: array
Tiers
Title:
Tiers
The Tiers resource manages the tier definition of a volume program. -
TierType: string
Tier types supported in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_TYPE.
-
TierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the tier type. -
UnitOfMeasure: string
Unit of measure of the item.
-
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure. -
VolumeRuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the volume rule. -
VolumeRuleName: string
Maximum Length:
240
Name of the volume rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Products
Type:
array
Title:
Products
The Products resource manages the eligible products for a volume program.
Show Source
Nested Schema : Tiers
Type:
array
Title:
Tiers
The Tiers resource manages the tier definition of a volume program.
Show Source
Nested Schema : channelPrograms-volumeRules-products-item-response
Type:
Show Source
object
-
Category: string
Name of the category.
-
CategoryCode: string
Abbreviation that identifies the category.
-
CategoryDescription: string
Description of the category.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
exclusions: array
Exclusions
Title:
Exclusions
The Exclusions resource manages the product or category exclusions from the volume program. -
IncludeVolumeExcludeDiscountFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the product volume is considered for tier calculation but not for any discount. If false, then the product volume is considered for tier calculation and for discounts. The default value is false. -
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Description of the item in the inventory.
-
ItemId: string
Maximum Length:
240
Value that uniquely identifies the item in the inventory. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LineLevel: string
Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
-
LineLevelCode: string
Maximum Length:
30
Abbreviation that identifies the level at which discounts are defined. -
LineNumber: number
Number that identifies the product line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProductId: integer
Value that uniquely identifies the product line.
-
SupplierItem: string
Name of the supplier item.
-
SupplierItemDescription: string
Description of the supplier item.
-
SupplierItemId: integer
(int64)
Value that uniquely identifies the supplier item.
-
VolumeRuleId: integer
(int64)
Value that uniquely identifies the volume rule.
Nested Schema : Exclusions
Type:
array
Title:
Exclusions
The Exclusions resource manages the product or category exclusions from the volume program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-volumeRules-products-exclusions-item-response
Type:
Show Source
object
-
Category: string
Name of the category.
-
CategoryCode: string
Abbreviation that identifies the category.
-
CategoryDescription: string
Description of the category.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
ExclusionId: integer
(int64)
Value that uniquely identifies the exclusion.
-
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Description of the item in the inventory.
-
ItemId: string
Maximum Length:
240
Value that uniquely identifies the item in the inventory. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LineLevel: string
Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
-
LineLevelCode: string
Maximum Length:
30
Abbreviation that identifies the level at which discounts are defined. -
LineNumber: number
Number that identifies the product line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProductId: integer
(int64)
Value that uniquely identifies the product line.
-
SupplierItem: string
Name of the supplier item.
-
SupplierItemDescription: string
Description of the supplier item.
-
SupplierItemId: integer
(int64)
Value that uniquely identifies the supplier item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelPrograms-volumeRules-tiers-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreQualifyingTierFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the tier calculation starts from the corresponding tier. If false, then the tier calculation starts from the first tier. The default value is false. -
TierDiscount: number
Value of the tier discount.
-
TierFrom: number
Value from which the tier is eligible.
-
TierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the tier. -
TierName: string
Maximum Length:
240
Name of the tier. -
TierNumber: number
Read Only:
true
Number that identifies the tier. -
TierTo: number
Value till the tier is eligible
-
VolumeRuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the volume rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- ProgramId:
$request.path.ProgramId
The Descriptive Flexfields for Channel Programs resource manages additional details for a program. - ProgramId:
- alternateSupplierSites
-
Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/alternateSupplierSitesParameters:
- ProgramId:
$request.path.ProgramId
The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program. - ProgramId:
- marketRules
-
Parameters:
- ProgramId:
$request.path.ProgramId
The Market Rules resource manages rules for identifying eligible customers for a program. - ProgramId:
- productRules
-
Parameters:
- ProgramId:
$request.path.ProgramId
The Product Rules resource manages rules for identifying eligible products for a program. - ProgramId:
- programRules
-
Parameters:
- ProgramId:
$request.path.ProgramId
The Program Rules resource manages mandatory market rules for a program. - ProgramId:
- volumeRules
-
Parameters:
- ProgramId:
$request.path.ProgramId
The Volume Rules resource manages volume rules of a volume program. - ProgramId:
Examples
This example describes how to get one program.
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/channelPrograms/ProgramId"
For example, the following command gets one program:
curl -u username:password "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ProgramId": 300100185773659, "ProgramType": "Sales Initiated", "ProgramTypeId": 300100185735482, "ProgramTemplate": "Supplier Ship and Debit", "ProgramTemplateCode": "SUPPLIER_SHIP_AND_DEBIT", "BusinessUnit": "Vision Operations", "BusinessUnitId": 204, "ProgramName": "NY Vendor Rebate", "ProgramCode": "SSD13000", "Owner": "channel_user", "OwnerId": 300100181693728, "Status": "Active", "StatusId": 300100183528749, "Currency": "US Dollar", "CurrencyCode": "USD", "Description": null, "CreatedBy": "channel_user", "CreationDate": "2020-06-03T01:58:33+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2020-06-03T01:58:35.823+00:00", "Supplier": "CDS, Inc", "SupplierId": 1178, "SupplierNumber": "5102", "SupplierSite": "PITTSBURGH", "SupplierSiteId": 2854, "SupplierAuthorizationNumber": null, "SupplierQuoteNumber": null, "EffectiveDateTypeCode": "REQ_SHIP_DATE", "FromDate": "2020-06-03", "ToDate": "2021-06-03", "ApplyManuallyToOrderFlag": false, "OverrideProgramFlag": true, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659", "name": "channelPrograms", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659", "name": "channelPrograms", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/marketRules", "name": "marketRules", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/productRules", "name": "productRules", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/programRules", "name": "programRules", "kind": "collection" } ] }