Cross-sell
Overview
Use the CrossSellCampaign object to retrieve information about the cross-sell campaigns you configured for your account.
Parameters
CrossSellCampaign |
Object |
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 |
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. |
Products |
Object |
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. |