Assign order/product additional fields
Overview
Use the assignAdditionalField method to update additional fields 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. |
FieldCode |
Required (string) |
|
Field identifier. Alpha-numeric chars, underscores and dashes. |
Required |
Boolean |
|
True or False depending on whether you want make the field mandatory or not. |
ProductCode |
Required (string) |
|
The unique product code that you control not the system-generated product identifier. |
Response
bool(true)
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; } $ProductCode = 'AAA4643116'; $FieldCode = 'NewsletterPolicy123457106'; $Required = true; try { $AssignedAdditionalField = $client->assignAdditionalField($sessionID, $FieldCode, $Required, $ProductCode); } catch (SoapFault $e) { echo "AssignedAdditionalField: " . $e->getMessage(); exit; } var_dump("AssignedAdditionalField", $AssignedAdditionalField); ?>