Jump to

• Request
• Response
• Examples

Get one channel program

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/channelPrograms/{IncentiveId}

Request

Path Parameters

• IncentiveId(required): integer(int64)
  Value that uniquely identifies the channel program for an order line.
• OrderKey(required): string
  Value that uniquely identifies the sales order. It can have the following formats.
  
  - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
  Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
  
  - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
  Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
  
  When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
• linesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.

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 Top

Response

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.

Body ()

Root Schema : salesOrdersForOrderHub-lines-channelPrograms-item-response

Type: object

Show Source

• ApplyType: string
  Maximum Length: 255

  Value that indicates whether the channel program for an order line is applied by the user or the application. The values for this attribute are based on the value of ManuallyAppliedFlag.
• Comments: string
  Maximum Length: 2000

  Comments for channel program for an order line.
• DeclinableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the channel program for an order line can be declined by a user. If false, then the channel program for an order line can't be declined by a user. The default value is true.
• DeclineReason: string
  Maximum Length: 255

  Reason to decline the channel program for an order line.
• DeclineReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the reason to decline the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENT_DECLINE_REASON.
• DiscountAmount: integer (int64)
  Amount of discount for the product rule.
• DiscountType: string
  Maximum Length: 255

  Value that identifies the discount type of the product rule.
• DiscountTypeCode: string
  Maximum Length: 255

  Abbreviation that identifies the discount type of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.
• EndDate: string (date)
  Date when the product rule is no longer effective.
• IncentiveEntitySubtypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the sub type of the channel program.
• IncentiveEntityTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of the channel program.
• IncentiveId: integer (int64)
  Value that uniquely identifies the channel program for an order line.
• ItemLevel: string
  Maximum Length: 255

  Value that indicates the item level of the product rule.
• ItemLevelCode: string
  Maximum Length: 255

  Abbreviation that indicates the item level of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManuallyAppliedFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the channel program for an order line is selected by the user. If false, then the channel program for an order line is applied by the application. The default value is false. A list of accepted values is defined in the lookup type ORA_FOM_USER_APPLIED_INCENTIVE.
• ProgramCode: string
  Maximum Length: 255

  Abbreviation that uniquely identifies the channel program.
• ProgramDescription: string
  Maximum Length: 255

  Description of the channel program.
• ProgramDetails: string
  Maximum Length: 255

  Details of the product rule. The value of this attribute is a concatenation of DiscountType and DiscountAmount from the product rule.
• ProgramId: string
  Maximum Length: 50

  Value that uniquely identifies the channel program.
• ProgramLine: string
  Maximum Length: 255

  Value that indicates the item level at which a channel program is applied for an order line. The values for this attribute are based on the value of ItemLevelCode. If the value of ItemLevelCode is ALL_ITEMS, then the value of ItemLevel is used as the value of this attribute. If the value of ItemLevelCode is ITEM, then item number from order line is used as the value of this attribute. Otherwise, the value of item identifier from product rule is used as the value of this attribute.
• ProgramLineId: string
  Maximum Length: 50

  Value that uniquely identifies the product rule.
• ProgramName: string
  Maximum Length: 255

  Name of the channel program.
• ProgramTypeName: string
  Maximum Length: 255

  Name of the channel program type.
• SourceIncentiveId: string
  Maximum Length: 50

  Value that uniquely identifies the channel program for an order line. The source application assigns this value.
• StartDate: string (date)
  Date when the product rule is effective.
• Status: string
  Maximum Length: 255

  Value that indicates the status of the channel program for an order line.
• StatusCode: string
  Maximum Length: 30

  Abbreviation that indicates the status of the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENTIVE_STATUS.

