Magento 1.x Software Support Notice

For Magento Commerce 1, Magento is providing software support through June 2020. Depending on your Magento Commerce 1 version, software support may include both quality fixes and security patches. Please review our Magento Software Lifecycle Policy to see how your version of Magento Commerce 1 is supported.

For Magento Open Source 1.5 to 1.9, Magento is providing software security patches through June 2020 to ensure those sites remain secure and compliant. Visit our information page for more details about our software maintenance policy and other considerations for your business.

Gift Card Add

Edit this page on GitHub

Module: GiftCard API

Resource: cart_giftcard


Allows you to add a gift card to the shopping cart (quote).


Type Name Description
string sessionId Session ID
string giftcardAccountCode Gift card account code
int quoteId Shopping cart ID (quote ID)
int storeId Store ID (optional)


Type Description
boolean True if the gift card is added to the quote


Fault Code Fault Message
1001 Can not make operation because store is not exists
1002 Can not make operation because quote is not exists
1004 Gift card account with requested code does not exist
1005 Error happened while adding gift card to quote


Request Example SOAP V1
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');

$code = "giftcardAccountCode";
$quoteId = 15;

$giftcardList = $proxy->call(
Request Example SOAP V2
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy->shoppingCartGiftcardAdd($sessionId, 'giftcardAccountCode', '15');
Request Example SOAP V2 (WS-I Compliance Mode)
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 

$sessionId = $proxy->login((object)array('username' => 'apiUser', 'apiKey' => 'apiKey')); 
$result = $proxy->shoppingCartGiftcardAdd((object)array('sessionId' => $sessionId->result, 'giftcardAccountCode' => 'giftcardAccountCode', 'quoteId' => '15', 'storeId' => '3'));