m openmage

OpenMage LTS Developer Documentation

Customer Redeem

Edit this page on GitHub

Module: GiftCard API

Resource: giftcard_customer

Method:

Allows you to redeem amount from a giftcard to the customer store credit.

Arguments:

Type Name Description
string sessionId
Session ID
string code Gift card code
string
customer_id Customer ID
string
store_id Store view ID

Return:

Type Description
boolean True if the amount is redeemed

Faults:

Fault Code Fault Message
100 Gift card does not exists.
101 Gift card is not valid.
103 Redemption functionality is disabled.
104 Unable to redeem gift card.

Examples

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

$code = "giftcardcode";
$customerId = 1;
$storeId = 1;

$giftcardInfo = $proxy->call(
    $sessionId,
    "giftcard_customer.redeem",
    array(
         $code,
         $customerId,
         $storeId
    )
);
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->giftcardCustomerRedeem($sessionId, 'giftcardcode', '1', '1');
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->giftcardCustomerRedeem((object)array('sessionId' => $sessionId->result, 'code' => 'giftcardcode', 'customerId' => '1', 'storeId' => '1'));   

var_dump($result->result);