Search upsell campaigns

Use the searchUpsellCampaigns method via JSON-RPC API 6.0 to find and filter specific upsell campaigns.

Request parameters

Parameter Name	Type / Description
SessionId	Required (string) Unique 2Checkout session ID code.
Name	Optional (string) Title of the campaign.
PrimaryProductCodes	Optional (array of strings) Array of product codes used as primary products you want to filter by.
PrimaryProductCode	Optional (string) Unique product code.
RecommendedProductCodes	Optional (array of strings) Array of product codes used as recommended products you want to filter by.
RecommendedProductCode	Optional (string) Unique product code.
Statuses	Optional (array of strings) Array of statuses you want to filter by.
Status	Optional (string) Status of the upsell campaign. Enum can be one of: Enabled, Disabled, Expired
StartsAfter	Optional (string) Date in ‘Y-m-d’ format after which campaigns start.
StartsBefore	Optional (string) Date in ‘Y-m-d’ before campaigns start.
EndsAfter	Optional (string) Date in ‘Y-m-d’ after which campaigns are ending.
EndsBefore	Optional (string) Date in ‘Y-m-d’ before campaigns end.
EnabledForRenewals	Optional (boolean) Filter campaigns enabled for renewal.
CampaignCodes	Optional (array of strings) Array of campaign codes to filter by.
CampaignCode	Optional (string) Unique code for an upsell campaign.
Page	Optional (integer) Page you want to retrieve.
Limit	Optional (integer) Maximum number of campaigns per page.

Request sample

<?php
 
require ('PATH_TO_AUTH');
 
$filters = new \stdClass();
$filters->Name = 'op_2';
$filters->PrimaryProductCodes = ['A59VUKFMA2', 'JN2GSQ184L'];
$filters->RecommendedProductCodes = ['XI2MNQ41MNH'];
$filters->Statuses = ['DISABLED', 'EXPIRED'];
$filters->StartsBefore = '2020-10-01';
$filters->StartsAfter = '2019-11-05';
$filters->EndsBefore = '2022-11-10';
$filters->EndsAfter = '2020-10-02';
//$filters->EnabledForRenewals = true;
//$filters->CampaignCodes = ['8050a1b7-338e-45bd-9936-17f98b01349e'];
$filters->Page = 1;
$filters->Limit = 10;
 
$jsonRpcRequest = new stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'searchUpsellCampaigns';
$jsonRpcRequest->params = array($sessionID, $filters);
$jsonRpcRequest->id = $i++;
 
try {
    $result = callRPC($jsonRpcRequest, $host);
    echo "Campaigns: </br>",
    var_dump($result);
}
catch (SoapFault $e) {
    echo "Could not fetch upsell campaigns: " . $e->getMessage();
    exit;
}

Response parameters

Parameter	Type / Description
Page	Required (integer) The Search page you are on.
Limit	Required (integer) Maximum number of campaigns per page.
Upsells	Required (array of strings) Array of Upsell Campaigns.
Upsells.UpsellCampaign	Required (object)
UpsellsCount	Required (integer) Total number of Upsells that fit your search criteria.
PagesCount	Required (integer) Total number of pages with Upsells that fit your criteria.