Magento API

SOAP

About Magento API

Module: GiftCard API

Resource: giftcard_customer

Method:
  • giftcard_customer.info (SOAP V1)
  • giftcardCustomerInfo (SOAP V2)

Allows you to receive information about the gift card for a selected customer.

Arguments:

Type Name Description
string sessionId Session ID
string code Gift card code

Return:

Type Name Description
array result Array of giftcardCustomerEntity

The giftcardCustomerEntity content is as follows:

Type Name Description
double balance
Gift card balance
string expire_date
Gift card expiration date in the YYYY-MM-DD format

Faults:

Fault Code Fault Message
100 Gift card does not exists.
101 Gift card is not valid.

Examples

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

$code = "code";

$giftcardInfo = $proxy->call(
    $sessionId,
    "giftcard_customer.info",
    array(
         $code
    )
);
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->giftcardCustomerInfo($sessionId, 'code');
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->giftcardCustomerInfo((object)array('sessionId' => $sessionId->result, 'code' => 'code'));

var_dump($result->result);
Response Example SOAP V1
array
  'balance' => string '500.0000' (length=8)
  'expire_date' => string '2012-04-25' (length=10)