Cross-sell
Overview
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.
CrossSell Object
Use the CrossSell object to recommend additional products to customers via the 2Checkout API.
Parameters
| Parameter | Type/Description | |
|---|---|---|
|
MasterProducts |
Array |
|
|
|
Array of product codes for the items you set to trigger the cross-sell campaign. |
|
|
DisplayType |
String |
|
|
|
|
|
|
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 |
|
|
|
ProductCode |
String |
|
|
|
Product code for the item you set as recommended for the cross-sell campaign. |
|
|
Discount |
String |
|
|
|
Value of the discount. This is a percentage. |
|
|
DiscountType |
String |
| PERCENT – you can only set discounts as a percentage from the product price. | ||
| Type | String | |
|
|
|
Example: Own |
| AutoAdded | Boolean | |
| DiscountedPrice | Array of objects | |
| Details below. | ||
| Currency | String | |
| Price | Float | |
| BasePrice | Array of objects | |
| Currency | String | |
| 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. | ||
