Module: GiftCard API
Resource: cart_giftcard
Method:
- cart_giftcard.remove (SOAP V1)
- shoppingCartGiftcardRemove (SOAP V2)
Allows you to remove a gift card from the shopping cart (quote).
Arguments:
| Type | Name | Description |
|---|---|---|
| string | sessionId | Session ID |
| string | giftcardAccountCode | Gift card account code |
| string |
quoteId | Shopping cart ID (quote ID) |
| string |
storeId | Store ID (optional) |
Return:
| Type | Description |
|---|---|
| boolean | True if the gift card is removed from the shopping cart |
Faults:
| 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 |
Examples
Request Example SOAP V1
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$code = "giftcardAccountCode";
$quoteId = 15;
$giftcardList = $proxy->call(
$sessionId,
"cart_giftcard.remove",
array(
$code,
$quoteId
)
);
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->shoppingCartGiftcardRemove($sessionId, 'giftcardAccountCode', '15');
var_dump($result);
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->shoppingCartGiftcardRemove((object)array('sessionId' => $sessionId->result, 'giftcardAccountCode' => 'giftcardAccountCode', 'quoteId' => '15', 'storeId' => '3'));
var_dump($result->result);