Retrieve information on promotions
          Last updated: 13-Sep-2019
        
        
    Rate this article:
    
    
  
        Overview
Use the searchPromotions method to extract information on promotions you set up for your account.
Parameters
| 
 sessionID  | 
 Required (string)  | 
| 
 
  | 
 Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.  | 
| 
 Types  | 
 StringArray  | 
| 
 
  | 
 Discount type: 
  | 
| 
 Channel  | 
 String  | 
| 
 
  | 
 Channel: 
  | 
| 
 ProductCode  | 
 String  | 
| 
 
  | 
 Unique code that you set for each of your products.  | 
| 
 Limit  | 
 Int  | 
| 
 
  | 
 Number of results returned by the method.  | 
| 
 Page  | 
 Int  | 
| 
 
  | 
 Results pagination.  | 
Response
| 
 Promotion  | 
 Array of objects  | 
Request
<?php
$host   = "https://api.avangate.com";
$client = new SoapClient($host . "/soap/3.0/?wsdl", array(
    'location' => $host . "/soap/3.0/",
    "stream_context" => stream_context_create(array(
        'ssl' => array(
            'verify_peer' => false,
            'verify_peer_name' => false
        )
    ))
));
function hmac($key, $data)
{
    $b = 64; // byte length for md5
    if (strlen($key) > $b) {
        $key = pack("H*", md5($key));
    }
    
    $key    = str_pad($key, $b, chr(0x00));
    $ipad   = str_pad('', $b, chr(0x36));
    $opad   = str_pad('', $b, chr(0x5c));
    $k_ipad = $key ^ $ipad;
    $k_opad = $key ^ $opad;
    return md5($k_opad . pack("H*", md5($k_ipad . $data)));
}
$merchantCode = "YOURCODE123"; //your account's merchant code available in the 'System settings' area of the cPanel: https://secure.2checkout.com/cpanel/account_settings.php
$key          = "SECRET_KEY"; //your account's secret key available in the 'System settings' area of the cPanel: https://secure.2checkout.com/cpanel/account_settings.php
$now          = gmdate('Y-m-d H:i:s'); //date_default_timezone_set('UTC')
$string = strlen($merchantCode) . $merchantCode . strlen($now) . $now;
$hash   = hmac($key, $string);
try {
    $sessionID = $client->login($merchantCode, $now, $hash);
}
catch (SoapFault $e) {
    echo "Authentication: " . $e->getMessage();
    exit;
}
$SearchOptions              = new stdClass();
$SearchOptions->Types       = array();
$SearchOptions->Types[0]    = 'REGULAR';
$SearchOptions->Types[1]    = 'RENEWAL';
$SearchOptions->Channel     = 'ECOMMERCE';
$SearchOptions->ProductCode = 'my_subscription_1';
$SearchOptions->Limit       = 10;
$SearchOptions->Page        = 1;
try {
    $Discounts = $client->searchPromotions($sessionID, $SearchOptions);
}
catch (SoapFault $e) {
    echo "Discounts: " . $e->getMessage();
    exit;
}
var_dump("Discounts", $Discounts);
?>
    Rate this article: