Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Module: Mage_Sales

Resource: sales_order

Aliases:

  • order
Method:
  • sales_order.unhold (SOAP V1)
  • salesOrderUnhold (SOAP V2)

Allows you to unhold the required order.

Aliases:

  • order.unhold

Arguments:

TypeNameDescription
stringsessionIdSession ID
stringorderIncrementIdOrder increment ID

Returns:

TypeDescription
boolean\intTrue (1) if the order is unheld

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.unhold', '200000006');
var_dump($result);
Request Example SOAP V2
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 
$sessionId = $proxy->login('apiUser', 'apiKey'); 

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