Retrieve all campaigns
Use the searchCrossSellCampaigns method to extract information about the cross-sell campaigns you configured.
Request parameters
CampaignName
Optional (string) The name of the campaign.
Status
Optional (string) The status of the campaign; can be ACTIVE/INACTIVE.
Products
Optional (array of strings) Array of product codes to apply to this campaign.
RecommendedProducts
Optional (array of strings) Array of product codes recommended to the shopper.
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
Type
Optional (string) Can be MERCH/AFF.
Pagination
Optional (object)
Pagination.Page
Optional (int) The page number of the results.
Pagination.Limit
Optional (int) The number of results per page.
Request sample
<?php
require ('PATH_TO_AUTH');
try {
$AllCrossSellCampaigns = $client->searchCrossSellCampaigns($sessionID);
}
catch (SoapFault $e) {
echo "AllCrossSellCampaigns: " . $e->getMessage();
exit;
}
var_dump("AllCrossSellCampaigns", $AllCrossSellCampaigns);Response parameters
Items
An array of CrossSellCampaign objects
Pagination
Pagination
Object with the following parameters: Page, Limit, Count
Last updated
Was this helpful?