Retrieve price option groups
Overview
Use the searchPriceOptionGroups to extract information on the price option groups you configured.
Parameters
| Parameters | Type/Description |
|---|---|
|
sessionID |
Required (string) |
|
|
Session identifier, the output of the Login method. Include sessionID into all your requests. Avangate throws an exception if the values are incorrect. The sessionID expires in 10 minutes. |
|
PriceOptionGroupSearch |
Optional (object) |
|
|
Details below. |
|
PriceOptionGroupSearch |
Object |
|
Name |
Optional (string) |
|
|
The name of the pricing options groups configured in the Avangate system. Can be NULL. |
|
Types |
Optional (array) |
|
|
Possible values: · RADIO · CHECKBOX · INTERVAL · COMBO Can be NULL. |
|
Limit |
Optional (int) |
|
|
Number of results displayed per page. Default maximum value is 10. Can be NULL. |
|
Page |
Optional (int) |
|
|
A specific page of search results. Default value is 1. Can be NULL. |
Response
|
Array of objects |
Request
<?php
$host = "https://api.avangate.com";
$client = new SoapClient($host . "/soap/4.0/?wsdl", array(
'location' => $host . "/soap/4.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.avangate.com/cpanel/account_settings.php
$key = "SECRET_KEY"; //your account's secret key available in the 'System settings' area of the cPanel: https://secure.avangate.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->Name = 'New Users from API';
$SearchOptions->Types = array(
'INTERVAL',
'RADIO',
'COMBO',
'CHECKBOX'
); //RADIO, CHECKBOX, INTERVAL, COMBO, INTERVAL
$SearchOptions->Limit = 10;
$SearchOptions->Page = 1;
try {
$existentPriceOptions = $client->searchPriceOptionGroups($sessionID, $SearchOptions);
}
catch (SoapFault $e) {
echo "existentPriceOptions: " . $e->getMessage();
exit;
}
var_dump("existentPriceOptionst", $existentPriceOptions);
?>
