Cross-sell
Use the CrossSell object to recommend additional products to customers via the 2Checkout API.
Cross-selling allows you to recommend additional products to customers and increase the average order value. The 2Checkout Public API supports classic cross-sell campaigns which means you can recommend more products from your own product catalog to your shoppers.
Request parameters
MasterProducts
Array
Array of product codes for the items you set to trigger the cross-sell campaign.
DisplayType
String
cart (Shopping cart),
review (Review page),
finish (Thank you page)
DisplayInEmail
Boolean
True or false depending on whether you set the cross-sell campaign to display in payment receipt emails or not.
Products
Array of objects
Details below
Products.ProductCode
String
Product code for the item you set as recommended for the cross-sell campaign.
Products.Discount
String
Value of the discount. This is a percentage.
Products.DiscountType
String
PERCENT – you can only set discounts as a percentage from the product price.
Products.Type
String
Example: Own
Products.AutoAdded
Boolean
Products.DiscountedPrice
Array of objects
Details below.
Products.DiscountedPrice.Currency
String
Products.DiscountedPrice.Price
Float
Products.BasePrice
Array of objects
Products.BasePrice.Currency
String
Products.BasePrice.Price
Float
CampaignCode
String
Unique, system-generated cross-sell campaign code.
Name
String
Campaign name.
StartDate
String
YYYY-MM-DD. The start date you set for the cross-sell campaign.
EndDate
String
YYYY-MM-DD. The end date you set for the cross-sell campaign.
CampaignStatus
String
The status of the cross-sell campaign.
CampaignOwnerType
String
Campaign owner type: Can be either MERCH or AFF.
Last updated
Was this helpful?