Module: Complex Product API
Resource: product_custom_option
Method:
- product_custom_option.remove (SOAP V1)
- catalogProductCustomOptionRemove (SOAP V2)
Allows you to remove a custom option from the product.
Arguments:
| Type | Name | Description |
|---|---|---|
| string | sessionId |
Session ID |
| string | optionId | Custom option ID |
Return:
| Type | Description |
|---|---|
| boolean | True if the custom option is removed |
Faults:
| Fault Code | Fault Message |
|---|---|
| 105 | Option with requested id does not exist. |
| 107 | Error while deleting an option. Details are in the error message. |
Examples
Request Example SOAP V1
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$optionId = 1;// Existing option ID
$result = $proxy->call(
$sessionId,
"product_custom_option.remove",
array(
$optionId
)
);
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->catalogProductCustomOptionRemove($sessionId, '1');
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->catalogProductCustomOptionRemove((object)array('sessionId' => $sessionId->result, 'optionId' => '1'));
var_dump($result->result);