Upsell

Use the UpSell object in order to recommend products to customers via SOAP API 6.0.

Upselling is the practice that allows you to invite your customers to purchase a higher-end product, an upgrade, or an additional item in order to make a more profitable sale. The 2Checkout Public API supports upsell campaigns through which you can recommend catalog products to your shoppers.

Request parameters

Parameter	Type / Description
Name	String Name of the upsell campaign.
StartDate	String The date when the up-sell campaign starts, in the YYYY-MM-DD format. Can be NULL (starts immediately after enabling).
EndDate	String The date when the up-sell campaign ends, in the YYYY-MM-DD format. Can be NULL (ends immediately after disabling).
DisplayForManualRenewals	Boolean / integer Flag to control if the campaign will be displayed for manual subscription renewal orders. Can be set as true/false/0/1.
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 the 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 / integer Sets the campaign enabled or disabled. Can be set as true/false/0/1.
Description	Array of objects List of campaign language descriptions, details below:
Description.Language	String The language code.
Description.Text	String The text of the description in the associated language.
UpsellingDisplayType	String Set upsell settings display type. Can be overlay, interstitial.