|
Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >
PromotionWebService
NOTE: This version of PromotionWebService is available only for implementations of Siebel CRM from version 8.1 and later. To use PromotionWebService with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference.
Use this Web service to get product promotion information, apply product promotion, get promotion commitment information and to upgrade a promotion. PromotionWebService Operations
For a list of operations associated with this Web service, see Table 879.
Table 879. PromotionWebService Operations
|
|
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 Table 880.
Table 880. Request Message Description: GetProductPromotionDefinition
|
|
|
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 Table 881.
Table 881. Response Message Description: GetProductPromotionDefinition
|
|
|
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 Table 882.
Table 882. Request Message Description: ApplyProductPromotion
|
|
|
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. |
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 Table 883.
Table 883. Response Message Description: ApplyProductPromotion
|
|
|
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 Table 884.
Table 884. Request Message Description: getPromotionCommitments
|
|
|
Asset Integration Id |
Required. Asset Integration ID of the Promotion Instance Asset. |
String |
Response Message Description: getPromotionCommitments
For a description of this response message, see Table 885.
Table 885. Response Message Description: getPromotionCommitments
|
|
|
PromotionCommitments |
An instance of the integration object ISS Promotion Commitments. |
Integration Object |
Request Message Description: UpgradePromotionToQuote
For a description of this request message, see Table 886.
Table 886. Request Message Description: UpgradePromotionToQuote
|
|
|
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 |
Response Message Description: UpgradePromotionToQuote
For a description of this response message, see Table 887.
Table 887. Response Message Description: UpgradePromotionToQuote
|
|
|
QuoteIO |
An instance of the integration object PDS Quote. |
Integration Object |
Request Message Description: UpgradePromotionToOrder
For a description of this request message, see Table 888.
Table 888. Request Message Description: UpgradePromotionToOrder
|
|
|
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 |
Response Message Description: UpgradePromotionToOrder
For a description of this response message, see Table 889.
Table 889. Response Message Description: UpgradePromotionToOrder
|
|
|
OrderIO |
An instance of the integration object PDS Order. |
Integration Object |
PromotionWebService Application Interface
This topic describes the application objects called by this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network. Service Object (Business Service or Workflow)
For a description of the service objects for this Web service, see Table 890.
Table 890. PromotionWebService Service Objects
|
|
ISS Promotion WS - GetPromotionCommitments |
Workflow |
ISS Promotion WS-Upgrade Promotion-Quote |
Workflow |
ISS Promotion WS-Upgrade Promotion-Order |
Workflow |
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 891.
Table 891. PromotionWebService Data Objects
|
|
ISS Promotion Commitments |
ISS Promotion Commitments |
PDS Quote |
PDS Quote |
PDS Order |
PDS Order |
Example Package for PromotionWebService
To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. Interface Description (WSDL) for PromotionWebService
To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. ...\PromotionWebService\PromotionWebService.wsdl
|
