Upsell
The object includes information related to the upsell campaigns, including product information and discount settings.
UpSell object
The object below is returned as a successful response for the following SOAP API 6.0 methods:
Name
String Name of campaign, max 500 characters.
Code
String Unique system-generated campaign code.
StartDate
String The date when the up-sell campaign starts, in the YYYY-MM-DD format. Can be NULL.
EndDate
String The date when the up-sell campaign ends, in the YYYY-MM-DD format. Can be NULL.
DisplayForManualRenewals
Boolean Flag to control if the campaign will be displayed for manual subscription renewal orders. Can be set as true/false.
Discount
Object Discount definition object, details below.
Discount.Type
String Type of discount. Can be FIXED or PERCENT.
Discount.Value
Integer Percentage discount value (PERCENT discount only).
Discount.Values
Array of objects List of currency discounts (FIXED discount only), details below.
Discount.Values.Currency
String Code of currency for the related amount.
Discount.Values.Amount
Integer Discount amount value for the related currency.
Discount.DefaultCurrency
String Code of default currency (FIXED discount only).
PrimaryProduct
Object Main (primary) product object, details below.
PrimaryProduct.Code
String The code of the product that the recommendation is made for.
PrimaryProduct.Quantity
Integer The quantity for the primary product. Can be 0 (standing for any quantity).
PrimaryProduct.PriceOptions
Array of objects Price options list for the primary product, details below.
PrimaryProduct.PriceOptions.Code
String Price option group code.
PrimaryProduct.PriceOptions.Options
Array of objects Price options list, details below:
PrimaryProduct.PriceOptions.Options.Code
String Price option code.
PrimaryProduct.PriceOptions.Options.Value
Integer Price option value (for scale interval price option group only).
RecommendedProduct
Object Recommended product object, details below.
RecommendedProduct.Code
String The code of the recommended product.
RecommendedProduct.Quantity
Integer The quantity for the recommended product. Can be 0 (standing for “match quantity” setting).
RecommendedProduct.PriceOptions
Array of objects Price options list for the recommended product, details below.
RecommendedProduct.PriceOptions.Code
String Price option group code.
RecommendedProduct.PriceOptions.Options
Array of objects Price options list, details below:
RecommendedProduct.PriceOptions.Options.Code
String Price option code.
RecommendedProduct.PriceOptions.Options.Value
Integer Price option value (for scale interval price option group only).
Enabled
Boolean Sets the campaign enabled or disabled. Can be set as true/false.
Description
Array of objects List of campaign language descriptions, details below.
Description.Language
String Code of the language.
Description.Text
String The text of the description in the associated language.
Last updated
Was this helpful?