Get all customer programs
get
/fscmRestApi/resources/11.13.18.05/channelCustomerPrograms
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 the customer program with the specified primary key.
Finder Variables:- ProgramId; integer; Unique identifier of the customer program.
- PrimaryKey: Finds the customer program with the specified 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:- AccountedEstimatedAmount; number; Indicates the estimated amount in the functional currency.
- ApprovedDate; string; Date when the program is approved and moved to active status.
- BeneficiaryAccountNumber; string; Number of the beneficiary bill-to customer account.
- BeneficiaryAddress; string; Primary bill-to address of the beneficiary customer.
- BeneficiaryCustomer; string; Name of the beneficiary customer.
- BeneficiaryType; string; Abbreviation that identifies the type of beneficiary.
- BeneficiaryTypeCode; string; Type of beneficiary used in the customer program. A list of accepted values is defined in the lookup type ORA_CJM_BENEFICIARY_TYPE.
- BeneficiaryValue; string; Abbreviation that identifies the beneficiary used in the customer program.
- BeneficiaryValueCode; number; Name of the beneficiary used in the customer program.
- 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.
- Currency; string; Name of the currency used for the customer program.
- CurrencyCode; string; Abbreviation that identifies the currency used for the customer program.
- DateContextType; string; Name of the effective date type used for evaluating customer program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_DATE_QUAL.
- Description; string; Description of the customer program.
- EnableBeneficiaryFlag; string; Contains one of the following values: true or false. If true, then the beneficiary can be added to the channel program. If false, then the beneficiary can't be added to the channel programs. The value for this attribute is populated from the program type during program creation.
- EndDate; string; Date until when the program is applicable.
- EstimatedAmount; number; Indicates the estimated amount for the program.
- LastUpdateDate; string; Date and time when the user most recently updated the record.
- LastUpdatedBy; string; User who most recently updated the record.
- Owner; string; Name of the person who owns the customer program. This attribute defaults to the name of the person who creates the program.
- OwnerId; integer; Value that uniquely identifies the person who owns the customer program.
- OwnerPersonNumber; string; Number that uniquely identifies the person who owns the customer program.
- ProgramId; integer; Value that uniquely identifies the customer program.
- ProgramName; string; Name of the customer program.
- ProgramTemplate; string; Name of the predefined program template on which the customer program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.
- ProgramTemplateCode; string; Abbreviation that identifies the predefined program template on which the customer program is based.
- ProgramType; string; Type of program on which the customer program is based.
- ProgramTypeId; integer; Value that uniquely identifies the type of program on which the customer program is based.
- PromotionCode; string; Abbreviation that uniquely identifies the customer program.
- RejectedDate; string; Date when the program is rejected.
- StartDate; string; Date from when the program is applicable.
- Status; string; Status of the customer program.
- StatusId; integer; Value that uniquely identifies the status of the customer program.
- SubmittedBy; string; Name that identifies the user who submitted the program for approval.
- SubmittedDate; string; Date when the program is submitted.
- SystemStatus; string; System status of the customer program.
- SystemStatusCode; string; Abbreviation that identifies the system status of the customer program.
-
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 : channelCustomerPrograms
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:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerPrograms-item-response
Type:
Show Source
object
-
AccountedEstimatedAmount: number
Read Only:
true
Indicates the estimated amount in the functional currency. -
additionalConditions: array
Additional Conditions
Title:
Additional Conditions
The Additional Conditions resource manages mandatory conditions for a program. -
ApprovedDate: string
(date)
Read Only:
true
Date when the program is approved and moved to active status. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BeneficiaryAccountNumber: string
Read Only:
true
Maximum Length:255
Number of the beneficiary bill-to customer account. -
BeneficiaryAddress: string
Read Only:
true
Maximum Length:255
Primary bill-to address of the beneficiary customer. -
BeneficiaryCustomer: string
Read Only:
true
Maximum Length:255
Name of the beneficiary customer. -
BeneficiaryType: string
Maximum Length:
255
Abbreviation that identifies the type of beneficiary. -
BeneficiaryTypeCode: string
Maximum Length:
30
Type of beneficiary used in the customer program. A list of accepted values is defined in the lookup type ORA_CJM_BENEFICIARY_TYPE. -
BeneficiaryValue: string
Maximum Length:
255
Abbreviation that identifies the beneficiary used in the customer program. -
BeneficiaryValueCode: number
Name of the beneficiary used in the customer program.
-
BusinessUnit: string
Maximum Length:
255
Name of the business unit. -
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
CommentsForApprovers: string
Maximum Length:
4000
Comments submitted to provide additional information to the approvers. -
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
Maximum Length:
255
Name of the currency used for the customer program. -
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency used for the customer program. -
customers: array
Customers
Title:
Customers
The Customers resource manages rules for identifying eligible customers for a program. -
DateContextType: string
Maximum Length:
255
Name of the effective date type used for evaluating customer program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_DATE_QUAL. -
DateContextTypeCode: string
Maximum Length:
30
Default Value:FROM
Abbreviation that identifies the effective date type used for evaluating customer program eligibility. -
Description: string
Maximum Length:
1000
Description of the customer program. -
DFF: array
Channel Customer Programs Descriptive Flexfields
Title:
Channel Customer Programs Descriptive Flexfields
The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program. -
EnableBeneficiaryFlag: string
Read Only:
true
Maximum Length:255
Contains one of the following values: true or false. If true, then the beneficiary can be added to the channel program. If false, then the beneficiary can't be added to the channel programs. The value for this attribute is populated from the program type during program creation. -
EndDate: string
(date)
Date until when the program is applicable.
-
EstimatedAmount: number
Indicates the estimated amount for the 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. -
notes: array
Notes
Title:
Notes
The Notes resource captures comments, information, or instructions for a program. -
Owner: string
Maximum Length:
255
Name of the person who owns the customer 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 customer program.
-
OwnerPersonNumber: string
Maximum Length:
255
Number that uniquely identifies the person who owns the customer program. -
productRules: array
Product Rules
Title:
Product Rules
The Product Rules resource manages rules for identifying eligible products for a program. -
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
ProgramName: string
Title:
Name
Maximum Length:240
Name of the customer program. -
ProgramTemplate: string
Maximum Length:
255
Name of the predefined program template on which the customer 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 customer program is based. -
ProgramType: string
Maximum Length:
255
Type of program on which the customer program is based. -
ProgramTypeId: integer
(int64)
Value that uniquely identifies the type of program on which the customer program is based.
-
PromotionCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the customer program. -
RejectedDate: string
(date)
Read Only:
true
Date when the program is rejected. -
StartDate: string
(date)
Date from when the program is applicable.
-
Status: string
Maximum Length:
255
Status of the customer program. -
StatusId: integer
(int64)
Value that uniquely identifies the status of the customer program.
-
SubmittedBy: string
Read Only:
true
Maximum Length:255
Name that identifies the user who submitted the program for approval. -
SubmittedDate: string
(date)
Read Only:
true
Date when the program is submitted. -
SystemStatus: string
Read Only:
true
Maximum Length:255
System status of the customer program. -
SystemStatusCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the system status of the customer program.
Nested Schema : Additional Conditions
Type:
array
Title:
Additional Conditions
The Additional Conditions resource manages mandatory conditions for a program.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Customers
Type:
array
Title:
Customers
The Customers resource manages rules for identifying eligible customers for a program.
Show Source
Nested Schema : Channel Customer Programs Descriptive Flexfields
Type:
array
Title:
Channel Customer Programs Descriptive Flexfields
The Descriptive Flexfields for Channel Customer 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 : Notes
Type:
array
Title:
Notes
The Notes resource captures comments, information, or instructions 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 : channelCustomerPrograms-additionalConditions-item-response
Type:
Show Source
object
-
AccountNumber: string
Read Only:
true
Maximum Length:255
Number of the bill-to customer account. -
Address: string
Read Only:
true
Maximum Length:255
Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site. -
ComparisonOperator: string
Maximum Length:
255
Name of the comparison operator used in the additional condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR. -
ComparisonOperatorCode: string
Maximum Length:
30
Abbreviation that identifies the comparison operator used in the additional condition. -
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. -
Customer: string
Read Only:
true
Maximum Length:255
Name of the customer. -
CustomQualifierFlag: boolean
Read Only:
true
Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false. -
DomainDataTypeCode: string
Read Only:
true
Maximum Length:255
Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES. -
DomainLookupTypeCode: string
Read Only:
true
Maximum Length:255
Lookup type code for the dimension of the lookup domain type. -
DomainTypeCode: string
Read Only:
true
Maximum Length:255
Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES. -
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. -
MatrixDimensionId: integer
Read Only:
true
Value that uniquely identifies the dimension. -
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
QualifierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the additional condition. -
QualifierNumberValueCode: integer
Read Only:
true
Value of the numeric qualifier used in customer program qualification. -
QualifierType: string
Maximum Length:
255
Type of qualifier used to define eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL. -
QualifierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of qualifier used to define customer program eligibility. -
QualifierValue: string
Read Only:
true
Maximum Length:255
Name of the qualifier used in customer program qualification. -
QualifierValueCode: string
Maximum Length:
240
Abbreviation that identifies the qualifier used in customer program qualification. -
Site: string
Read Only:
true
Maximum Length:255
Name of the bill-to customer account site or the ship-to 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 : channelCustomerPrograms-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
User name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
Text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerPrograms-customers-item-response
Type:
Show Source
object
-
AccountNumber: string
Read Only:
true
Maximum Length:255
Number of the bill-to customer account. -
Address: string
Read Only:
true
Maximum Length:255
Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site. -
ChildRuleNumber: integer
(int32)
Number that identifies the trailing component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 5.2, then the rule number is 5 and the child rule number is 2. Validation: It must be an integer >= 0. It can't have a duplicate display line number.
-
ComparisonOperator: string
Maximum Length:
255
Name of the comparison operator used in the customer. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR. -
ComparisonOperatorCode: string
Maximum Length:
30
Abbreviation that identifies the comparison operator used in the customer. -
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. -
Customer: string
Read Only:
true
Maximum Length:255
Name of the customer. -
CustomQualifierFlag: boolean
Read Only:
true
Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false. -
DomainDataTypeCode: string
Read Only:
true
Maximum Length:255
Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES. -
DomainLookupTypeCode: string
Read Only:
true
Maximum Length:255
Lookup type code for the dimension of the lookup domain type. -
DomainTypeCode: string
Read Only:
true
Maximum Length:255
Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES. -
EndDate: string
(date)
Date when the customer is no longer 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. -
MatrixDimensionId: integer
Read Only:
true
Value that uniquely identifies the dimension. -
ParentRuleId: integer
(int64)
Value that identifies the parent customer.
-
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
QualifierNumberValueCode: integer
Read Only:
true
Value of the numeric qualifier used in customer program qualification. -
QualifierType: string
Maximum Length:
255
Type of qualifier used to define the eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL. -
QualifierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program. -
QualifierValue: string
Read Only:
true
Maximum Length:255
Name of the qualifier used in customer program qualification. -
QualifierValueCode: string
Maximum Length:
240
Abbreviation that identifies the qualifier used in customer program qualification. -
RuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer. It's a primary key that the application generates when it creates the customer. -
RuleNumber: integer
(int32)
Number that identifies the leading component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 3.1, then the rule number is 3 and the child rule number is 1. Validation: It must be an integer > 0. Cannot have duplicate display line number.
-
Site: string
Read Only:
true
Maximum Length:255
Name of the bill-to customer account site or the ship-to site. -
StartDate: string
(date)
Date when the customer becomes applicable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerPrograms-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for customer program product rule. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for customer program product rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramHeaderId: integer
(int64)
Value that uniquely identifies the customer program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerPrograms-notes-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Corporate currency code for extensibility. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Party ID for the note creator. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
true
Maximum Length:320
Email address of the user who created the note. -
FormattedAddress: string
Read Only:
true
Address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
true
Phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
Value that uniquely identifies the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30
Alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
Title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Column that stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Note type code for categorization of a note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Unique identifier of the parent source object associated with the note. -
PartyId: integer
(int64)
Read Only:
true
Unique identifier of the party. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
Name of the party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Unique identifier of the parent source object associated to the note. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user can update the note. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerPrograms-productRules-item-response
Type:
Show Source
object
-
Catalog: string
Maximum Length:
255
Name of the catalog of the category selected for the product rule. -
CatalogCode: string
Maximum Length:
255
Abbreviation that identifies the catalog of the category selected for the product rule. -
Category: string
Read Only:
true
Maximum Length:255
Name of the category. -
CategoryCode: string
Maximum Length:
820
Abbreviation that identifies the category. -
CategoryDescription: string
Read Only:
true
Maximum Length:255
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. -
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. -
DiscountAmount: number
Value of the discount.
-
DiscountType: string
Maximum Length:
255
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. -
EndDate: string
(date)
Date when the product rule is no longer applicable.
-
ExclusionExistsFlag: boolean
Read Only:
true
Maximum Length:255
Contains one of the following values: true or false. If true, then exclusions are present for the product rule. If false, then exclusions aren't present for the product rule. -
exclusions: array
Exclusions
Title:
Exclusions
The Exclusions resource manages product exclusions. -
Item: string
Maximum Length:
255
Name of the item in the inventory. -
ItemDescription: string
Maximum Length:
255
Description of the item in the inventory. -
ItemId: string
Maximum Length:
240
Value that uniquely identifies the item in the inventory. -
ItemLevel: string
Maximum Length:
255
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. -
LineNumber: number
Number that identifies the product rule.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
ProgramLineId: integer
Value that uniquely identifies the product rule. It is a primary key that the application generates when it creates the product rule.
-
StartDate: string
(date)
Date when the product rule becomes applicable.
-
UnitOfMeasure: string
Maximum Length:
255
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 : Exclusions
Type:
array
Title:
Exclusions
The Exclusions resource manages product exclusions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerPrograms-productRules-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for customer program product rule. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for customer program 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 : channelCustomerPrograms-productRules-exclusions-item-response
Type:
Show Source
object
-
Catalog: string
Maximum Length:
255
Name of the catalog of the category selected for the product rule. -
CatalogCode: string
Maximum Length:
255
Abbreviation that identifies the catalog of the category selected for the product rule. -
Category: string
Read Only:
true
Maximum Length:255
Name of the category. -
CategoryCode: string
Maximum Length:
820
Abbreviation that identifies the category. -
CategoryDescription: string
Read Only:
true
Maximum Length:255
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 product rule exclusion.
-
Item: string
Maximum Length:
255
Name of the item in the inventory. -
ItemDescription: string
Read Only:
true
Maximum Length:255
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. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login details of the last user who updated the record. -
LineLevel: string
Maximum Length:
255
Level at which exclusions are defined. A list of accepted values is defined in the lookup ORA_CJM_CUST_PROG_ITEM_LEVEL. -
LineLevelCode: string
Maximum Length:
30
Abbreviation that identifies the level at which exclusions are defined. -
LineNumber: number
Number that identifies the exclusion line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramLineId: integer
(int64)
Value that uniquely identifies the product rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all customer programs.
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/channelCustomerPrograms"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "ProgramId": 300100638705167, "ProgramType": "Customer Promotion Type", "ProgramTypeId": 300100580716126, "ProgramTemplate": "Customer Promotion", "ProgramTemplateCode": "CUSTOMER_REBATE", "BusinessUnit": "Vision Operations", "BusinessUnitId": 204, "ProgramName": "Spring Special", "PromotionCode": "SBREB0831F", "Owner": "Parker Kline", "OwnerId": 300100583360588, "Status": "Draft", "StatusId": 100100144204807, "SystemStatus": "Draft", "SystemStatusCode": "DRAFT", "DateContextType": "Invoice Date", "DateContextTypeCode": "SALES_INVOICE_DATE", "StartDate": "2024-08-01", "EndDate": "2024-09-30", "Currency": "US Dollar", "CurrencyCode": "USD", "Description": "Fall promotion for 3 customers", "BeneficiaryType": "Customer", "BeneficiaryTypeCode": "ORA_CJM_BILL_TO_CUSTOMER_ID", "BeneficiaryValue": "PennyPack Systems", "BeneficiaryValueCode": 300100581001759, "BeneficiaryCustomer": "PennyPack Systems", "BeneficiaryAccountNumber": "226333", "BeneficiaryAddress": "120 Park Ave,NEW YORK, NY 10017", "EnableBeneficiaryFlag": "Y", "CreatedBy": "PGM_MGR1", "CreationDate": "2024-09-01T00:19:02+00:00", "LastUpdatedBy": "PGM_MGR1", "LastUpdateDate": "2024-09-01T00:19:02.697+00:00", "ApprovedDate": null, "EstimatedAmount": 5000, "RejectedDate": null, "SubmittedDate": null, "CommentsForApprovers": null, "AccountedEstimatedAmount": null, "SubmittedBy": null, "OwnerPersonNumber": "955160008195114", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100638705167", "name": "channelCustomerPrograms", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100638705167", "name": "channelCustomerPrograms", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100638705167/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100638705167/child/additionalConditions", "name": "additionalConditions", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100638705167/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100638705167/child/customers", "name": "customers", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100638705167/child/notes", "name": "notes", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100638705167/child/productRules", "name": "productRules", "kind": "collection" }, { "rel": "action", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100638705167/action/submit", "name": "submit", "kind": "other" } ] }, { "ProgramId": 300100580911773, "ProgramType": "Customer Promotion Type", "ProgramTypeId": 300100580716126, "ProgramTemplate": "Customer Promotion", "ProgramTemplateCode": "CUSTOMER_REBATE", "BusinessUnit": "Vision Operations", "BusinessUnitId": 204, "ProgramName": "CDRMCustomerPromotionPRM5", "PromotionCode": "CDRMCustomerPromotionPRM5", "Owner": null, "OwnerId": -1, "Status": "Active", "StatusId": 100100144204820, "SystemStatus": "Active", "SystemStatusCode": "ACTIVE", "DateContextType": "Requested Ship Date", "DateContextTypeCode": "REQ_SHIP_DATE", "StartDate": "2023-07-17", "EndDate": "2025-07-25", "Currency": "US Dollar", "CurrencyCode": "USD", "Description": null, "BeneficiaryType": null, "BeneficiaryTypeCode": null, "BeneficiaryValue": null, "BeneficiaryValueCode": null, "BeneficiaryCustomer": null, "BeneficiaryAccountNumber": null, "BeneficiaryAddress": null, "EnableBeneficiaryFlag": "Y", "CreatedBy": "channel_user", "CreationDate": "2023-07-25T06:47:00+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2023-07-25T06:50:22.394+00:00", "ApprovedDate": null, "EstimatedAmount": null, "RejectedDate": null, "SubmittedDate": null, "CommentsForApprovers": null, "AccountedEstimatedAmount": null, "SubmittedBy": null, "OwnerPersonNumber": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100580911773", "name": "channelCustomerPrograms", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100580911773", "name": "channelCustomerPrograms", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100580911773/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100580911773/child/additionalConditions", "name": "additionalConditions", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100580911773/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100580911773/child/customers", "name": "customers", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100580911773/child/notes", "name": "notes", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100580911773/child/productRules", "name": "productRules", "kind": "collection" }, { "rel": "action", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100580911773/action/submit", "name": "submit", "kind": "other" } ] } ], "count": 2, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms", "name": "channelCustomerPrograms", "kind": "collection" } ] }