header

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.

Set For Quote

Edit this page on GitHub

Module: GiftMessage API

Resource: giftmessage

Method:

Allows you to set a global gift message for the shopping cart (quote).

Arguments:

Type Name Description
string sessionId Session ID
string quoteId Shopping cart ID (quote ID)
array giftMessage Array of giftMessageEntity
string store Store view ID or code (optional)

Return:

Type Name Description
array result giftMessageResponse

The giftMessageEntity content is as follows:

Type Name Description
string from
Gift message sender
string
to
Gift message recipient
string
message
Gift message text

The giftMessageResponse content is as follows:

Type Name Description
string entityId
Entity ID
boolean result
Result of adding a message
string error
Error

Examples

Request Example SOAP V1
$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires API authentication,
// then get a session token
$session = $client->login('apiUser', 'apiKey');

$result = $client->call($session, 'giftmessage.setForQuote', array('quoteId' => '10', 'giftMessage' => array('from' => 'John', 'to' => 'Sara', 'message' => 'Gift message text')));
var_dump ($result);
Request Example SOAP V2
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 

$sessionId = $proxy->login('apiUser', 'apiKey'); 
 
$result = $proxy->giftMessageSetForQuote($sessionId, 10, array(
'from' => 'John',
'to' => 'Sara',
'message' => 'Gift message text'
));  
 
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->giftMessageSetForQuote((object)array('sessionId' => $sessionId->result, 'quoteId' => '10', 'giftMessage' => array(
'from' => 'John',
'to' => 'Sara',
'message' => 'Gift message text'
)));  
 
var_dump($result);
Response Example SOAP V1
array
  'entityId' => string '15' (length=2)
  'result' => boolean true
  'error' => string '' (length=0)