Update upsell campaign

Use the updateUpSellCampaign method to update an upsell campaign via JSON-RPC API 6.0.

Request parameters

Parameter Name	Type / Description
sessionId	Required (string) Unique 2Checkout session ID code.
Code	Required (string) The code of the upsell campaign in UUID format.
UpsellCampaign	Required (object) New upsell campaign definition.
Name	Required (string) Name of campaign, max 500 characters.
StartDate	Optional (string) The date when the up-sell campaign starts, in the YYYY-MM-DD format. Can be NULL (starts immediately after enabling).
EndDate	Optional (string) The date when the up-sell campaign ends, in the YYYY-MM-DD format. Can be NULL (ends immediately after disabling).
DisplayForManualRenewals	Required (boolean/integer) Flag to control if the campaign will be displayed for manual subscription renewal orders. Can be set as true/false/0/1.
Discount	Required (object) Discount definition object, details below:
Discount.Type	Required (string) Type of discount. Can be FIXED or PERCENT.
Discount.Value	Required (integer) Percentage discount value (PERCENT discount only).
Discount.Values	Required (array of objects) List of currency discounts (FIXED discount only), details below:
Discount.Values.Currency	Required (string) Code of Currency for the related amount.
Discount.Values.Amount	Required (integer) Discount amount value for the related currency.
Discount.DefaultCurrency	Required (string) Code of default Currency (FIXED discount only).
PrimaryProduct	Required (object) Main (primary) product object, details below:
PrimaryProduct.Code	Required (string) The code of the product that the recommendation is made for.
PrimaryProduct.Quantity	Required (integer) The quantity for the primary product. Can be 0 (standing for any quantity).
PrimaryProduct.PriceOptions	Optional (array of objects) Price options list for the primary product, details below:
PrimaryProduct.PriceOptions.Code	Required (string) Price option group code.
PrimaryProduct.PriceOptions.Options	Optional (array of objects) Price options list, details below:
PrimaryProduct.PriceOptions.Options.Code	Required (string) Price option code.
PrimaryProduct.PriceOptions.Options.Value	Optional (integer) Price option value (for scale interval price option group only).
RecommendedProduct	Required (object) Recommended product object, details below:
RecommendedProduct.Code	Required (string) The code of the recommended product.
RecommendedProduct.Quantity	Required (integer) The quantity for the recommended product. Can be 0 (standing for “match quantity” setting).
RecommendedProduct.PriceOptions	Optional (array of objects) Price options list for the recommended product, details below:
RecommendedProduct.PriceOptions.Code	Required (string) Price option group code.
RecommendedProduct.PriceOptions.Options	Optional (array of objects) Price options list, details below:
RecommendedProduct.PriceOptions.Options.Code	Required (string) Price option code.
RecommendedProduct.PriceOptions.Options.Value	Optional (integer) Price option value (for scale interval price options group only).
Enabled	Required (boolean/integer) Sets the campaign enabled or disabled. Can be set as true/false/0/1.
Description	Required (array of objects) List of campaign language descriptions, details below:
Description.Language	Required (string) Code of the language.
Description.Text	Required (string) The text of the description in the associated language.

Request sample

<?php
require ('PATH_TO_AUTH');

$upsell = new \stdClass();

$upsellCode = 'fc580e11-09e4-483f-b73e-cd0f460bcd9d';

$upsell->Name = 'December 2020 upsell campaign’;
$upsell->StartDate = '2020-12-21';
$upsell->EndDate = '2020-12-25';
$upsell->DisplayForManualRenewals = false;

// setup percent discount
$discountPercent = new \stdClass();
$discountPercent->Type = 'PERCENT';
$discountPercent->Value = 5;

// setup fixed discount
$discountFixed = new \stdClass();
$discountFixed->Type = 'FIXED';
$discountValues = [
    'USD' => 10,
    'EUR' => 8,
    'TRY' => 80,
    'RUB' => 1100,
];
$dv = [];
foreach ($discountValues as $curr => $amt) {
    $disc = new \stdClass();
    $disc->Currency = $curr;
    $disc->Amount = $amt;

    $dv[] = $disc;
}
$discountFixed->Values = $dv;

// assign discount
$upsell->Discount = $discountPercent;
# OR
# $upsell->Discount = $discountFixed;


// setup primary product
$primaryProduct = new \stdClass();
$primaryProduct->Code = $productCode;
$primaryProduct->Quantity = 1;
$ppPriceOptionGroup1 = new \stdClass();
$ppPriceOptionGroup1->Code = 'OPTGRP2';
$ppPriceOptionGroup1Option = new \stdClass();
$ppPriceOptionGroup1Option->Code = 'OptGrp2Code2';
$ppPriceOptionGroup1->Options = [$ppPriceOptionGroup1Option];

$ppPriceOptionGroup2 = new \stdClass();
$ppPriceOptionGroup2->Code = 'interval_scale_grp1';
$ppPriceOptionGroup2Option = new \stdClass();
$ppPriceOptionGroup2Option->Code = 'interval_scale_grp1-1-10';
$ppPriceOptionGroup2Option->Value = '6';
$ppPriceOptionGroup2->Options = [$ppPriceOptionGroup2Option];

$primaryProduct->PriceOptions = [$ppPriceOptionGroup1, $ppPriceOptionGroup2];
$upsell->PrimaryProduct = $primaryProduct;

// setup recommended product
$recommProduct = new \stdClass();
$recommProduct->Code = $recProductCode;
$recommProduct->Quantity = 0; // stands for “match quantity” 
$rpPriceOptionGroup1 = new \stdClass();
$rpPriceOptionGroup1->Code = 'CHECKB_LIST';
$rpPriceOptionGroup1Option1 = new \stdClass();
$rpPriceOptionGroup1Option1->Code = 'chk1';
$rpPriceOptionGroup1Option2 = new \stdClass();
$rpPriceOptionGroup1Option2->Code = 'chk3';
$rpPriceOptionGroup1->Options = [$rpPriceOptionGroup1Option1, $rpPriceOptionGroup1Option2];
$recommProduct->PriceOptions = [$rpPriceOptionGroup1];
$upsell->RecommendedProduct = $recommProduct;

$upsell->Enabled = true;

// setup languagte descriptions / texts
$enDescription = new \stdClass();
$enDescription->Language = 'EN';
$enDescription->Text = 'Buy <!--{RECOMMENDED_PRODUCT_NAME}--> for just <!--{RECOMMENDED_PRODUCT_PRICE}--> until Dec 25th';
$upsell->Description = [$enDescription];

$jsonRpcRequest = new \stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'updateUpsellCampaign';
$jsonRpcRequest->params = [$sessionID, $upsellCode, $upsell];
$jsonRpcRequest->id = $i++;

$upsellResponse = callRPC($jsonRpcRequest, $host);

Response parameters

Parameters	Type / Description
UpSell	Object Object containing information related to the upsell campaigns, including product information and discount settings.