Create a cross-sell campaign

Use the createCrossSellCampaign method to create a cross-sell campaign for your 2Checkout account.

Request parameters

Parameters	Type / Description
MasterProducts	Required (array of strings) Array of product codes to apply to this campaign.
DisplayType	Required (string) The display type of the campaign; Can be cart, review, finish.
DisplayInEmail	Required (boolean) Determines if the campaign will be displayed in payment receipt emails.
Products	Required (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	Required (string) Product code of the product to be recommended to the shopper.
Discount	Required (float) Value of the discount.
DiscountType	Required (string) Can only be 'PERCENT'.
Name	Required (string) Name of the campaign.
StartDate	Optional (string) The date when the cross-sell campaign starts, formatted as YYYY-MM-DD.
EndDate	Optional (string) The date when the cross-sell campaign ends, formatted as YYYY-MM-DD.

Request sample

<?php

require ('PATH_TO_AUTH');

$csCampaign = new stdClass();
$csCampaign->MasterProducts = ['C8851A5BC9'];
$csCampaign->DisplayType = 'cart';
$csCampaign->DisplayInEmail = false;
$csCampaign->Name = 'testing';
$csCampaign->StartDate = '2019-09-20';
$csCampaign->EndDate = '2020-10-21';
$csCampaign->Products = [];
$csCampaign->Products[0] = new stdClass();
$csCampaign->Products[0]->ProductCode = '512712FA53';
$csCampaign->Products[0]->Discount = 15;
$csCampaign->Products[0]->DiscountType = 'PERCENT';

$jsonRpcRequest = new stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'createCrossSellCampaign';
$jsonRpcRequest->params = array($sessionID, $csCampaign);
$jsonRpcRequest->id = $i++;

$csCampaignResponse = callRPC($jsonRpcRequest, $host, true);

Response parameters

Parameters	Type / Description
CampaignCode	Required (string) The campaign code that can be used when placing orders.
MasterProducts	Required (array of strings) Array of product codes to apply to this campaign.
DisplayType	Required (string) The display type of the campaign; Can be cart, review, finish.
DisplayInEmail	Required (boolean) Determines if the campaign will be displayed in payment receipt emails. Can be 'true' or 'false'.
Products	Required (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	Required (string) Product code of the product to be recommended to the shopper.
Discount	Required (float) Value of the discount.
DiscountType	Required (string) Can only be 'PERCENT'.
Name	Required (string) Name of the campaign.
CampaignStatus	Optional (string) The status of the cross-sell campaign.
StartDate	Optional (string) The date when the cross-sell campaign starts, formatted as YYYY-MM-DD.
EndDate	Optional (string) The date when the cross-sell campaign ends, formatted as YYYY-MM-DD.