{
    "type":"object",
    "properties":{
        "DeclineReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the reason to decline the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENT_DECLINE_REASON.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that indicates the status of the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENTIVE_STATUS.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the product rule is effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ItemLevel":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the item level of the product rule.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates whether the channel program for an order line is applied by the user or the application. The values for this attribute are based on the value of ManuallyAppliedFlag.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemLevelCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that indicates the item level of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "DeclinableFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the channel program for an order line can be declined by a user. If false, then the channel program for an order line can't be declined by a user. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "DeclineReason":{
            "maxLength":"255",
            "type":"string",
            "description":"Reason to decline the channel program for an order line.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramLine":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the item level at which a channel program is applied for an order line. The values for this attribute are based on the value of ItemLevelCode. If the value of ItemLevelCode is ALL_ITEMS, then the value of ItemLevel is used as the value of this attribute. If the value of ItemLevelCode is ITEM, then item number from order line is used as the value of this attribute. Otherwise, the value of item identifier from product rule is used as the value of this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "IncentiveEntityTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of the channel program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramTypeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the channel program type.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the status of the channel program for an order line.",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the discount type of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":"2000",
            "type":"string",
            "description":"Comments for channel program for an order line.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the channel program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the product rule is no longer effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "type":"integer",
            "description":"Amount of discount for the product rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"255"
            },
            "x-queryable":true
        },
        "ProgramCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramLineId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the product rule.",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the discount type of the product rule.",
            "nullable":true,
            "x-queryable":true
        },
        "IncentiveId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program for an order line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramDetails":{
            "maxLength":"255",
            "type":"string",
            "description":"Details of the product rule. The value of this attribute is a concatenation of DiscountType and DiscountAmount from the product rule.",
            "nullable":true,
            "x-queryable":true
        },
        "ManuallyAppliedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the channel program for an order line is selected by the user. If false, then the channel program for an order line is applied by the application. The default value is false. A list of accepted values is defined in the lookup type ORA_FOM_USER_APPLIED_INCENTIVE.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceIncentiveId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the channel program for an order line. The source application assigns this value.",
            "nullable":false,
            "x-queryable":true
        },
        "IncentiveEntitySubtypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the sub type of the channel program.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to get one channel 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/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID/child/channelPrograms/IncentiveId"

For example, the following command gets one channel program:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100187336610/child/lines/00020000000EACED00057708000110F085102FBB0000000EACED00057708000110F085102FC7/child/channelPrograms/300100187336649"

Example Response Body

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

{
	"IncentiveEntityTypeCode" : "ORA_CHANNEL_PROGRAM",
	"IncentiveEntitySubtypeCode" : "SUPPLIER_SHIP_AND_DEBIT",
	"IncentiveId" : 300100187336649,
	"SourceIncentiveId" : "300100187336649",
	"ProgramCode" : "CKM PRG 12 NOV 1",
	"ProgramId" : "300100186373506",
	"ProgramName" : "CKM PRG 12 NOV 1",
	"ProgramDetails" : "Amount 12",
	"ProgramTypeName" : "Discretionary BMI",
	"ProgramLine" : "AS72111",
	"ProgramLineId" : "300100186373507",
	"ProgramDescription" : null,
	"ApplyType" : "System Applied",
	"ManuallyAppliedFlag" : false,
	"ItemLevelCode" : "ITEM",
	"ItemLevel" : "Item",
	"StatusCode" : "ORA_APPLIED",
	"Status" : "Applied",
	"DiscountTypeCode" : "DISCOUNT_AMOUNT",
	"DiscountType" : "Amount",
	"DeclinableFlag" : true,
	"DeclineReasonCode" : null,
	"DeclineReason" : null,
	"DiscountAmount" : 12,
	"StartDate" : "2019-11-13",
	"EndDate" : "2020-03-27",
	"Comments" : null,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100187336610/child/lines/00020000000EACED00057708000110F085102FBB0000000EACED00057708000110F085102FC7/child/channelPrograms/300100187336649",
		"name" : "channelPrograms",
		"kind" : "item",
		"properties" : {
			"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
		}
	}, {
		"rel" : "canonical",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100187336610/child/lines/00020000000EACED00057708000110F085102FBB0000000EACED00057708000110F085102FC7/child/channelPrograms/300100187336649",
		"name" : "channelPrograms",
		"kind" : "item"
	}, {
		"rel" : "parent",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3A300100187336610/child/lines/00020000000EACED00057708000110F085102FBB0000000EACED00057708000110F085102FC7",
		"name" : "lines",
		"kind" : "item"
	} ]
}

Back to Top