header

Shipment Add Comment

Edit this page on GitHub

Module: Mage_Sales

Resource: sales_order_shipment

Aliases:

Method:

Allows you to add a new comment to the order shipment.

Aliases:

Arguments:

Type Name Description
string sessionId
Session ID
string
shipmentIncrementId
Shipment increment ID
string
comment
Shipment comment (optional)
string
email
Send email flag (optional)
string
includeInEmail
Include comment in email flag (optional)

Returns:

Type Description
boolean\int True (1) if the comment is added to the order shipment

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, 'sales_order_shipment.addComment', array('shipmentIncrementId' => '200000002', 'comment' => 'comment for the shipment', 'email' => null));
var_dump($result);

// If you don't need the session anymore
//$client->endSession($session);
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->salesOrderShipmentAddComment($sessionId, '200000002');
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->salesOrderShipmentAddComment((object)array('sessionId' => $sessionId->result, 'shipmentIncrementId' => '200000002', 'comment' => 'comment for the shipment', 'email' => null, 'includeInEmail' => null));   
var_dump($result->result);