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

Get one customer program

get

/fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : channelCustomerPrograms-item-response
Type: object
Show Source
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 : 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: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Number of the bill-to customer account.
  • 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.
  • 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.
  • Maximum Length: 30
    Abbreviation that identifies the comparison operator used in the additional condition.
  • 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: 255
    Name of the customer.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Lookup type code for the dimension of the lookup domain type.
  • 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.
  • 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
  • Read Only: true
    Value that uniquely identifies the dimension.
  • Value that uniquely identifies the customer program.
  • Read Only: true
    Value that uniquely identifies the additional condition.
  • Read Only: true
    Value of the numeric qualifier used in customer program qualification.
  • 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.
  • Maximum Length: 30
    Abbreviation that identifies the type of qualifier used to define customer program eligibility.
  • Read Only: true
    Maximum Length: 255
    Name of the qualifier used in customer program qualification.
  • Maximum Length: 240
    Abbreviation that identifies the qualifier used in customer program qualification.
  • Read Only: true
    Maximum Length: 255
    Name of the bill-to customer account site or the ship-to site.
Nested Schema : channelCustomerPrograms-attachments-item-response
Type: object
Show Source
Nested Schema : channelCustomerPrograms-customers-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Number of the bill-to customer account.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 30
    Abbreviation that identifies the comparison operator used in the customer.
  • 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: 255
    Name of the customer.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Lookup type code for the dimension of the lookup domain type.
  • 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.
  • Date when the customer is no longer applicable.
  • 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
  • Read Only: true
    Value that uniquely identifies the dimension.
  • Value that identifies the parent customer.
  • Value that uniquely identifies the customer program.
  • Read Only: true
    Value of the numeric qualifier used in customer program qualification.
  • 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.
  • Maximum Length: 30
    Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program.
  • Read Only: true
    Maximum Length: 255
    Name of the qualifier used in customer program qualification.
  • Maximum Length: 240
    Abbreviation that identifies the qualifier used in customer program qualification.
  • Read Only: true
    Value that uniquely identifies the customer. It's a primary key that the application generates when it creates the customer.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Name of the bill-to customer account site or the ship-to site.
  • Date when the customer becomes applicable.
Nested Schema : channelCustomerPrograms-DFF-item-response
Type: object
Show Source
Nested Schema : channelCustomerPrograms-notes-item-response
Type: object
Show Source
Nested Schema : channelCustomerPrograms-productRules-item-response
Type: object
Show Source
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 : channelCustomerPrograms-productRules-DFF-item-response
Type: object
Show Source
Links
DFF
Parameters:
  • ProgramId: $request.path.ProgramId
The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.
additionalConditions
Parameters:
  • ProgramId: $request.path.ProgramId
The Additional Conditions resource manages mandatory conditions for a program.
attachments
Parameters:
  • ProgramId: $request.path.ProgramId
The attachments resource is used to view, create, and update attachments.
customers
Parameters:
  • ProgramId: $request.path.ProgramId
The Customers resource manages rules for identifying eligible customers for a program.
notes
Parameters:
  • ProgramId: $request.path.ProgramId
The Notes resource captures comments, information, or instructions for a program.
productRules
Parameters:
  • ProgramId: $request.path.ProgramId
The Product Rules resource manages rules for identifying eligible products for a program.
submit
Parameters:
  • ProgramId: $request.path.ProgramId
Action to submit a program.
Back to Top

Examples

This example describes how to get one customer 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/channelCustomerPrograms/ProgramId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100576321372"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "ProgramId": 300100576321372,
    "ProgramType": "CRTP2",
    "ProgramTypeId": 300100571136403,
    "ProgramTemplate": "Customer Promotion",
    "ProgramTemplateCode": "CUSTOMER_REBATE",
    "BusinessUnit": "Vision Operations",
    "BusinessUnitId": 204,
    "ProgramName": "Spring Special",
    "PromotionCode": "CR52002",
    "Owner": "TAX_ACCT_OPERATIONS",
    "OwnerId": 185,
    "Status": "Draft",
    "StatusId": 100100144204807,
    "SystemStatus": "Draft",
    "SystemStatusCode": "DRAFT",
    "DateContextType": "Invoice Date",
    "DateContextTypeCode": "SALES_INVOICE_DATE",
    "StartDate": "2022-02-01",
    "EndDate": "2023-05-31",
    "Currency": "US Dollar",
    "CurrencyCode": "USD",
    "Description": null,
    "BeneficiaryType": null,
    "BeneficiaryTypeCode": null,
    "BeneficiaryValue": null,
    "BeneficiaryValueCode": null,
    "BeneficiaryCustomer": null,
    "BeneficiaryAccountNumber": null,
    "BeneficiaryAddress": null,
    "EnableBeneficiaryFlag": null,
    "CreatedBy": "channel_user",
    "CreationDate": "2023-02-09T19:05:04+00:00",
    "LastUpdatedBy": "channel_user",
    "LastUpdateDate": "2023-02-09T19:05:06.652+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100576321372",
            "name": "channelCustomerPrograms",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100576321372",
            "name": "channelCustomerPrograms",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100576321372/child/DFF",
            "name": "DFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100576321372/child/additionalConditions",
            "name": "additionalConditions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100576321372/child/attachments",
            "name": "attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100576321372/child/customers",
            "name": "customers",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100576321372/child/productRules",
            "name": "productRules",
            "kind": "collection"
        }
    ]
}
Back to Top