header

Order Hold

Edit this page on GitHub

Module: Mage_Sales

Resource: sales_order

Aliases:

Method:

Allows you to place the required order on hold.

Aliases:

Arguments:

Type Name Description
string sessionId
Session ID
string orderIncrementId
Order increment ID

Returns:

Type Description
boolean\int True (1) if the order is placed on hold

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.hold', '200000006');
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->salesOrderHold($sessionId, '200000006');
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->salesOrderHold((object)array('sessionId' => $sessionId->result, 'orderIncrementId' => '200000006'));   
var_dump($result->result);