Retrieve all campaigns
Overview
Use the searchCrossSellCampaigns method to extract information about the cross-sell campaigns you configured.
Parameters
|
Parameters |
Type |
Required |
Description |
|---|---|---|---|
|
CampaignName |
String |
Optional |
The name of the campaign. |
|
Status |
String |
Optional |
The status of the campaign; can be ACTIVE/INACTIVE. |
|
Products |
Array of strings |
Optional |
Array of product codes to apply to this campaign. |
|
RecommendedProducts |
Array of strings |
Optional |
Array of product codes recommended to the shopper. |
|
StartDate |
String |
Optional |
The date when the cross-sell campaign starts, formatted as YYYY-MM-DD |
|
EndDate |
String |
Optional |
The date when the cross-sell campaign ends, formatted as YYYY-MM-DD |
| Type | String | Optional | Can be MERCH/AFF. |
|
Pagination |
Object |
Optional |
|
|
Page |
Int |
Optional |
The page number of the results. |
|
Limit |
Int |
Optional |
The number of results per page. |
Response
| Parameters | Type/Description |
|---|---|
| Items | An array of CrossSellCampaign Objects |
| Pagination | Pagination Object with the following parameters: Page, Limit, Count |
Request
<?php
require ('PATH_TO_AUTH');
try {
$AllCrossSellCampaigns = $client->searchCrossSellCampaigns($sessionID);
}
catch (SoapFault $e) {
echo "AllCrossSellCampaigns: " . $e->getMessage();
exit;
}
var_dump("AllCrossSellCampaigns", $AllCrossSellCampaigns);
