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
Parameters | Type | Description |
---|---|---|
MasterProducts |
Array of strings |
Array of product codes to apply to this campaign. |
DisplayType |
String |
The display type of the campaign; Can be cart, review, finish. |
DisplayInEmail |
Boolean |
Determines if the campaign will be displayed in payment receipt emails. Can be 'True' or 'False'. |
Products |
Array of objects |
Array of objects containing the product codes pointing to the promoted products when tied to each master product, the discount value, and the discount type (can only be percent). |
ProductCode |
String |
Product code of the product to be recommended to the shopper. |
Discount |
Float |
Value of the discount. |
DiscountType |
String |
Can only be 'PERCENT'. |
Name |
String |
Name of the campaign. |
StartDate |
String |
The date when the cross-sell campaign starts, formatted as YYYY-MM-DD. |
EndDate |
String |
The date when the cross-sell campaign ends formatted as YYYY-MM-DD. |