SWIPromotionIntegration Operations
For a list of operations associated with this Web service, see the following table.
| Name | Description |
|---|---|
SWIPromotionUpsert |
Creates a new promotion or updates an existing promotion. |
Request Message Description: SWIPromotionUpsert
For a description of this request message, see the following table.
| Node | Description | Type |
|---|---|---|
SyncChild |
Upsert operation behaves as Synchronize if SyncChild flag is set to Y. Note: The default value of this flag
is N. |
Boolean |
SWIPromotionIntegrationIO |
Required. An instance of the integration object SWIPromotionIntegration. |
Integration Object |
WorkspaceName |
Workspace name. |
String |
WorkspaceReuseFlag |
Flag which indicates whether a workspace is reused. |
Boolean |
ListOfSwiPromotionVbc |
Container element for Promotion details which is an instance of the VBC SwiPromotion. |
Integration Component |
ActiveFlag |
Flag which indicates whether a record is active. |
Boolean |
Name |
Promotion name. |
String |
Organization |
Organization name. |
String |
Type |
Promotion type. |
String |
TrackAsAgreement |
Flag which indicates whether a record is tracked as an agreement. |
Boolean |
TrackAsAsset |
Flag which indicates whether a record is tracked as an asset. |
Boolean |
ShowInCatalog |
Flag which indicates whether a record is shown in a catalog. |
Boolean |
ReleaseFlag |
Flag which indicates whether a record is to be released. |
Boolean |
ListOfSwiPromotionProductComponentsVbc |
Container element for Promotion Product Component details which is an instance of the VBC SwiPromotionProductComponents. |
Integration Component |
Default |
Default value for product components. |
Integer |
Max |
Maximum number of product components. |
Integer |
Min |
Minimum number of product components. |
Integer |
ProductName |
Product name. |
String |
Commitment |
Flag which indicates whether a commitment has been made. |
Boolean |
DisconnectAction |
The disconnect action, such as Prompt. |
String |
ApplyComponentChargeFlag |
Flag which indicates whether a component charge is to be applied. |
Boolean |
GracePeriod |
Grace period number. |
Integer |
GracePeriodUOM |
Grace period unit of measure, such as days or weeks. |
String |
CommitmentPeriod |
Period of commitment. |
Integer |
CommitmentPeriodUOM |
Grace period unit of measure, such as days, month or years. |
Integer |
ProratePlanName |
Name of the prorate plan. |
String |
TerminationCharge |
Termination charge. |
String |
ListOfSwiPromotionPricingComponentsVbc |
Container element for Promotion Pricing Component details which is an instance of the VBC SWIPromotionPricingComponents. |
Integration Component |
AdjustmentType |
Adjustment type. |
String |
Value |
Adjustment type value. |
Integer |
CurrencyCode |
Currency code. |
String |
EndDate |
Adjustment end date. |
Date |
ExchangeDate |
Exchange date. |
Date |
ProductName |
Product name. |
String |
ListOfSwiPromotionAggregateProductClassVbc |
Container element for Promotion Aggregate Product Class details which is an instance of the VBC SwiPromotionAggregateProductClass. |
Integration Component |
ClassId |
The class ID value. |
String |
ClassName |
The class name. |
String |
Default |
The default value. |
Integer |
Description |
Description. |
String. |
DisconnectAction |
Disconnect action. |
String |
Recommendable |
Flag which indicates whether a product class can be recommended by users. |
Boolean |
Max |
Maximum number. |
Integer |
Min |
Minimum number. |
Integer |
Commitment |
Flag which indicates whether there is a commitment. |
Boolean |
ListOfSwiPromotionAggregateProductClass DefaultProductsVbc |
Container element for Promotion Aggregate Product Class Default Product details which is an instance of the VBC SwiPromotionAggregateProductClassDefaultProducts. |
Integration Component |
DefaultCardinality |
The default cardinality. |
Integer |
ProductId |
The product ID. |
String |
ProductName |
The product name. |
String |
ListOfSwiPromotionAggregateProductLineVbc |
Container element for Promotion Aggregate Product Line details which is an instance of the VBC SwiPromotionAggregateProductLine. |
Integration Component |
Default |
Default value. |
Integer |
Description |
Aggregate product line description. |
String |
Max |
Maximum number. |
Integer |
Min |
Minimum number. |
Integer |
ProductLine |
The product line. |
String |
DisconnectAction |
Disconnect action. |
String |
ProductLineId |
Product line ID. |
String |
Commitment |
Flag which indicates whether there is a commitment. |
Boolean |
ListOfSwiPromotionAggregateProductLine DefaultProductsVbc |
Container element for Promotion Aggregate Product Line Default Products details which is an instance of the VBC SwiPromotionAggregateProductLineDefault Products. |
Integration Component |
DefaultCardinality |
Default cardinality. |
Integer |
ProductId |
Product ID. |
String |
ProductName |
Product name. |
String |
SwiPromotionAggregateProductClass DefaultProductsVbc |
Container element for Promotion Aggregate Product Class Default Product details which is an instance of the VBC SwiPromotionAggregateProductClassDefaultProducts. |
Integration Component |
DefaultCardinality |
Default cardinality |
Integer |
ProductId |
Product ID. |
String |
ProductName |
Product name. |
String |
ListOfSwiPromotionAggregateProductLine MessagesVbc |
Container element for Promotion Aggregate Product Line Message details which is an instance of the VBC SWI Promotion. |
Integration Component |
Description |
Description. |
String |
LanguageCode |
Language code. |
String |
ListOfSwiPromotionUpgradeAggregate ProductLineVbc |
Container element for Promotion Upgrade Aggregate Product Line details which is an instance of the VBC SwiPromotionUpgradeAggregateProduct Line. |
Integration Component |
DisplayCommitment |
Flag which indicates whether to display the commitment. |
Boolean |
DisplayProratedCharge |
Flag which indicates whether to display the prorated charge. |
Boolean |
Penalty |
Penalty. |
String |
ProductLine |
Product line. |
String |
ProratePlanName |
Prorate Plan Name. |
String |
Reason |
Commitment reason. |
String |
ListofSwiPromotionUpgradeAggregate ProductClassVbc |
Container element for Promotion Upgrade Aggregate Product Class details which is an instance of the VBC SwiPromotionUpgradeAggregateProduct Class. |
Integration Component |
DisplayCommitment |
Flag which indicates whether to display the commitment. |
Boolean |
DisplayProratedCharge |
Flag which indicates whether to display the prorated charge. |
Boolean |
Penalty |
Penalty. |
String |
ProductClassName |
Product class name. |
String |
ProratePlanName |
Prorate plan name. |
String |
Reason |
Reason. |
String |
ListofSwiPromotionUpgradeToAggregate ProductLineVbc |
Container element for Promotion Upgrade To Aggregate Product Line details which is an instance of the VBC SwiPromotionUpgradeToAggregateProduct Line. |
Integration Component |
DisplayCommitment |
Flag which indicates whether to display the commitment. |
Boolean |
DisplayProratedCharge |
Flag which indicates whether to display the prorated charge. |
Boolean |
Penalty |
Penalty. |
String |
ProductLine |
Product class name. |
String |
ProratePlanName |
Prorate plan name. |
String |
Reason |
Reason. |
String |
ListOfSwiPromotionUpgradeToAggregate ProductClassVbc |
Container element for Promotion Upgrade To Aggregate Product Class details which is an instance of the VBC SwiPromotionUpgradeToAggregateProduct Class. |
Integration Component |
DisplayCommitment |
Flag which indicates whether to display the commitment. |
Boolean |
DisplayProratedCharge |
Flag which indicates whether to display the prorated charge. |
Boolean |
Penalty |
Penalty. |
String |
ProductClassName |
Product class name. |
String |
ProratePlanName |
Prorate plan name. |
String |
Reason |
Reason. |
String |
ListOfSwiPromotionCharges_CreditsVbc |
Container element for the Promotion Charge and Credit details which is an instance of the VBC SwiPromotionCharges_Credits. |
Integration Component |
Amount |
Credit amount. |
Integer |
Type |
Credit type. |
String |
ListOfSwiPromotionProductOverrideVbc |
Container element for Promotion Product Override details which is an instance of the VBC SwiPromotionProductOverride. |
Integration Component |
ComponentPath |
Component path. |
String |
PromotionName |
Promotion name. |
String |
ApplyComponentChargeFlag |
Flag which indicates whether to apply a component charge. |
Boolean |
GracePeriod |
Grace period value. |
Integer |
GracePeriodUOM |
Grace period unit of measure, such as days, weeks and so on. |
String |
CommitmentPeriod |
Commitment period value. |
Integer |
CommitmentPeriodUOM |
Commitment period unit of measure, such as weeks, years and so on. |
String |
ProratePlanName |
Prorate plan name. |
String |
TerminationCharge |
Termination charge. |
Integer |
DefaultCardinality |
Default cardinality. |
Integer |
MaxCardinality |
Optional. Maximum cardinality. |
Integer |
MinCardinality |
Optional Minimum cardinality. |
Integer |
ListofSwiPromotionPricingOverride Vbc |
Container element for Promotion Pricing Override details which is an instance of the VBC SwiPromotionPricingOverride. |
Integration Component |
AdjustmentType |
Adjustment type. |
String |
AdjustmentValue |
Adjustment value. |
Integer |
ComponentPath |
Component path. |
String |
EndDate |
End date. |
Date |
MaximumPrice |
Maximum price. |
Integer |
MinimumPrice |
Minimum price. |
Integer |
PromotionName |
Promotion name. |
String |
StartDate |
Start date. |
Date |
Response Message Description: SWIPromotionUpsert
For a description of this response message, see the following table.
| Node | Description | Type |
|---|---|---|
SWIPromotionIntegrationIO |
Required. An instance of the integration object SWIPromotionIntegration. |
Integration Object |
Id |
Promotion ID. |
String |
OverrideLockedFlag |
Flag which indicates whether to override a locked record. |
Boolean |
ReleaseDate |
Release date. |
String |
WorkspaceId |
Workspace ID. |
String |
WorkspaceName |
Workspace name. |
String |
WorkspaceReleaseFlag |
Workspace release flag. |
Boolean |
WorkspaceReuseFlag |
Workspace reuse flag. |
Boolean |
ListofSwiPromotionVbc |
Container element for Promotion which is an instance of the VBC SwiPromotion. |
Integration Component |
Id |
Promotion ID. |
String |
ActiveFlag |
Flag which indicates whether to record is active or not. |
Boolean |
Name |
Promotion name. |
String |
PrimaryOrganizationId |
Primary organization ID. |
String |
PromotionId |
Promotion ID. |
String |
Type |
Promotion type. |
String |
VendorId |
Vendor ID. |
String |
ReleaseFlag |
Flag which indicates whether the promotion will be released. |
String |
Id |
Promotion ID. |
String |
Max |
Maximum value. |
Integer |
Min |
Minimum value. |
Integer |
ProductId |
Product ID. |
String |
ListOfSwiPromotionCharges_CreditsVbc |
Container element for the Promotion Charge and Credit details which is an instance of the VBC SwiPromotionCharges_Credits. |
Integration Component |
Id |
Promotion ID. |
String |
ChargeAmountCurrencyCode |
Currency code for charge amount. |
Integer |
Period |
Promotion period. |
Date |
Plan |
Plan. |
String |
Type |
Promotion type. |
String |
ListOfSwiPromotionPricingComponentsVbc |
Container element for Promotion Pricing Component details which is an instance of the VBC SWIPromotionPricingComponents. |
Integration Component |
Id |
Promotion ID. |
String |
AdjustmentType |
Adjustment type. |
String |
Value |
Value of promotion. |
String |
ProductId |
Product ID. |
String |
ProductName |
Product name. |
String |
ListOfSwiPromotionAggregate ProductLineVbc |
Container element for Promotion Aggregate Product Line details which is an instance of the VBC SwiPromotionAggregateProductLine. |
Integration Component |
Default |
Default value. |
Integer |
Description |
Promotion description. |
String |
DisconnectAction |
Disconnect action. |
String |
Id |
Promotion ID. |
String |
Recommendable |
Flag which indicates whether a product class can be recommended by users. |
Boolean |
Max |
Maximum number. |
Integer |
Min |
Minimum number. |
Integer |
ProductLine |
The product line. |
String |
ProductLineId |
Product line ID. |
String |
Commitment |
Flag which indicates whether there is a commitment. |
Boolean |
ListOfSwiPromotionAggregateProductLine DefaultProductsVbc |
Container element for Promotion Aggregate Product Line Default Products details which is an instance of the VBC SwiPromotionAggregateProductLineDefault Products. |
Integration Component |
DefaultCardinality |
Default cardinality. |
Integer |
Id |
Promotion ID. |
String |
ProductId |
Product ID. |
String |
ProductName |
Product name. |
String |
SwiPromotionAggregateProductLine DefaultProductsVbc |
Container element for Promotion Aggregate Product Line Default Products details which is an instance of the VBC SwiPromotionAggregateProductLineDefault Products. |
Integration Component |
DefaultCardinality |
Default cardinality |
Integer |
Id |
Promotion ID. |
String |
ProductId |
Product ID. |
String |
ProductName |
Product name. |
String |
ListOfSwiPromotionAggregateProductLine MessagesVbc |
Container element for Promotion Aggregate Product Line Message details which is an instance of the VBC SWI Promotion. |
Integration Component |
Description |
Description. |
String |
Id |
Promotion ID. |
String |
LanguageCode |
Language code. |
String |
ListOfSwiPromotionAggregateProductClassVbc |
Container element for Promotion Aggregate Product Class details which is an instance of the VBC SwiPromotionAggregateProductClass. |
Integration Component |
ClassId |
The class ID value. |
String |
ClassName |
The class name. |
String |
Default |
The default value. |
Integer |
Description |
Description. |
String |
DisconnectAction |
Disconnect action. |
String |
Id |
Promotion ID. |
String |
Recommendable |
Flag which indicates whether a product class can be recommended by users. |
Boolean |
Max |
Maximum number. |
Integer |
Min |
Minimum number. |
Integer |
Commitment |
Flag which indicates whether there is a commitment. |
Boolean |
ListOfSwiPromotionAggregateProductClass DefaultProductsVbc |
Container element for Promotion Aggregate Product Class Default Product details which is an instance of the VBC SwiPromotionAggregateProductClassDefaultProducts. |
Integration Component |
ClassId |
Class ID. |
String |
ClassName |
Class name. |
String |
Default |
Default value. |
String |
Description |
Class description. |
String |
DisconnectAction |
Disconnect action. |
String |
Id |
Promotion ID. |
String |
Recommendable |
Flag which indicates whether a product class can be recommended by users. |
Boolean |
Max |
Maximum number. |
Integer |
Min |
Minimum number. |
Integer |
Commitment |
Flag which indicates whether there is a commitment. |
Boolean |
ListOfSwiPromotionAggregateProductClass DefaultProductsVbc |
Container element for Promotion Aggregate Product Class Default Product details which is an instance of the VBC SwiPromotionAggregateProductClassDefaultProducts. |
Integration Component |
DefaultCardinality |
Default cardinality. |
Integer |
Id |
Promotion ID. |
String |
ProductId |
Product ID. |
String |
ProductName |
Product name. |
String |
ListOfSwiPromotionUpgradeAggregateProduct LineVbc |
Container element for Promotion Upgrade Aggregate Product Line details which is an instance of the VBC SwiPromotionUpgradeAggregateProduct Line. |
Integration Component |
Id |
Promotion ID. |
String |
CommitmentStart |
Start of the commitment. |
Date |
Duration |
Promotion duration. |
String |
ProductLineId |
Product line ID. |
String |
ListOfSwiPromotionUpgradeAggregateProduct ClassVbc |
Container element for Promotion Upgrade Aggregate Product Class details which is an instance of the VBC SwiPromotionUpgradeAggregateProduct Class. |
Integration Component |
Id |
Promotion ID. |
String |
CommitmentStart |
Start of commitment. |
Date |
Duration |
Promotion duration. |
String |
ProductClassId |
Product class ID. |
String |
ListOfSwiPromotionUpgradeToAggregateProduct LineVbc |
Container element for Promotion Upgrade To Aggregate Product Line details which is an instance of the VBC SwiPromotionUpgradeToAggregateProduct Line. |
Integration Component |
Id |
Promotion ID. |
String |
CommitmentStart |
Start of commitment. |
Date |
Duration |
Promotion duration. |
String |
ProductLineId |
Product class ID. |
String |
ListOfSwiPromotionUpgradeToAggregateProduct ClassVbc |
Container element for Promotion Upgrade To Aggregate Product Class details which is an instance of the VBC SwiPromotionUpgradeToAggregateProduct Class. |
Integration Component |
Id |
Promotion ID. |
String |
CommitmentStart |
Start of commitment. |
Date |
Duration |
Promotion duration. |
String |
ProductClassId |
Product class ID. |
String |
ListofSwiPromotionPricingOverrideVbc |
Container element for Promotion Pricing Override details which is an instance of the VBC SwiPromotionPricingOverride. |
Integration Component |
Id |
Promotion ID. |
String |
PromotionName |
Promotion name. |
String |
ListOfSwiPromotionProductOverrideVbc |
Container element for Promotion Product Override details which is an instance of the VBC SwiPromotionProductOverride. |
Integration Component |
DefaultCardinality |
Default cardinality. |
Integer |
MaxCardinality |
Optional. Maximum cardinality. |
Integer |
MinCardinality |
Optional Minimum cardinality. |
Integer |