PromotionWebService Operations
For a list of operations associated with this Web service, see the following table.
| Name | Description |
|---|---|
getProductPromotionDefinition |
Returns promotion detail information. |
ApplyProductPromotion |
Add a promotion and all default components to a quote or order. |
getPromotionCommitments |
Get promotion commitment information for a given promotion asset. |
UpgradePromotionToQuote |
Upgrade or migrate a promotion instance to another promotion and generate a quote with the updated assets information. |
UpgradePromotionToOrder |
Upgrade or migrate a promotion instance to another promotion and generate an order with the updated assets information. |
Request Message Description: GetProductPromotionDefinition
For a description of this request message, see the following table.
| Name | Description | Type |
|---|---|---|
EligibilityMode |
Optional, default value as 2. Could be 0, 1, 2. |
Not applicable |
PricingMode |
Optional, default value as Y. Y or N. |
Not applicable |
LoadAllDomainFlag |
Required value of Y or N. |
Not applicable |
LoadDefaultDomainFlag |
Required value of Y or N. |
Not applicable |
LoadPromDefFlag |
Required value of Y or N. |
Not applicable |
ContextMode |
Required, Siebel Context or External Context. |
Not applicable |
Context |
Required, in SiebelMessage format of IO PDS Catalog Context. |
Not applicable |
ProdPromRuleType |
Optional, Product or Pricing. |
Not applicable |
Response Message Description: GetProductPromotionDefinition
For a description of this response message, see the following table.
| Name | Description | Type |
|---|---|---|
ProdPromDefinition |
In SiebelMessage format of the integration object ISS Promotion Definition for WS. |
Not applicable |
PromDomainProduct |
In SiebelMessage format of the integration object PDS Product Interface'. Could be either default domain product details or all domain product details depending on input arguments. |
Not applicable |
Err_spcCode |
Error Code if error occurred. |
Not applicable |
Err_spcMessage |
Error Message if error occurred. |
Not applicable |
Request Message Description: ApplyProductPromotion
For a description of this request message, see the following table.
| Name | Description | Type |
|---|---|---|
EligibilityMode |
Optional. The default value is 2. Could be 0, 1, 2. |
Not applicable |
PricingMode |
Optional. The default value as Y. Possible values are Y or N. |
Not applicable |
ProdPromId |
Required. |
Not applicable |
ProdPromInstanceId |
Optional, depending on usage scenarios. This parameter lets you add a promotion to an existing quote and associate products already on the quote with the promotion. For more information on using this parameter, see My Oracle Support and query for Doc ID: 1924501.1. |
Not applicable |
LineItemId |
Optional, depending on usage scenarios. |
Not applicable |
Quantity |
Optional. The default value is 1. |
Not applicable |
SiebelMessage |
Required, in SiebelMessage format of the integration object PDS Quote. |
Not applicable |
Response Message Description: ApplyProductPromotion
For a description of this response message, see the following table.
| Name | Description | Type |
|---|---|---|
SiebelMessage |
Required. In SiebelMessage format of the integration object PDS Quote. |
Not applicable |
Err_spcCode |
Error code if one occurred. |
Not applicable |
Err_spcMessage |
Error message if one occurred. |
Not applicable |
Request Message Description: getPromotionCommitments
For a description of this request message, see the following table.
| Name | Description | Type |
|---|---|---|
Asset Integration Id |
Required. Asset Integration ID of the Promotion Instance Asset. |
String |
For a description of this response message, see the following table.
| Name | Description | Type |
|---|---|---|
PromotionCommitments |
An instance of the integration object ISS Promotion Commitments. |
Integration Object |
For a description of this request message, see the following table.
| Name | Description | Type |
|---|---|---|
NewPromotionId |
Required. RowId of new promotion. |
String |
AssetNumber |
Asset number of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. |
String |
AssetIntegrationId |
Asset integration ID of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. |
String |
ActiveDocumentId |
A Document in Siebel Order Management refers to a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Quote ID of the active Quote to which the generated quote item has to be added. This is an optional input. |
String |
AccountId |
Account ID of the account that owns the selected promotion asset being upgraded. |
String |
OverridePenaltyAmount |
Penalty amount for upgrading the promotion, if any. |
String |
OverrideProratePlanId |
If there is a penalty for upgrading the promotion, also pass in the prorate plan used to prorate this penalty, if any. |
String |
For a description of this response message, see the following table.
| Name | Description | Type |
|---|---|---|
QuoteIO |
An instance of the integration object PDS Quote. |
Integration Object |
For a description of this request message, see the following table.
| Name | Description | Type |
|---|---|---|
NewPromotionId |
Required. RowId of new promotion. |
String |
AssetNumber |
Asset Number of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. |
String |
AssetIntegrationId |
Asset Integration ID of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. |
String |
ActiveDocumentId |
A Document in Siebel Order Management refers to a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Order ID of the active Order to which the generated order item has to be added. This is an optional input. |
String |
AccountId |
Account ID of the account that owns the selected promotion asset being upgraded. |
String |
OverridePenaltyAmount |
Penalty amount for upgrading the promotion, if any. |
String |
OverrideProratePlanId |
If there is a penalty for upgrading the promotion, also pass in the prorate plan used to prorate this penalty, if any. |
String |
For a description of this response message, see the following table.
| Name | Description | Type |
|---|---|---|
OrderIO |
An instance of the integration object PDS Order. |
Integration Object |